X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=Documentation%2Fgit.txt;h=a5182498633c637d618fd465cd814417a65793fe;hb=650e4be59b9f385f56e5829d97d09e8440f174b8;hp=2f9622f5ac492140427e752ebd163cb22d003d8d;hpb=4f9dcf7e5cf6c82455925102d315daf3b833e6d6;p=git.git diff --git a/Documentation/git.txt b/Documentation/git.txt index 2f9622f5..a5182498 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -8,13 +8,33 @@ git - the stupid content tracker SYNOPSIS -------- -'git-' +'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--help] COMMAND [ARGS] DESCRIPTION ----------- - -This is reference information for the core git commands. - +'git' is both a program and a directory content tracker system. +The program 'git' is just a wrapper to reach the core git programs +(or a potty if you like, as it's not exactly porcelain but still +brings your stuff to the plumbing). + +OPTIONS +------- +--version:: + prints the git suite version that the 'git' program came from. + +--help:: + prints the synopsis and a list of available commands. + If a git command is named this option will bring up the + man-page for that command. + +--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. + +CORE GIT COMMANDS +----------------- Before reading this cover to cover, you may want to take a look at the link:tutorial.html[tutorial] document. @@ -40,7 +60,7 @@ reflect recent changes. Commands Overview ----------------- The git commands can helpfully be split into those that manipulate -the repository, the cache and the working fileset, those that +the repository, the index and the working fileset, those that interrogate and compare them, and those that moves objects and references between repositories. @@ -59,7 +79,7 @@ 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 directory gitlink:git-commit-tree[1]:: Creates a new commit object @@ -67,7 +87,7 @@ gitlink:git-commit-tree[1]:: gitlink:git-hash-object[1]:: Computes the object ID from a file. -gitlink:git-index-pack.html[1]:: +gitlink:git-index-pack[1]:: Build pack index file for an existing packed archive. gitlink:git-init-db[1]:: @@ -86,7 +106,10 @@ 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 directory 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. @@ -95,7 +118,7 @@ gitlink:git-update-index[1]:: Modifies the index or directory cache gitlink:git-write-tree[1]:: - Creates a tree from the current cache + Creates a tree from the current index Interrogation commands @@ -105,10 +128,10 @@ gitlink:git-cat-file[1]:: Provide content or type information for repository objects 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. @@ -120,7 +143,7 @@ gitlink:git-fsck-objects[1]:: 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/working directory gitlink:git-ls-tree[1]:: Displays a tree object in human readable form @@ -262,9 +285,6 @@ gitlink:git-push[1]:: gitlink:git-rebase[1]:: Rebase local commits to new upstream head. -gitlink:git-rename[1]:: - Rename files and directories. - gitlink:git-repack[1]:: Pack unpacked objects in a repository. @@ -309,6 +329,9 @@ gitlink:git-convert-objects[1]:: gitlink:git-cvsimport[1]:: Salvage your data out of another SCM people love to hate. +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" @@ -490,8 +513,8 @@ 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 @@ -533,9 +556,12 @@ Discussion[[Discussion]] ------------------------ 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 --------------