DESCRIPTION
-----------
-'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).
+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.
+ 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.
+ 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.
+ 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. If you are
-migrating from CVS, link:cvs-migration.html[cvs migration]
-document may be helpful after you finish the tutorial.
-The <<Discussion>> section below contains much useful definition
-and clarification info - read that first. After that, if you
-are interested in using git to manage (version control)
-projects, use link:everyday.html[Everyday GIT] as a guide to the
-minimum set of commands you need to know for day-to-day work.
+FURTHER DOCUMENTATION
+---------------------
-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.
+See the references above to get started using git. The following is
+probably more detail than necessary for a first-time user.
-If you are writing your own Porcelain, you need to be familiar
-with most of the low level commands --- I suggest starting from
-gitlink:git-update-index[1] and gitlink:git-read-tree[1].
+The <<Discussion,Discussion>> 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 <david@dgreaves.com>
-08/05/05
+GIT COMMANDS
+------------
-Updated by Junio C Hamano <junkio@cox.net> on 2005-05-05 and
-further on 2005-12-07 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 index and the files in the working tree, 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
~~~~~~~~~~~~~~~~~~~~~
gitlink:git-mktag[1]::
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.
gitlink:git-cat-file[1]::
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 index and repository.
what are 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.
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.
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.
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.
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.
Ancillary Commands
-------------------
+~~~~~~~~~~~~~~~~~~
Manipulators:
gitlink:git-applypatch[1]::
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.
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.
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 and authorship information from a single
e-mail message, optionally transliterating the commit
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-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]::
a valid head 'name'
(i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
-<snap>::
- a valid snapshot 'name'
- (i.e. the contents of `$GIT_DIR/refs/snap/<snap>`).
-
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`.
Discussion[[Discussion]]
------------------------
-include::../README[]
+include::README[]
Authors
-------
- git's founding father is Linus Torvalds <torvalds@osdl.org>.
- The current git nurse is Junio C Hamano <junkio@cox.net>.
-
The git potty was written by Andres Ericsson <ae@op5.se>.
- General upbringing is handled by the git-list <git@vger.kernel.org>.
+* git's founding father is Linus Torvalds <torvalds@osdl.org>.
+* The current git nurse is Junio C Hamano <junkio@cox.net>.
+
* The git potty was written by Andres Ericsson <ae@op5.se>.
+* General upbringing is handled by the git-list <git@vger.kernel.org>.
Documentation
--------------
-Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
+The documentation for git suite was started by David Greaves
+<david@dgreaves.com>, and later enhanced greatly by the
+contributors on the git-list <git@vger.kernel.org>.
GIT
---