X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit.txt;h=61331ab12140c43c3b043aab7e6dd21294678041;hb=34925d35ff278c7377e0cf3fce0227d5eceffeb5;hp=2f9622f5ac492140427e752ebd163cb22d003d8d;hpb=235d521da60e4699e5bd59ac658b5b48bd76ddca;p=git.git diff --git a/Documentation/git.txt b/Documentation/git.txt index 2f9622f5..61331ab1 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -8,49 +8,69 @@ git - the stupid content tracker SYNOPSIS -------- -'git-' +'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--help] COMMAND [ARGS] DESCRIPTION ----------- +Git is a fast, scalable, distributed revision control system with an +unusually rich command set that provides both high-level operations +and full access to internals. + +See this link:tutorial.html[tutorial] to get started, then see +link:everyday.html[Everyday Git] for a useful minimum set of commands, and +"man git-commandname" for documentation of each command. CVS users may +also want to read link:cvs-migration.html[CVS migration]. + +OPTIONS +------- +--version:: + Prints the git suite version that the 'git' program came from. + +--help:: + Prints the synopsis and a list of the most commonly used + commands. If a git command is named this option will bring up + the man-page for that command. If the option '--all' or '-a' is + given then all available commands are printed. + +--exec-path:: + Path to wherever your core git programs are installed. + This can also be controlled by setting the GIT_EXEC_PATH + environment variable. If no path is given 'git' will print + the current setting and then exit. + + +FURTHER DOCUMENTATION +--------------------- -This is reference information for the core git commands. - -Before reading this cover to cover, you may want to take a look -at the link:tutorial.html[tutorial] document. - -The <> section below contains much useful definition and -clarification info - read that first. And of the commands, I suggest -reading gitlink:git-update-index[1] and -gitlink:git-read-tree[1] first - I wish I had! - -If you are migrating from CVS, link:cvs-migration.html[cvs migration] -document may be helpful after you finish the tutorial. +See the references above to get started using git. The following is +probably more detail than necessary for a first-time user. -After you get the general feel from the tutorial and this -overview page, you may want to take a look at the -link:howto-index.html[howto] documents. +The <> section below and the +link:core-tutorial.html[Core tutorial] both provide introductions to the +underlying git architecture. +See also the link:howto-index.html[howto] documents for some useful +examples. -David Greaves -08/05/05 +GIT COMMANDS +------------ -Updated by Junio C Hamano on 2005-05-05 to -reflect recent changes. +We divide git into high level ("porcelain") commands and low level +("plumbing") commands. -Commands Overview ------------------ -The git commands can helpfully be split into those that manipulate -the repository, the cache and the working fileset, those that -interrogate and compare them, and those that moves objects and -references between repositories. +Low-level commands (plumbing) +----------------------------- -In addition, git itself comes with a spartan set of porcelain -commands. They are usable but are not meant to compete with real -Porcelains. +Although git includes its +own porcelain layer, its low-level commands are sufficient to support +development of alternative porcelains. Developers of such porcelains +might start by reading about gitlink:git-update-index[1] and +gitlink:git-read-tree[1]. -There are also some ancillary programs that can be viewed as useful -aids for using the core commands but which are unlikely to be used by -SCMs layered over git. +We divide the low-level commands into commands that manipulate objects (in +the repository, index, and working tree), commands that interrogate and +compare objects, and commands that move objects and references between +repositories. Manipulation commands ~~~~~~~~~~~~~~~~~~~~~ @@ -59,25 +79,29 @@ gitlink:git-apply[1]:: applies it to the working tree. gitlink:git-checkout-index[1]:: - Copy files from the cache to the working directory + Copy files from the index to the working tree. gitlink:git-commit-tree[1]:: - Creates a new commit object + Creates a new commit object. gitlink:git-hash-object[1]:: Computes the object ID from a file. -gitlink:git-index-pack.html[1]:: - Build pack index file for an existing packed archive. +gitlink:git-index-pack[1]:: + Build pack idx file for an existing packed archive. gitlink:git-init-db[1]:: - Creates an empty git object database + Creates an empty git object database, or reinitialize an + existing one. gitlink:git-merge-index[1]:: - Runs a merge for files needing merging + Runs a merge for files needing merging. gitlink:git-mktag[1]:: - Creates a tag object + Creates a tag object. + +gitlink:git-mktree[1]:: + Build a tree-object from ls-tree formatted text. gitlink:git-pack-objects[1]:: Creates a packed archive of objects. @@ -86,71 +110,80 @@ gitlink:git-prune-packed[1]:: Remove extra objects that are already in pack files. gitlink:git-read-tree[1]:: - Reads tree information into the directory cache + Reads tree information into the index. + +gitlink:git-repo-config[1]:: + Get and set options in .git/config. gitlink:git-unpack-objects[1]:: Unpacks objects out of a packed archive. gitlink:git-update-index[1]:: - Modifies the index or directory cache + Registers files in the working tree to the index. gitlink:git-write-tree[1]:: - Creates a tree from the current cache + Creates a tree from the index. Interrogation commands ~~~~~~~~~~~~~~~~~~~~~~ gitlink:git-cat-file[1]:: - Provide content or type information for repository objects + Provide content or type/size information for repository objects. + +gitlink:git-describe[1]:: + Show the most recent tag that is reachable from a commit. gitlink:git-diff-index[1]:: - Compares content and mode of blobs between the cache and repository + Compares content and mode of blobs between the index and repository. gitlink:git-diff-files[1]:: - Compares files in the working tree and the cache + Compares files in the working tree and the index. gitlink:git-diff-stages[1]:: - Compares two "merge stages" in the index file. + Compares two "merge stages" in the index. gitlink:git-diff-tree[1]:: - Compares the content and mode of blobs found via two tree objects + Compares the content and mode of blobs found via two tree objects. gitlink:git-fsck-objects[1]:: - Verifies the connectivity and validity of the objects in the database + Verifies the connectivity and validity of the objects in the database. gitlink:git-ls-files[1]:: - Information about files in the cache/working directory + Information about files in the index and the working tree. gitlink:git-ls-tree[1]:: - Displays a tree object in human readable form + Displays a tree object in human readable form. gitlink:git-merge-base[1]:: - Finds as good a common ancestor as possible for a merge + Finds as good common ancestors as possible for a merge. gitlink:git-name-rev[1]:: - Find symbolic names for given revs + Find symbolic names for given revs. + +gitlink:git-pack-redundant[1]:: + Find redundant pack files. gitlink:git-rev-list[1]:: - Lists commit objects in reverse chronological order + Lists commit objects in reverse chronological order. gitlink:git-show-index[1]:: Displays contents of a pack idx file. gitlink:git-tar-tree[1]:: - Creates a tar archive of the files in the named tree + Creates a tar archive of the files in the named tree object. gitlink:git-unpack-file[1]:: - Creates a temporary file with a blob's contents + Creates a temporary file with a blob's contents. gitlink:git-var[1]:: - Displays a git logical variable + Displays a git logical variable. gitlink:git-verify-pack[1]:: - Validates packed git archive files + Validates packed git archive files. -The interrogate commands may create files - and you can force them to -touch the working file set - but in general they don't +In general, the interrogate commands do not touch the files in +the working tree. Synching repositories @@ -158,19 +191,24 @@ Synching repositories gitlink:git-clone-pack[1]:: Clones a repository into the current repository (engine - for ssh and local transport) + for ssh and local transport). gitlink:git-fetch-pack[1]:: - Updates from a remote repository. + Updates from a remote repository (engine for ssh and + local transport). gitlink:git-http-fetch[1]:: - Downloads a remote git repository via HTTP + Downloads a remote git repository via HTTP by walking + commit chain. gitlink:git-local-fetch[1]:: - Duplicates another git repository on a local system + Duplicates another git repository on a local system by + walking commit chain. gitlink:git-peek-remote[1]:: - Lists references on a remote repository using upload-pack protocol. + Lists references on a remote repository using + upload-pack protocol (engine for ssh and local + transport). gitlink:git-receive-pack[1]:: Invoked by 'git-send-pack' to receive what is pushed to it. @@ -178,14 +216,18 @@ gitlink:git-receive-pack[1]:: gitlink:git-send-pack[1]:: Pushes to a remote repository, intelligently. +gitlink:git-http-push[1]:: + Push missing objects using HTTP/DAV. + gitlink:git-shell[1]:: Restricted shell for GIT-only SSH access. gitlink:git-ssh-fetch[1]:: - Pulls from a remote repository over ssh connection + Pulls from a remote repository over ssh connection by + walking commit chain. gitlink:git-ssh-upload[1]:: - Helper "server-side" program used by git-ssh-fetch + Helper "server-side" program used by git-ssh-fetch. gitlink:git-update-server-info[1]:: Updates auxiliary information on a dumb server to help @@ -195,21 +237,31 @@ gitlink:git-upload-pack[1]:: Invoked by 'git-clone-pack' and 'git-fetch-pack' to push what are asked for. +gitlink:git-upload-tar[1]:: + Invoked by 'git-tar-tree --remote' to return the tar + archive the other end asked for. -Porcelain-ish Commands ----------------------- + +High-level commands (porcelain) +------------------------------- + +We separate the porcelain commands into the main commands and some +ancillary user utilities. + +Main porcelain commands +~~~~~~~~~~~~~~~~~~~~~~~ gitlink:git-add[1]:: - Add paths to the index file. + Add paths to the index. gitlink:git-am[1]:: Apply patches from a mailbox, but cooler. gitlink:git-applymbox[1]:: - Apply patches from a mailbox. + Apply patches from a mailbox, original version by Linus. gitlink:git-bisect[1]:: - Find the change that introduced a bug. + Find the change that introduced a bug by binary search. gitlink:git-branch[1]:: Create and Show branches. @@ -220,6 +272,9 @@ gitlink:git-checkout[1]:: gitlink:git-cherry-pick[1]:: Cherry-pick the effect of an existing commit. +gitlink:git-clean[1]:: + Remove untracked files from the working tree. + gitlink:git-clone[1]:: Clones a repository into a new directory. @@ -236,7 +291,7 @@ gitlink:git-format-patch[1]:: Prepare patches for e-mail submission. gitlink:git-grep[1]:: - Print lines matching a pattern + Print lines matching a pattern. gitlink:git-log[1]:: Shows commit logs. @@ -250,9 +305,6 @@ gitlink:git-merge[1]:: gitlink:git-mv[1]:: Move or rename a file, a directory, or a symlink. -gitlink:git-octopus[1]:: - Merge more than two commits. - gitlink:git-pull[1]:: Fetch from and merge with a remote repository. @@ -260,14 +312,14 @@ gitlink:git-push[1]:: Update remote refs along with associated objects. gitlink:git-rebase[1]:: - Rebase local commits to new upstream head. - -gitlink:git-rename[1]:: - Rename files and directories. + Rebase local commits to the updated upstream head. gitlink:git-repack[1]:: Pack unpacked objects in a repository. +gitlink:git-rerere[1]:: + Reuse recorded resolution of conflicted merges. + gitlink:git-reset[1]:: Reset current HEAD to the specified state. @@ -277,9 +329,15 @@ gitlink:git-resolve[1]:: gitlink:git-revert[1]:: Revert an existing commit. +gitlink:git-rm[1]:: + Remove files from the working tree and from the index. + gitlink:git-shortlog[1]:: Summarizes 'git log' output. +gitlink:git-show[1]:: + Show one commit log and its diff. + gitlink:git-show-branch[1]:: Show branches and their commits. @@ -294,7 +352,7 @@ gitlink:git-whatchanged[1]:: Ancillary Commands ------------------- +~~~~~~~~~~~~~~~~~~ Manipulators: gitlink:git-applypatch[1]:: @@ -304,16 +362,28 @@ gitlink:git-archimport[1]:: Import an arch repository into git. gitlink:git-convert-objects[1]:: - Converts old-style git repository + Converts old-style git repository. gitlink:git-cvsimport[1]:: Salvage your data out of another SCM people love to hate. +gitlink:git-cvsexportcommit[1]:: + Export a single commit to a CVS checkout. + +gitlink:git-cvsserver[1]:: + A CVS server emulator for git. + +gitlink:git-lost-found[1]:: + Recover lost refs that luckily have not yet been pruned. + gitlink:git-merge-one-file[1]:: - The standard helper program to use with "git-merge-index" + The standard helper program to use with `git-merge-index`. gitlink:git-prune[1]:: - Prunes all unreachable objects from the object database + Prunes all unreachable objects from the object database. + +gitlink:git-quiltimport[1]:: + Applies a quilt patchset onto the current branch. gitlink:git-relink[1]:: Hardlink common objects in local repositories. @@ -325,10 +395,10 @@ gitlink:git-sh-setup[1]:: Common git shell script setup code. gitlink:git-symbolic-ref[1]:: - Read and modify symbolic refs + Read and modify symbolic refs. gitlink:git-tag[1]:: - An example script to create a tag object signed with GPG + An example script to create a tag object signed with GPG. gitlink:git-update-ref[1]:: Update the object name stored in a ref safely. @@ -336,6 +406,12 @@ gitlink:git-update-ref[1]:: Interrogators: +gitlink:git-annotate[1]:: + Annotate file lines with commit info. + +gitlink:git-blame[1]:: + Blame file lines on commits. + gitlink:git-check-ref-format[1]:: Make sure ref name is well formed. @@ -348,20 +424,32 @@ gitlink:git-count-objects[1]:: gitlink:git-daemon[1]:: A really simple server for git repositories. +gitlink:git-fmt-merge-msg[1]:: + Produce a merge commit message. + gitlink:git-get-tar-commit-id[1]:: Extract commit ID from an archive created using git-tar-tree. +gitlink:git-imap-send[1]:: + Dump a mailbox from stdin into an imap folder. + gitlink:git-mailinfo[1]:: - Extracts patch from a single e-mail message. + Extracts patch and authorship information from a single + e-mail message, optionally transliterating the commit + message into utf-8. gitlink:git-mailsplit[1]:: - git-mailsplit. + A stupid program to split UNIX mbox format mailbox into + individual pieces of e-mail. + +gitlink:git-merge-tree[1]:: + Show three-way merge without touching index. gitlink:git-patch-id[1]:: Compute unique ID for a patch. gitlink:git-parse-remote[1]:: - Routines to help parsing $GIT_DIR/remotes/ + Routines to help parsing `$GIT_DIR/remotes/` files. gitlink:git-request-pull[1]:: git-request-pull. @@ -372,7 +460,7 @@ gitlink:git-rev-parse[1]:: gitlink:git-send-email[1]:: Send patch e-mails out of "format-patch --mbox" output. -gitlink:git-symbolic-refs[1]:: +gitlink:git-symbolic-ref[1]:: Read and modify symbolic refs. gitlink:git-stripspace[1]:: @@ -383,22 +471,20 @@ Commands not yet documented --------------------------- gitlink:gitk[1]:: - gitk. + The gitk repository browser. Configuration Mechanism ----------------------- -Starting from 0.99.9 (actually mid 0.99.8.GIT), .git/config file +Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file is used to hold per-repository configuration options. It is a simple text file modelled after `.ini` format familiar to some people. Here is an example: ------------ # -# This is the config file, and -# a '#' or ';' character indicates -# a comment +# A '#' or ';' character indicates a comment. # ; core variables @@ -420,30 +506,30 @@ their operation accordingly. Identifier Terminology ---------------------- :: - Indicates the sha1 identifier for any type of object + Indicates the object name for any type of object. :: - Indicates a blob object sha1 identifier + Indicates a blob object name. :: - Indicates a tree object sha1 identifier + Indicates a tree object name. :: - Indicates a commit object sha1 identifier + Indicates a commit object name. :: - Indicates a tree, commit or tag object sha1 identifier. A + Indicates a tree, commit or tag object name. A command that takes a argument ultimately wants to operate on a object but automatically dereferences and objects that point at a . :: Indicates that an object type is required. - Currently one of: blob/tree/commit/tag + Currently one of: `blob`, `tree`, `commit`, or `tag`. :: - Indicates a filename - always relative to the root of - the tree structure GIT_INDEX_FILE describes. + Indicates a filename - almost always relative to the + root of the tree structure `GIT_INDEX_FILE` describes. Symbolic Identifiers -------------------- @@ -451,17 +537,16 @@ Any git command accepting any can also use the following symbolic notation: HEAD:: - indicates the head of the repository (ie the contents of - `$GIT_DIR/HEAD`) + indicates the head of the current branch (i.e. the + contents of `$GIT_DIR/HEAD`). + :: - a valid tag 'name'+ - (ie the contents of `$GIT_DIR/refs/tags/`) + a valid tag 'name' + (i.e. the contents of `$GIT_DIR/refs/tags/`). + :: - a valid head 'name'+ - (ie the contents of `$GIT_DIR/refs/heads/`) -:: - a valid snapshot 'name'+ - (ie the contents of `$GIT_DIR/refs/snap/`) + a valid head 'name' + (i.e. the contents of `$GIT_DIR/refs/heads/`). File/Directory Structure @@ -469,8 +554,10 @@ File/Directory Structure Please see link:repository-layout.html[repository layout] document. +Read link:hooks.html[hooks] for more details about each hook. + Higher level SCMs may provide and manage additional information in the -GIT_DIR. +`$GIT_DIR`. Terminology @@ -486,12 +573,12 @@ The git Repository ~~~~~~~~~~~~~~~~~~ These environment variables apply to 'all' core git commands. Nb: it is worth noting that they may be used/overridden by SCMS sitting above -git so take care if using Cogito etc +git so take care if using Cogito etc. 'GIT_INDEX_FILE':: This environment allows the specification of an alternate - cache/index file. If not specified, the default of - `$GIT_DIR/index` is used. + index file. If not specified, the default of `$GIT_DIR/index` + is used. 'GIT_OBJECT_DIRECTORY':: If the object storage directory is specified via this @@ -507,9 +594,9 @@ git so take care if using Cogito etc written to these directories. 'GIT_DIR':: - If the 'GIT_DIR' environment variable is set then it specifies - a path to use instead of `./.git` for the base of the - repository. + If the 'GIT_DIR' environment variable is set then it + specifies a path to use instead of the default `.git` + for the base of the repository. git Commits ~~~~~~~~~~~ @@ -531,15 +618,20 @@ git Diffs Discussion[[Discussion]] ------------------------ -include::../README[] +include::README[] -Author ------- -Written by Linus Torvalds and the git-list . +Authors +------- +* git's founding father is Linus Torvalds . +* The current git nurse is Junio C Hamano . +* The git potty was written by Andres Ericsson . +* General upbringing is handled by the git-list . Documentation -------------- -Documentation by David Greaves, Junio C Hamano and the git-list . +The documentation for git suite was started by David Greaves +, and later enhanced greatly by the +contributors on the git-list . GIT ---