unpack_trees(): fix diff-index regression.
[git/dscho.git] / Documentation / git.txt
blob3ed24d449a1f277c40dbb49654a196e38d1fa3e4
1 git(7)
2 ======
4 NAME
5 ----
6 git - the stupid content tracker
9 SYNOPSIS
10 --------
11 [verse]
12 'git' [--version] [--exec-path[=GIT_EXEC_PATH]]
13     [-p|--paginate|--no-pager]
14     [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]
15     [--help] COMMAND [ARGS]
17 DESCRIPTION
18 -----------
19 Git is a fast, scalable, distributed revision control system with an
20 unusually rich command set that provides both high-level operations
21 and full access to internals.
23 See this link:tutorial.html[tutorial] to get started, then see
24 link:everyday.html[Everyday Git] for a useful minimum set of commands, and
25 "man git-commandname" for documentation of each command.  CVS users may
26 also want to read link:cvs-migration.html[CVS migration].  See
27 link:user-manual.html[Git User's Manual] for a more in-depth
28 introduction.
30 The COMMAND is either a name of a Git command (see below) or an alias
31 as defined in the configuration file (see linkgit:git-config[1]).
33 Formatted and hyperlinked version of the latest git
34 documentation can be viewed at
35 `http://www.kernel.org/pub/software/scm/git/docs/`.
37 ifdef::stalenotes[]
38 [NOTE]
39 ============
41 You are reading the documentation for the latest (possibly
42 unreleased) version of git, that is available from 'master'
43 branch of the `git.git` repository.
44 Documentation for older releases are available here:
46 * link:v1.5.4.4/git.html[documentation for release 1.5.4.4]
48 * release notes for
49   link:RelNotes-1.5.4.4.txt[1.5.4.4],
50   link:RelNotes-1.5.4.3.txt[1.5.4.3],
51   link:RelNotes-1.5.4.2.txt[1.5.4.2],
52   link:RelNotes-1.5.4.1.txt[1.5.4.1],
53   link:RelNotes-1.5.4.txt[1.5.4].
55 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
57 * release notes for
58   link:RelNotes-1.5.3.8.txt[1.5.3.8],
59   link:RelNotes-1.5.3.7.txt[1.5.3.7],
60   link:RelNotes-1.5.3.6.txt[1.5.3.6],
61   link:RelNotes-1.5.3.5.txt[1.5.3.5],
62   link:RelNotes-1.5.3.4.txt[1.5.3.4],
63   link:RelNotes-1.5.3.3.txt[1.5.3.3],
64   link:RelNotes-1.5.3.2.txt[1.5.3.2],
65   link:RelNotes-1.5.3.1.txt[1.5.3.1],
66   link:RelNotes-1.5.3.txt[1.5.3].
68 * release notes for
69   link:RelNotes-1.5.2.5.txt[1.5.2.5],
70   link:RelNotes-1.5.2.4.txt[1.5.2.4],
71   link:RelNotes-1.5.2.3.txt[1.5.2.3],
72   link:RelNotes-1.5.2.2.txt[1.5.2.2],
73   link:RelNotes-1.5.2.1.txt[1.5.2.1],
74   link:RelNotes-1.5.2.txt[1.5.2].
76 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
78 * release notes for
79   link:RelNotes-1.5.1.6.txt[1.5.1.6],
80   link:RelNotes-1.5.1.5.txt[1.5.1.5],
81   link:RelNotes-1.5.1.4.txt[1.5.1.4],
82   link:RelNotes-1.5.1.3.txt[1.5.1.3],
83   link:RelNotes-1.5.1.2.txt[1.5.1.2],
84   link:RelNotes-1.5.1.1.txt[1.5.1.1],
85   link:RelNotes-1.5.1.txt[1.5.1].
87 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
89 * release notes for
90   link:RelNotes-1.5.0.7.txt[1.5.0.7],
91   link:RelNotes-1.5.0.6.txt[1.5.0.6],
92   link:RelNotes-1.5.0.5.txt[1.5.0.5],
93   link:RelNotes-1.5.0.3.txt[1.5.0.3],
94   link:RelNotes-1.5.0.2.txt[1.5.0.2],
95   link:RelNotes-1.5.0.1.txt[1.5.0.1],
96   link:RelNotes-1.5.0.txt[1.5.0].
98 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
99   link:v1.3.3/git.html[1.3.3],
100   link:v1.2.6/git.html[1.2.6],
101   link:v1.0.13/git.html[1.0.13].
103 ============
105 endif::stalenotes[]
107 OPTIONS
108 -------
109 --version::
110         Prints the git suite version that the 'git' program came from.
112 --help::
113         Prints the synopsis and a list of the most commonly used
114         commands. If the option '--all' or '-a' is given then all
115         available commands are printed. If a git command is named this
116         option will bring up the manual page for that command.
118 Other options are available to control how the manual page is
119 displayed. See linkgit:git-help[1] for more information,
120 because 'git --help ...' is converted internally into 'git
121 help ...'.
123 --exec-path::
124         Path to wherever your core git programs are installed.
125         This can also be controlled by setting the GIT_EXEC_PATH
126         environment variable. If no path is given 'git' will print
127         the current setting and then exit.
129 -p|--paginate::
130         Pipe all output into 'less' (or if set, $PAGER).
132 --no-pager::
133         Do not pipe git output into a pager.
135 --git-dir=<path>::
136         Set the path to the repository. This can also be controlled by
137         setting the GIT_DIR environment variable.
139 --work-tree=<path>::
140         Set the path to the working tree.  The value will not be
141         used in combination with repositories found automatically in
142         a .git directory (i.e. $GIT_DIR is not set).
143         This can also be controlled by setting the GIT_WORK_TREE
144         environment variable and the core.worktree configuration
145         variable.
147 --bare::
148         Treat the repository as a bare repository.  If GIT_DIR
149         environment is not set, it is set to the current working
150         directory.
153 FURTHER DOCUMENTATION
154 ---------------------
156 See the references above to get started using git.  The following is
157 probably more detail than necessary for a first-time user.
159 The link:user-manual.html#git-concepts[git concepts chapter of the
160 user-manual] and the link:core-tutorial.html[Core tutorial] both provide
161 introductions to the underlying git architecture.
163 See also the link:howto-index.html[howto] documents for some useful
164 examples.
166 The internals are documented link:technical/api-index.html[here].
168 GIT COMMANDS
169 ------------
171 We divide git into high level ("porcelain") commands and low level
172 ("plumbing") commands.
174 High-level commands (porcelain)
175 -------------------------------
177 We separate the porcelain commands into the main commands and some
178 ancillary user utilities.
180 Main porcelain commands
181 ~~~~~~~~~~~~~~~~~~~~~~~
183 include::cmds-mainporcelain.txt[]
185 Ancillary Commands
186 ~~~~~~~~~~~~~~~~~~
187 Manipulators:
189 include::cmds-ancillarymanipulators.txt[]
191 Interrogators:
193 include::cmds-ancillaryinterrogators.txt[]
196 Interacting with Others
197 ~~~~~~~~~~~~~~~~~~~~~~~
199 These commands are to interact with foreign SCM and with other
200 people via patch over e-mail.
202 include::cmds-foreignscminterface.txt[]
205 Low-level commands (plumbing)
206 -----------------------------
208 Although git includes its
209 own porcelain layer, its low-level commands are sufficient to support
210 development of alternative porcelains.  Developers of such porcelains
211 might start by reading about linkgit:git-update-index[1] and
212 linkgit:git-read-tree[1].
214 The interface (input, output, set of options and the semantics)
215 to these low-level commands are meant to be a lot more stable
216 than Porcelain level commands, because these commands are
217 primarily for scripted use.  The interface to Porcelain commands
218 on the other hand are subject to change in order to improve the
219 end user experience.
221 The following description divides
222 the low-level commands into commands that manipulate objects (in
223 the repository, index, and working tree), commands that interrogate and
224 compare objects, and commands that move objects and references between
225 repositories.
228 Manipulation commands
229 ~~~~~~~~~~~~~~~~~~~~~
231 include::cmds-plumbingmanipulators.txt[]
234 Interrogation commands
235 ~~~~~~~~~~~~~~~~~~~~~~
237 include::cmds-plumbinginterrogators.txt[]
239 In general, the interrogate commands do not touch the files in
240 the working tree.
243 Synching repositories
244 ~~~~~~~~~~~~~~~~~~~~~
246 include::cmds-synchingrepositories.txt[]
248 The following are helper programs used by the above; end users
249 typically do not use them directly.
251 include::cmds-synchelpers.txt[]
254 Internal helper commands
255 ~~~~~~~~~~~~~~~~~~~~~~~~
257 These are internal helper commands used by other commands; end
258 users typically do not use them directly.
260 include::cmds-purehelpers.txt[]
263 Configuration Mechanism
264 -----------------------
266 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
267 is used to hold per-repository configuration options.  It is a
268 simple text file modeled after `.ini` format familiar to some
269 people.  Here is an example:
271 ------------
273 # A '#' or ';' character indicates a comment.
276 ; core variables
277 [core]
278         ; Don't trust file modes
279         filemode = false
281 ; user identity
282 [user]
283         name = "Junio C Hamano"
284         email = "junkio@twinsun.com"
286 ------------
288 Various commands read from the configuration file and adjust
289 their operation accordingly.
292 Identifier Terminology
293 ----------------------
294 <object>::
295         Indicates the object name for any type of object.
297 <blob>::
298         Indicates a blob object name.
300 <tree>::
301         Indicates a tree object name.
303 <commit>::
304         Indicates a commit object name.
306 <tree-ish>::
307         Indicates a tree, commit or tag object name.  A
308         command that takes a <tree-ish> argument ultimately wants to
309         operate on a <tree> object but automatically dereferences
310         <commit> and <tag> objects that point at a <tree>.
312 <commit-ish>::
313         Indicates a commit or tag object name.  A
314         command that takes a <commit-ish> argument ultimately wants to
315         operate on a <commit> object but automatically dereferences
316         <tag> objects that point at a <commit>.
318 <type>::
319         Indicates that an object type is required.
320         Currently one of: `blob`, `tree`, `commit`, or `tag`.
322 <file>::
323         Indicates a filename - almost always relative to the
324         root of the tree structure `GIT_INDEX_FILE` describes.
326 Symbolic Identifiers
327 --------------------
328 Any git command accepting any <object> can also use the following
329 symbolic notation:
331 HEAD::
332         indicates the head of the current branch (i.e. the
333         contents of `$GIT_DIR/HEAD`).
335 <tag>::
336         a valid tag 'name'
337         (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
339 <head>::
340         a valid head 'name'
341         (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
343 For a more complete list of ways to spell object names, see
344 "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
347 File/Directory Structure
348 ------------------------
350 Please see the link:repository-layout.html[repository layout] document.
352 Read link:hooks.html[hooks] for more details about each hook.
354 Higher level SCMs may provide and manage additional information in the
355 `$GIT_DIR`.
358 Terminology
359 -----------
360 Please see the link:glossary.html[glossary] document.
363 Environment Variables
364 ---------------------
365 Various git commands use the following environment variables:
367 The git Repository
368 ~~~~~~~~~~~~~~~~~~
369 These environment variables apply to 'all' core git commands. Nb: it
370 is worth noting that they may be used/overridden by SCMS sitting above
371 git so take care if using Cogito etc.
373 'GIT_INDEX_FILE'::
374         This environment allows the specification of an alternate
375         index file. If not specified, the default of `$GIT_DIR/index`
376         is used.
378 'GIT_OBJECT_DIRECTORY'::
379         If the object storage directory is specified via this
380         environment variable then the sha1 directories are created
381         underneath - otherwise the default `$GIT_DIR/objects`
382         directory is used.
384 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
385         Due to the immutable nature of git objects, old objects can be
386         archived into shared, read-only directories. This variable
387         specifies a ":" separated list of git object directories which
388         can be used to search for git objects. New objects will not be
389         written to these directories.
391 'GIT_DIR'::
392         If the 'GIT_DIR' environment variable is set then it
393         specifies a path to use instead of the default `.git`
394         for the base of the repository.
396 'GIT_WORK_TREE'::
397         Set the path to the working tree.  The value will not be
398         used in combination with repositories found automatically in
399         a .git directory (i.e. $GIT_DIR is not set).
400         This can also be controlled by the '--work-tree' command line
401         option and the core.worktree configuration variable.
403 git Commits
404 ~~~~~~~~~~~
405 'GIT_AUTHOR_NAME'::
406 'GIT_AUTHOR_EMAIL'::
407 'GIT_AUTHOR_DATE'::
408 'GIT_COMMITTER_NAME'::
409 'GIT_COMMITTER_EMAIL'::
410 'GIT_COMMITTER_DATE'::
411 'EMAIL'::
412         see linkgit:git-commit-tree[1]
414 git Diffs
415 ~~~~~~~~~
416 'GIT_DIFF_OPTS'::
417         Only valid setting is "--unified=??" or "-u??" to set the
418         number of context lines shown when a unified diff is created.
419         This takes precedence over any "-U" or "--unified" option
420         value passed on the git diff command line.
422 'GIT_EXTERNAL_DIFF'::
423         When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
424         program named by it is called, instead of the diff invocation
425         described above.  For a path that is added, removed, or modified,
426         'GIT_EXTERNAL_DIFF' is called with 7 parameters:
428         path old-file old-hex old-mode new-file new-hex new-mode
430 where:
432         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
433                          contents of <old|new>,
434         <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
435         <old|new>-mode:: are the octal representation of the file modes.
438 The file parameters can point at the user's working file
439 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
440 when a new file is added), or a temporary file (e.g. `old-file` in the
441 index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
442 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
444 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
445 parameter, <path>.
447 other
448 ~~~~~
449 'GIT_MERGE_VERBOSITY'::
450         A number controlling the amount of output shown by
451         the recursive merge strategy.  Overrides merge.verbosity.
452         See linkgit:git-merge[1]
454 'GIT_PAGER'::
455         This environment variable overrides `$PAGER`. If it is set
456         to an empty string or to the value "cat", git will not launch
457         a pager.
459 'GIT_SSH'::
460         If this environment variable is set then linkgit:git-fetch[1]
461         and linkgit:git-push[1] will use this command instead
462         of `ssh` when they need to connect to a remote system.
463         The 'GIT_SSH' command will be given exactly two arguments:
464         the 'username@host' (or just 'host') from the URL and the
465         shell command to execute on that remote system.
467 To pass options to the program that you want to list in GIT_SSH
468 you will need to wrap the program and options into a shell script,
469 then set GIT_SSH to refer to the shell script.
471 Usually it is easier to configure any desired options through your
472 personal `.ssh/config` file.  Please consult your ssh documentation
473 for further details.
475 'GIT_FLUSH'::
476         If this environment variable is set to "1", then commands such
477         as git-blame (in incremental mode), git-rev-list, git-log,
478         git-whatchanged, etc., will force a flush of the output stream
479         after each commit-oriented record have been flushed.   If this
480         variable is set to "0", the output of these commands will be done
481         using completely buffered I/O.   If this environment variable is
482         not set, git will choose buffered or record-oriented flushing
483         based on whether stdout appears to be redirected to a file or not.
485 'GIT_TRACE'::
486         If this variable is set to "1", "2" or "true" (comparison
487         is case insensitive), git will print `trace:` messages on
488         stderr telling about alias expansion, built-in command
489         execution and external command execution.
490         If this variable is set to an integer value greater than 1
491         and lower than 10 (strictly) then git will interpret this
492         value as an open file descriptor and will try to write the
493         trace messages into this file descriptor.
494         Alternatively, if this variable is set to an absolute path
495         (starting with a '/' character), git will interpret this
496         as a file path and will try to write the trace messages
497         into it.
499 Discussion[[Discussion]]
500 ------------------------
502 More detail on the following is available from the
503 link:user-manual.html#git-concepts[git concepts chapter of the
504 user-manual] and the link:core-tutorial.html[Core tutorial].
506 A git project normally consists of a working directory with a ".git"
507 subdirectory at the top level.  The .git directory contains, among other
508 things, a compressed object database representing the complete history
509 of the project, an "index" file which links that history to the current
510 contents of the working tree, and named pointers into that history such
511 as tags and branch heads.
513 The object database contains objects of three main types: blobs, which
514 hold file data; trees, which point to blobs and other trees to build up
515 directory hierarchies; and commits, which each reference a single tree
516 and some number of parent commits.
518 The commit, equivalent to what other systems call a "changeset" or
519 "version", represents a step in the project's history, and each parent
520 represents an immediately preceding step.  Commits with more than one
521 parent represent merges of independent lines of development.
523 All objects are named by the SHA1 hash of their contents, normally
524 written as a string of 40 hex digits.  Such names are globally unique.
525 The entire history leading up to a commit can be vouched for by signing
526 just that commit.  A fourth object type, the tag, is provided for this
527 purpose.
529 When first created, objects are stored in individual files, but for
530 efficiency may later be compressed together into "pack files".
532 Named pointers called refs mark interesting points in history.  A ref
533 may contain the SHA1 name of an object or the name of another ref.  Refs
534 with names beginning `ref/head/` contain the SHA1 name of the most
535 recent commit (or "head") of a branch under development.  SHA1 names of
536 tags of interest are stored under `ref/tags/`.  A special ref named
537 `HEAD` contains the name of the currently checked-out branch.
539 The index file is initialized with a list of all paths and, for each
540 path, a blob object and a set of attributes.  The blob object represents
541 the contents of the file as of the head of the current branch.  The
542 attributes (last modified time, size, etc.) are taken from the
543 corresponding file in the working tree.  Subsequent changes to the
544 working tree can be found by comparing these attributes.  The index may
545 be updated with new content, and new commits may be created from the
546 content stored in the index.
548 The index is also capable of storing multiple entries (called "stages")
549 for a given pathname.  These stages are used to hold the various
550 unmerged version of a file when a merge is in progress.
552 Authors
553 -------
554 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
555 * The current git nurse is Junio C Hamano <gitster@pobox.com>.
556 * The git potty was written by Andreas Ericsson <ae@op5.se>.
557 * General upbringing is handled by the git-list <git@vger.kernel.org>.
559 Documentation
560 --------------
561 The documentation for git suite was started by David Greaves
562 <david@dgreaves.com>, and later enhanced greatly by the
563 contributors on the git-list <git@vger.kernel.org>.
567 Part of the linkgit:git[7] suite