SubmittingPatches: update GMail section
[git/mjg.git] / Documentation / git.txt
blob657eac831cf0650ce3c4ac6a1f6a690b282cea59
1 git(1)
2 ======
4 NAME
5 ----
6 git - the stupid content tracker
9 SYNOPSIS
10 --------
11 [verse]
12 'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path]
13     [-p|--paginate|--no-pager] [--no-replace-objects]
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 linkgit:gittutorial[7] 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 linkgit:gitcvs-migration[7].  See
27 the 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.7.0.4/git.html[documentation for release 1.7.0.4]
48 * release notes for
49   link:RelNotes-1.7.0.4.txt[1.7.0.4],
50   link:RelNotes-1.7.0.3.txt[1.7.0.3],
51   link:RelNotes-1.7.0.2.txt[1.7.0.2],
52   link:RelNotes-1.7.0.1.txt[1.7.0.1],
53   link:RelNotes-1.7.0.txt[1.7.0].
55 * link:v1.6.6.2/git.html[documentation for release 1.6.6.2]
57 * release notes for
58   link:RelNotes-1.6.6.2.txt[1.6.6.2],
59   link:RelNotes-1.6.6.1.txt[1.6.6.1],
60   link:RelNotes-1.6.6.txt[1.6.6].
62 * link:v1.6.5.8/git.html[documentation for release 1.6.5.8]
64 * release notes for
65   link:RelNotes-1.6.5.8.txt[1.6.5.8],
66   link:RelNotes-1.6.5.7.txt[1.6.5.7],
67   link:RelNotes-1.6.5.6.txt[1.6.5.6],
68   link:RelNotes-1.6.5.5.txt[1.6.5.5],
69   link:RelNotes-1.6.5.4.txt[1.6.5.4],
70   link:RelNotes-1.6.5.3.txt[1.6.5.3],
71   link:RelNotes-1.6.5.2.txt[1.6.5.2],
72   link:RelNotes-1.6.5.1.txt[1.6.5.1],
73   link:RelNotes-1.6.5.txt[1.6.5].
75 * link:v1.6.4.4/git.html[documentation for release 1.6.4.4]
77 * release notes for
78   link:RelNotes-1.6.4.4.txt[1.6.4.4],
79   link:RelNotes-1.6.4.3.txt[1.6.4.3],
80   link:RelNotes-1.6.4.2.txt[1.6.4.2],
81   link:RelNotes-1.6.4.1.txt[1.6.4.1],
82   link:RelNotes-1.6.4.txt[1.6.4].
84 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
86 * release notes for
87   link:RelNotes-1.6.3.4.txt[1.6.3.4],
88   link:RelNotes-1.6.3.3.txt[1.6.3.3],
89   link:RelNotes-1.6.3.2.txt[1.6.3.2],
90   link:RelNotes-1.6.3.1.txt[1.6.3.1],
91   link:RelNotes-1.6.3.txt[1.6.3].
93 * release notes for
94   link:RelNotes-1.6.2.5.txt[1.6.2.5],
95   link:RelNotes-1.6.2.4.txt[1.6.2.4],
96   link:RelNotes-1.6.2.3.txt[1.6.2.3],
97   link:RelNotes-1.6.2.2.txt[1.6.2.2],
98   link:RelNotes-1.6.2.1.txt[1.6.2.1],
99   link:RelNotes-1.6.2.txt[1.6.2].
101 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
103 * release notes for
104   link:RelNotes-1.6.1.3.txt[1.6.1.3],
105   link:RelNotes-1.6.1.2.txt[1.6.1.2],
106   link:RelNotes-1.6.1.1.txt[1.6.1.1],
107   link:RelNotes-1.6.1.txt[1.6.1].
109 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
111 * release notes for
112   link:RelNotes-1.6.0.6.txt[1.6.0.6],
113   link:RelNotes-1.6.0.5.txt[1.6.0.5],
114   link:RelNotes-1.6.0.4.txt[1.6.0.4],
115   link:RelNotes-1.6.0.3.txt[1.6.0.3],
116   link:RelNotes-1.6.0.2.txt[1.6.0.2],
117   link:RelNotes-1.6.0.1.txt[1.6.0.1],
118   link:RelNotes-1.6.0.txt[1.6.0].
120 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
122 * release notes for
123   link:RelNotes-1.5.6.6.txt[1.5.6.6],
124   link:RelNotes-1.5.6.5.txt[1.5.6.5],
125   link:RelNotes-1.5.6.4.txt[1.5.6.4],
126   link:RelNotes-1.5.6.3.txt[1.5.6.3],
127   link:RelNotes-1.5.6.2.txt[1.5.6.2],
128   link:RelNotes-1.5.6.1.txt[1.5.6.1],
129   link:RelNotes-1.5.6.txt[1.5.6].
131 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
133 * release notes for
134   link:RelNotes-1.5.5.6.txt[1.5.5.6],
135   link:RelNotes-1.5.5.5.txt[1.5.5.5],
136   link:RelNotes-1.5.5.4.txt[1.5.5.4],
137   link:RelNotes-1.5.5.3.txt[1.5.5.3],
138   link:RelNotes-1.5.5.2.txt[1.5.5.2],
139   link:RelNotes-1.5.5.1.txt[1.5.5.1],
140   link:RelNotes-1.5.5.txt[1.5.5].
142 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
144 * release notes for
145   link:RelNotes-1.5.4.7.txt[1.5.4.7],
146   link:RelNotes-1.5.4.6.txt[1.5.4.6],
147   link:RelNotes-1.5.4.5.txt[1.5.4.5],
148   link:RelNotes-1.5.4.4.txt[1.5.4.4],
149   link:RelNotes-1.5.4.3.txt[1.5.4.3],
150   link:RelNotes-1.5.4.2.txt[1.5.4.2],
151   link:RelNotes-1.5.4.1.txt[1.5.4.1],
152   link:RelNotes-1.5.4.txt[1.5.4].
154 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
156 * release notes for
157   link:RelNotes-1.5.3.8.txt[1.5.3.8],
158   link:RelNotes-1.5.3.7.txt[1.5.3.7],
159   link:RelNotes-1.5.3.6.txt[1.5.3.6],
160   link:RelNotes-1.5.3.5.txt[1.5.3.5],
161   link:RelNotes-1.5.3.4.txt[1.5.3.4],
162   link:RelNotes-1.5.3.3.txt[1.5.3.3],
163   link:RelNotes-1.5.3.2.txt[1.5.3.2],
164   link:RelNotes-1.5.3.1.txt[1.5.3.1],
165   link:RelNotes-1.5.3.txt[1.5.3].
167 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
169 * release notes for
170   link:RelNotes-1.5.2.5.txt[1.5.2.5],
171   link:RelNotes-1.5.2.4.txt[1.5.2.4],
172   link:RelNotes-1.5.2.3.txt[1.5.2.3],
173   link:RelNotes-1.5.2.2.txt[1.5.2.2],
174   link:RelNotes-1.5.2.1.txt[1.5.2.1],
175   link:RelNotes-1.5.2.txt[1.5.2].
177 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
179 * release notes for
180   link:RelNotes-1.5.1.6.txt[1.5.1.6],
181   link:RelNotes-1.5.1.5.txt[1.5.1.5],
182   link:RelNotes-1.5.1.4.txt[1.5.1.4],
183   link:RelNotes-1.5.1.3.txt[1.5.1.3],
184   link:RelNotes-1.5.1.2.txt[1.5.1.2],
185   link:RelNotes-1.5.1.1.txt[1.5.1.1],
186   link:RelNotes-1.5.1.txt[1.5.1].
188 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
190 * release notes for
191   link:RelNotes-1.5.0.7.txt[1.5.0.7],
192   link:RelNotes-1.5.0.6.txt[1.5.0.6],
193   link:RelNotes-1.5.0.5.txt[1.5.0.5],
194   link:RelNotes-1.5.0.3.txt[1.5.0.3],
195   link:RelNotes-1.5.0.2.txt[1.5.0.2],
196   link:RelNotes-1.5.0.1.txt[1.5.0.1],
197   link:RelNotes-1.5.0.txt[1.5.0].
199 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
200   link:v1.3.3/git.html[1.3.3],
201   link:v1.2.6/git.html[1.2.6],
202   link:v1.0.13/git.html[1.0.13].
204 ============
206 endif::stalenotes[]
208 OPTIONS
209 -------
210 --version::
211         Prints the git suite version that the 'git' program came from.
213 --help::
214         Prints the synopsis and a list of the most commonly used
215         commands. If the option '--all' or '-a' is given then all
216         available commands are printed. If a git command is named this
217         option will bring up the manual page for that command.
219 Other options are available to control how the manual page is
220 displayed. See linkgit:git-help[1] for more information,
221 because `git --help ...` is converted internally into `git
222 help ...`.
224 --exec-path::
225         Path to wherever your core git programs are installed.
226         This can also be controlled by setting the GIT_EXEC_PATH
227         environment variable. If no path is given, 'git' will print
228         the current setting and then exit.
230 --html-path::
231         Print the path to wherever your git HTML documentation is installed
232         and exit.
234 -p::
235 --paginate::
236         Pipe all output into 'less' (or if set, $PAGER) if standard
237         output is a terminal.  This overrides the `pager.<cmd>`
238         configuration options (see the "Configuration Mechanism" section
239         below).
241 --no-pager::
242         Do not pipe git output into a pager.
244 --git-dir=<path>::
245         Set the path to the repository. This can also be controlled by
246         setting the GIT_DIR environment variable. It can be an absolute
247         path or relative path to current working directory.
249 --work-tree=<path>::
250         Set the path to the working tree.  The value will not be
251         used in combination with repositories found automatically in
252         a .git directory (i.e. $GIT_DIR is not set).
253         This can also be controlled by setting the GIT_WORK_TREE
254         environment variable and the core.worktree configuration
255         variable. It can be an absolute path or relative path to
256         the directory specified by --git-dir or GIT_DIR.
257         Note: If --git-dir or GIT_DIR are specified but none of
258         --work-tree, GIT_WORK_TREE and core.worktree is specified,
259         the current working directory is regarded as the top directory
260         of your working tree.
262 --bare::
263         Treat the repository as a bare repository.  If GIT_DIR
264         environment is not set, it is set to the current working
265         directory.
267 --no-replace-objects::
268         Do not use replacement refs to replace git objects. See
269         linkgit:git-replace[1] for more information.
272 FURTHER DOCUMENTATION
273 ---------------------
275 See the references above to get started using git.  The following is
276 probably more detail than necessary for a first-time user.
278 The link:user-manual.html#git-concepts[git concepts chapter of the
279 user-manual] and linkgit:gitcore-tutorial[7] both provide
280 introductions to the underlying git architecture.
282 See linkgit:gitworkflows[7] for an overview of recommended workflows.
284 See also the link:howto-index.html[howto] documents for some useful
285 examples.
287 The internals are documented in the
288 link:technical/api-index.html[GIT API documentation].
290 GIT COMMANDS
291 ------------
293 We divide git into high level ("porcelain") commands and low level
294 ("plumbing") commands.
296 High-level commands (porcelain)
297 -------------------------------
299 We separate the porcelain commands into the main commands and some
300 ancillary user utilities.
302 Main porcelain commands
303 ~~~~~~~~~~~~~~~~~~~~~~~
305 include::cmds-mainporcelain.txt[]
307 Ancillary Commands
308 ~~~~~~~~~~~~~~~~~~
309 Manipulators:
311 include::cmds-ancillarymanipulators.txt[]
313 Interrogators:
315 include::cmds-ancillaryinterrogators.txt[]
318 Interacting with Others
319 ~~~~~~~~~~~~~~~~~~~~~~~
321 These commands are to interact with foreign SCM and with other
322 people via patch over e-mail.
324 include::cmds-foreignscminterface.txt[]
327 Low-level commands (plumbing)
328 -----------------------------
330 Although git includes its
331 own porcelain layer, its low-level commands are sufficient to support
332 development of alternative porcelains.  Developers of such porcelains
333 might start by reading about linkgit:git-update-index[1] and
334 linkgit:git-read-tree[1].
336 The interface (input, output, set of options and the semantics)
337 to these low-level commands are meant to be a lot more stable
338 than Porcelain level commands, because these commands are
339 primarily for scripted use.  The interface to Porcelain commands
340 on the other hand are subject to change in order to improve the
341 end user experience.
343 The following description divides
344 the low-level commands into commands that manipulate objects (in
345 the repository, index, and working tree), commands that interrogate and
346 compare objects, and commands that move objects and references between
347 repositories.
350 Manipulation commands
351 ~~~~~~~~~~~~~~~~~~~~~
353 include::cmds-plumbingmanipulators.txt[]
356 Interrogation commands
357 ~~~~~~~~~~~~~~~~~~~~~~
359 include::cmds-plumbinginterrogators.txt[]
361 In general, the interrogate commands do not touch the files in
362 the working tree.
365 Synching repositories
366 ~~~~~~~~~~~~~~~~~~~~~
368 include::cmds-synchingrepositories.txt[]
370 The following are helper commands used by the above; end users
371 typically do not use them directly.
373 include::cmds-synchelpers.txt[]
376 Internal helper commands
377 ~~~~~~~~~~~~~~~~~~~~~~~~
379 These are internal helper commands used by other commands; end
380 users typically do not use them directly.
382 include::cmds-purehelpers.txt[]
385 Configuration Mechanism
386 -----------------------
388 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
389 is used to hold per-repository configuration options.  It is a
390 simple text file modeled after `.ini` format familiar to some
391 people.  Here is an example:
393 ------------
395 # A '#' or ';' character indicates a comment.
398 ; core variables
399 [core]
400         ; Don't trust file modes
401         filemode = false
403 ; user identity
404 [user]
405         name = "Junio C Hamano"
406         email = "junkio@twinsun.com"
408 ------------
410 Various commands read from the configuration file and adjust
411 their operation accordingly.  See linkgit:git-config[1] for a
412 list.
415 Identifier Terminology
416 ----------------------
417 <object>::
418         Indicates the object name for any type of object.
420 <blob>::
421         Indicates a blob object name.
423 <tree>::
424         Indicates a tree object name.
426 <commit>::
427         Indicates a commit object name.
429 <tree-ish>::
430         Indicates a tree, commit or tag object name.  A
431         command that takes a <tree-ish> argument ultimately wants to
432         operate on a <tree> object but automatically dereferences
433         <commit> and <tag> objects that point at a <tree>.
435 <commit-ish>::
436         Indicates a commit or tag object name.  A
437         command that takes a <commit-ish> argument ultimately wants to
438         operate on a <commit> object but automatically dereferences
439         <tag> objects that point at a <commit>.
441 <type>::
442         Indicates that an object type is required.
443         Currently one of: `blob`, `tree`, `commit`, or `tag`.
445 <file>::
446         Indicates a filename - almost always relative to the
447         root of the tree structure `GIT_INDEX_FILE` describes.
449 Symbolic Identifiers
450 --------------------
451 Any git command accepting any <object> can also use the following
452 symbolic notation:
454 HEAD::
455         indicates the head of the current branch (i.e. the
456         contents of `$GIT_DIR/HEAD`).
458 <tag>::
459         a valid tag 'name'
460         (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
462 <head>::
463         a valid head 'name'
464         (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
466 For a more complete list of ways to spell object names, see
467 "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
470 File/Directory Structure
471 ------------------------
473 Please see the linkgit:gitrepository-layout[5] document.
475 Read linkgit:githooks[5] for more details about each hook.
477 Higher level SCMs may provide and manage additional information in the
478 `$GIT_DIR`.
481 Terminology
482 -----------
483 Please see linkgit:gitglossary[7].
486 Environment Variables
487 ---------------------
488 Various git commands use the following environment variables:
490 The git Repository
491 ~~~~~~~~~~~~~~~~~~
492 These environment variables apply to 'all' core git commands. Nb: it
493 is worth noting that they may be used/overridden by SCMS sitting above
494 git so take care if using Cogito etc.
496 'GIT_INDEX_FILE'::
497         This environment allows the specification of an alternate
498         index file. If not specified, the default of `$GIT_DIR/index`
499         is used.
501 'GIT_OBJECT_DIRECTORY'::
502         If the object storage directory is specified via this
503         environment variable then the sha1 directories are created
504         underneath - otherwise the default `$GIT_DIR/objects`
505         directory is used.
507 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
508         Due to the immutable nature of git objects, old objects can be
509         archived into shared, read-only directories. This variable
510         specifies a ":" separated (on Windows ";" separated) list
511         of git object directories which can be used to search for git
512         objects. New objects will not be written to these directories.
514 'GIT_DIR'::
515         If the 'GIT_DIR' environment variable is set then it
516         specifies a path to use instead of the default `.git`
517         for the base of the repository.
519 'GIT_WORK_TREE'::
520         Set the path to the working tree.  The value will not be
521         used in combination with repositories found automatically in
522         a .git directory (i.e. $GIT_DIR is not set).
523         This can also be controlled by the '--work-tree' command line
524         option and the core.worktree configuration variable.
526 'GIT_CEILING_DIRECTORIES'::
527         This should be a colon-separated list of absolute paths.
528         If set, it is a list of directories that git should not chdir
529         up into while looking for a repository directory.
530         It will not exclude the current working directory or
531         a GIT_DIR set on the command line or in the environment.
532         (Useful for excluding slow-loading network directories.)
534 git Commits
535 ~~~~~~~~~~~
536 'GIT_AUTHOR_NAME'::
537 'GIT_AUTHOR_EMAIL'::
538 'GIT_AUTHOR_DATE'::
539 'GIT_COMMITTER_NAME'::
540 'GIT_COMMITTER_EMAIL'::
541 'GIT_COMMITTER_DATE'::
542 'EMAIL'::
543         see linkgit:git-commit-tree[1]
545 git Diffs
546 ~~~~~~~~~
547 'GIT_DIFF_OPTS'::
548         Only valid setting is "--unified=??" or "-u??" to set the
549         number of context lines shown when a unified diff is created.
550         This takes precedence over any "-U" or "--unified" option
551         value passed on the git diff command line.
553 'GIT_EXTERNAL_DIFF'::
554         When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
555         program named by it is called, instead of the diff invocation
556         described above.  For a path that is added, removed, or modified,
557         'GIT_EXTERNAL_DIFF' is called with 7 parameters:
559         path old-file old-hex old-mode new-file new-hex new-mode
561 where:
563         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
564                          contents of <old|new>,
565         <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
566         <old|new>-mode:: are the octal representation of the file modes.
569 The file parameters can point at the user's working file
570 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
571 when a new file is added), or a temporary file (e.g. `old-file` in the
572 index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
573 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
575 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
576 parameter, <path>.
578 other
579 ~~~~~
580 'GIT_MERGE_VERBOSITY'::
581         A number controlling the amount of output shown by
582         the recursive merge strategy.  Overrides merge.verbosity.
583         See linkgit:git-merge[1]
585 'GIT_PAGER'::
586         This environment variable overrides `$PAGER`. If it is set
587         to an empty string or to the value "cat", git will not launch
588         a pager.  See also the `core.pager` option in
589         linkgit:git-config[1].
591 'GIT_SSH'::
592         If this environment variable is set then 'git fetch'
593         and 'git push' will use this command instead
594         of 'ssh' when they need to connect to a remote system.
595         The '$GIT_SSH' command will be given exactly two arguments:
596         the 'username@host' (or just 'host') from the URL and the
597         shell command to execute on that remote system.
599 To pass options to the program that you want to list in GIT_SSH
600 you will need to wrap the program and options into a shell script,
601 then set GIT_SSH to refer to the shell script.
603 Usually it is easier to configure any desired options through your
604 personal `.ssh/config` file.  Please consult your ssh documentation
605 for further details.
607 'GIT_FLUSH'::
608         If this environment variable is set to "1", then commands such
609         as 'git blame' (in incremental mode), 'git rev-list', 'git log',
610         and 'git whatchanged' will force a flush of the output stream
611         after each commit-oriented record have been flushed.   If this
612         variable is set to "0", the output of these commands will be done
613         using completely buffered I/O.   If this environment variable is
614         not set, git will choose buffered or record-oriented flushing
615         based on whether stdout appears to be redirected to a file or not.
617 'GIT_TRACE'::
618         If this variable is set to "1", "2" or "true" (comparison
619         is case insensitive), git will print `trace:` messages on
620         stderr telling about alias expansion, built-in command
621         execution and external command execution.
622         If this variable is set to an integer value greater than 1
623         and lower than 10 (strictly) then git will interpret this
624         value as an open file descriptor and will try to write the
625         trace messages into this file descriptor.
626         Alternatively, if this variable is set to an absolute path
627         (starting with a '/' character), git will interpret this
628         as a file path and will try to write the trace messages
629         into it.
631 Discussion[[Discussion]]
632 ------------------------
634 More detail on the following is available from the
635 link:user-manual.html#git-concepts[git concepts chapter of the
636 user-manual] and linkgit:gitcore-tutorial[7].
638 A git project normally consists of a working directory with a ".git"
639 subdirectory at the top level.  The .git directory contains, among other
640 things, a compressed object database representing the complete history
641 of the project, an "index" file which links that history to the current
642 contents of the working tree, and named pointers into that history such
643 as tags and branch heads.
645 The object database contains objects of three main types: blobs, which
646 hold file data; trees, which point to blobs and other trees to build up
647 directory hierarchies; and commits, which each reference a single tree
648 and some number of parent commits.
650 The commit, equivalent to what other systems call a "changeset" or
651 "version", represents a step in the project's history, and each parent
652 represents an immediately preceding step.  Commits with more than one
653 parent represent merges of independent lines of development.
655 All objects are named by the SHA1 hash of their contents, normally
656 written as a string of 40 hex digits.  Such names are globally unique.
657 The entire history leading up to a commit can be vouched for by signing
658 just that commit.  A fourth object type, the tag, is provided for this
659 purpose.
661 When first created, objects are stored in individual files, but for
662 efficiency may later be compressed together into "pack files".
664 Named pointers called refs mark interesting points in history.  A ref
665 may contain the SHA1 name of an object or the name of another ref.  Refs
666 with names beginning `ref/head/` contain the SHA1 name of the most
667 recent commit (or "head") of a branch under development.  SHA1 names of
668 tags of interest are stored under `ref/tags/`.  A special ref named
669 `HEAD` contains the name of the currently checked-out branch.
671 The index file is initialized with a list of all paths and, for each
672 path, a blob object and a set of attributes.  The blob object represents
673 the contents of the file as of the head of the current branch.  The
674 attributes (last modified time, size, etc.) are taken from the
675 corresponding file in the working tree.  Subsequent changes to the
676 working tree can be found by comparing these attributes.  The index may
677 be updated with new content, and new commits may be created from the
678 content stored in the index.
680 The index is also capable of storing multiple entries (called "stages")
681 for a given pathname.  These stages are used to hold the various
682 unmerged version of a file when a merge is in progress.
684 Authors
685 -------
686 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
687 * The current git nurse is Junio C Hamano <gitster@pobox.com>.
688 * The git potty was written by Andreas Ericsson <ae@op5.se>.
689 * General upbringing is handled by the git-list <git@vger.kernel.org>.
691 Documentation
692 --------------
693 The documentation for git suite was started by David Greaves
694 <david@dgreaves.com>, and later enhanced greatly by the
695 contributors on the git-list <git@vger.kernel.org>.
697 SEE ALSO
698 --------
699 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
700 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
701 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
702 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
703 linkgit:gitworkflows[7]
707 Part of the linkgit:git[1] suite