1 <?xml version="1.0" encoding="UTF-8"?>
\r
2 <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
\r
4 <sect2 lang="en" id="git(1)">
\r
5 <title>git(1)</title>
\r
7 <primary>git(1)</primary>
\r
9 <simplesect id="git(1)__name">
\r
11 <simpara>git - the stupid content tracker</simpara>
\r
13 <simplesect id="git(1)__synopsis">
\r
14 <title>SYNOPSIS</title>
\r
16 <literallayout><emphasis>git</emphasis> [--version] [--help] [-C <path>] [-c <name>=<value>]
\r
17 [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
\r
18 [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]
\r
19 [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
\r
20 <command> [<args>]</literallayout>
\r
23 <simplesect id="git(1)__description">
\r
24 <title>DESCRIPTION</title>
\r
25 <simpara>Git is a fast, scalable, distributed revision control system with an
\r
26 unusually rich command set that provides both high-level operations
\r
27 and full access to internals.</simpara>
\r
28 <simpara>See <xref linkend="gittutorial(7)" /> to get started, then see
\r
29 <xref linkend="giteveryday(7)" /> for a useful minimum set of
\r
30 commands. The <ulink url="https://www.kernel.org/pub/software/scm/git/docs/user-manual.html"><citetitle>Git User's Manual</citetitle></ulink> has a more
\r
31 in-depth introduction.</simpara>
\r
32 <simpara>After you mastered the basic concepts, you can come back to this
\r
33 page to learn what commands Git offers. You can learn more about
\r
34 individual Git commands with "git help command". <xref linkend="gitcli(7)" />
\r
35 manual page gives you an overview of the command-line command syntax.</simpara>
\r
36 <simpara>Formatted and hyperlinked version of the latest Git documentation
\r
37 can be viewed at <emphasis>http://git-htmldocs.googlecode.com/git/git.html</emphasis>.</simpara>
\r
39 <simplesect id="git(1)__options">
\r
40 <title>OPTIONS</title>
\r
48 Prints the Git suite version that the <emphasis>git</emphasis> program came from.
\r
58 Prints the synopsis and a list of the most commonly used
\r
59 commands. If the option <emphasis>--all</emphasis> or <emphasis>-a</emphasis> is given then all
\r
60 available commands are printed. If a Git command is named this
\r
61 option will bring up the manual page for that command.
\r
63 <simpara>Other options are available to control how the manual page is
\r
64 displayed. See <xref linkend="git-help(1)" /> for more information,
\r
65 because <emphasis>git --help ...</emphasis> is converted internally into <emphasis>git
\r
66 help ...</emphasis>.</simpara>
\r
75 Run as if git was started in <emphasis><path></emphasis> instead of the current working
\r
76 directory. When multiple <emphasis>-C</emphasis> options are given, each subsequent
\r
77 non-absolute <emphasis>-C <path></emphasis> is interpreted relative to the preceding <emphasis>-C
\r
78 <path></emphasis>.
\r
80 <simpara>This option affects options that expect path name like <emphasis>--git-dir</emphasis> and
\r
81 <emphasis>--work-tree</emphasis> in that their interpretations of the path names would be
\r
82 made relative to the working directory caused by the <emphasis>-C</emphasis> option. For
\r
83 example the following invocations are equivalent:</simpara>
\r
84 <literallayout class="monospaced">git --git-dir=a.git --work-tree=b -C c status
\r
85 git --git-dir=c/a.git --work-tree=c/b status</literallayout>
\r
90 -c <name>=<value>
\r
94 Pass a configuration parameter to the command. The value
\r
95 given will override values from configuration files.
\r
96 The <name> is expected in the same format as listed by
\r
97 <emphasis>git config</emphasis> (subkeys separated by dots).
\r
99 <simpara>Note that omitting the <emphasis>=</emphasis> in <emphasis>git -c foo.bar ...</emphasis> is allowed and sets
\r
100 <emphasis>foo.bar</emphasis> to the boolean true value (just like <emphasis>[foo]bar</emphasis> would in a
\r
101 config file). Including the equals but with an empty value (like <emphasis>git -c
\r
102 foo.bar= ...</emphasis>) sets <emphasis>foo.bar</emphasis> to the empty string.</simpara>
\r
107 --exec-path[=<path>]
\r
111 Path to wherever your core Git programs are installed.
\r
112 This can also be controlled by setting the GIT_EXEC_PATH
\r
113 environment variable. If no path is given, <emphasis>git</emphasis> will print
\r
114 the current setting and then exit.
\r
124 Print the path, without trailing slash, where Git's HTML
\r
125 documentation is installed and exit.
\r
135 Print the manpath (see <emphasis>man(1)</emphasis>) for the man pages for
\r
136 this version of Git and exit.
\r
146 Print the path where the Info files documenting this
\r
147 version of Git are installed and exit.
\r
160 Pipe all output into <emphasis>less</emphasis> (or if set, $PAGER) if standard
\r
161 output is a terminal. This overrides the <emphasis>pager.<cmd></emphasis>
\r
162 configuration options (see the "Configuration Mechanism" section
\r
173 Do not pipe Git output into a pager.
\r
179 --git-dir=<path>
\r
183 Set the path to the repository. This can also be controlled by
\r
184 setting the GIT_DIR environment variable. It can be an absolute
\r
185 path or relative path to current working directory.
\r
191 --work-tree=<path>
\r
195 Set the path to the working tree. It can be an absolute path
\r
196 or a path relative to the current working directory.
\r
197 This can also be controlled by setting the GIT_WORK_TREE
\r
198 environment variable and the core.worktree configuration
\r
199 variable (see core.worktree in <xref linkend="git-config(1)" /> for a
\r
200 more detailed discussion).
\r
206 --namespace=<path>
\r
210 Set the Git namespace. See <xref linkend="gitnamespaces(7)" /> for more
\r
211 details. Equivalent to setting the <emphasis>GIT_NAMESPACE</emphasis> environment
\r
222 Treat the repository as a bare repository. If GIT_DIR
\r
223 environment is not set, it is set to the current working
\r
230 --no-replace-objects
\r
234 Do not use replacement refs to replace Git objects. See
\r
235 <xref linkend="git-replace(1)" /> for more information.
\r
241 --literal-pathspecs
\r
245 Treat pathspecs literally (i.e. no globbing, no pathspec magic).
\r
246 This is equivalent to setting the <emphasis>GIT_LITERAL_PATHSPECS</emphasis> environment
\r
247 variable to <emphasis>1</emphasis>.
\r
257 Add "glob" magic to all pathspec. This is equivalent to setting
\r
258 the <emphasis>GIT_GLOB_PATHSPECS</emphasis> environment variable to <emphasis>1</emphasis>. Disabling
\r
259 globbing on individual pathspecs can be done using pathspec
\r
270 Add "literal" magic to all pathspec. This is equivalent to setting
\r
271 the <emphasis>GIT_NOGLOB_PATHSPECS</emphasis> environment variable to <emphasis>1</emphasis>. Enabling
\r
272 globbing on individual pathspecs can be done using pathspec
\r
283 Add "icase" magic to all pathspec. This is equivalent to setting
\r
284 the <emphasis>GIT_ICASE_PATHSPECS</emphasis> environment variable to <emphasis>1</emphasis>.
\r
290 <simplesect id="git(1)__git_commands">
\r
291 <title>GIT COMMANDS</title>
\r
292 <simpara>We divide Git into high level ("porcelain") commands and low level
\r
293 ("plumbing") commands.</simpara>
\r
295 <simplesect id="git(1)__high_level_commands_porcelain">
\r
296 <title>High-level commands (porcelain)</title>
\r
297 <simpara>We separate the porcelain commands into the main commands and some
\r
298 ancillary user utilities.</simpara>
\r
299 <section id="git(1)__main_porcelain_commands">
\r
300 <title>Main porcelain commands</title>
\r
304 <xref linkend="git-add(1)" />
\r
308 Add file contents to the index.
\r
314 <xref linkend="git-am(1)" />
\r
318 Apply a series of patches from a mailbox.
\r
324 <xref linkend="git-archive(1)" />
\r
328 Create an archive of files from a named tree.
\r
334 <xref linkend="git-bisect(1)" />
\r
338 Use binary search to find the commit that introduced a bug.
\r
344 <xref linkend="git-branch(1)" />
\r
348 List, create, or delete branches.
\r
354 <xref linkend="git-bundle(1)" />
\r
358 Move objects and refs by archive.
\r
364 <xref linkend="git-checkout(1)" />
\r
368 Switch branches or restore working tree files.
\r
374 <xref linkend="git-cherry-pick(1)" />
\r
378 Apply the changes introduced by some existing commits.
\r
384 <xref linkend="git-citool(1)" />
\r
388 Graphical alternative to git-commit.
\r
394 <xref linkend="git-clean(1)" />
\r
398 Remove untracked files from the working tree.
\r
404 <xref linkend="git-clone(1)" />
\r
408 Clone a repository into a new directory.
\r
414 <xref linkend="git-commit(1)" />
\r
418 Record changes to the repository.
\r
424 <xref linkend="git-describe(1)" />
\r
428 Describe a commit using the most recent tag reachable from it.
\r
434 <xref linkend="git-diff(1)" />
\r
438 Show changes between commits, commit and working tree, etc.
\r
444 <xref linkend="git-fetch(1)" />
\r
448 Download objects and refs from another repository.
\r
454 <xref linkend="git-format-patch(1)" />
\r
458 Prepare patches for e-mail submission.
\r
464 <xref linkend="git-gc(1)" />
\r
468 Cleanup unnecessary files and optimize the local repository.
\r
474 <xref linkend="git-grep(1)" />
\r
478 Print lines matching a pattern.
\r
484 <xref linkend="git-gui(1)" />
\r
488 A portable graphical interface to Git.
\r
494 <xref linkend="git-init(1)" />
\r
498 Create an empty Git repository or reinitialize an existing one.
\r
504 <xref linkend="git-log(1)" />
\r
514 <xref linkend="git-merge(1)" />
\r
518 Join two or more development histories together.
\r
524 <xref linkend="git-mv(1)" />
\r
528 Move or rename a file, a directory, or a symlink.
\r
534 <xref linkend="git-notes(1)" />
\r
538 Add or inspect object notes.
\r
544 <xref linkend="git-pull(1)" />
\r
548 Fetch from and integrate with another repository or a local branch.
\r
554 <xref linkend="git-push(1)" />
\r
558 Update remote refs along with associated objects.
\r
564 <xref linkend="git-rebase(1)" />
\r
568 Reapply commits on top of another base tip.
\r
574 <xref linkend="git-reset(1)" />
\r
578 Reset current HEAD to the specified state.
\r
584 <xref linkend="git-revert(1)" />
\r
588 Revert some existing commits.
\r
594 <xref linkend="git-rm(1)" />
\r
598 Remove files from the working tree and from the index.
\r
604 <xref linkend="git-shortlog(1)" />
\r
608 Summarize <emphasis>git log</emphasis> output.
\r
614 <xref linkend="git-show(1)" />
\r
618 Show various types of objects.
\r
624 <xref linkend="git-stash(1)" />
\r
628 Stash the changes in a dirty working directory away.
\r
634 <xref linkend="git-status(1)" />
\r
638 Show the working tree status.
\r
644 <xref linkend="git-submodule(1)" />
\r
648 Initialize, update or inspect submodules.
\r
654 <xref linkend="git-tag(1)" />
\r
658 Create, list, delete or verify a tag object signed with GPG.
\r
664 <xref linkend="git-worktree(1)" />
\r
668 Manage multiple working trees.
\r
674 <xref linkend="gitk(1)" />
\r
678 The Git repository browser.
\r
684 <section id="git(1)__ancillary_commands">
\r
685 <title>Ancillary Commands</title>
\r
686 <simpara>Manipulators:</simpara>
\r
690 <xref linkend="git-config(1)" />
\r
694 Get and set repository or global options.
\r
700 <xref linkend="git-fast-export(1)" />
\r
710 <xref linkend="git-fast-import(1)" />
\r
714 Backend for fast Git data importers.
\r
720 <xref linkend="git-filter-branch(1)" />
\r
730 <xref linkend="git-mergetool(1)" />
\r
734 Run merge conflict resolution tools to resolve merge conflicts.
\r
740 <xref linkend="git-pack-refs(1)" />
\r
744 Pack heads and tags for efficient repository access.
\r
750 <xref linkend="git-prune(1)" />
\r
754 Prune all unreachable objects from the object database.
\r
760 <xref linkend="git-reflog(1)" />
\r
764 Manage reflog information.
\r
770 <xref linkend="git-relink(1)" />
\r
774 Hardlink common objects in local repositories.
\r
780 <xref linkend="git-remote(1)" />
\r
784 Manage set of tracked repositories.
\r
790 <xref linkend="git-repack(1)" />
\r
794 Pack unpacked objects in a repository.
\r
800 <xref linkend="git-replace(1)" />
\r
804 Create, list, delete refs to replace objects.
\r
809 <simpara>Interrogators:</simpara>
\r
813 <xref linkend="git-annotate(1)" />
\r
817 Annotate file lines with commit information.
\r
823 <xref linkend="git-blame(1)" />
\r
827 Show what revision and author last modified each line of a file.
\r
833 <xref linkend="git-cherry(1)" />
\r
837 Find commits yet to be applied to upstream.
\r
843 <xref linkend="git-count-objects(1)" />
\r
847 Count unpacked number of objects and their disk consumption.
\r
853 <xref linkend="git-difftool(1)" />
\r
857 Show changes using common diff tools.
\r
863 <xref linkend="git-fsck(1)" />
\r
867 Verifies the connectivity and validity of the objects in the database.
\r
873 <xref linkend="git-get-tar-commit-id(1)" />
\r
877 Extract commit ID from an archive created using git-archive.
\r
883 <xref linkend="git-help(1)" />
\r
887 Display help information about Git.
\r
893 <xref linkend="git-instaweb(1)" />
\r
897 Instantly browse your working repository in gitweb.
\r
903 <xref linkend="git-merge-tree(1)" />
\r
907 Show three-way merge without touching index.
\r
913 <xref linkend="git-rerere(1)" />
\r
917 Reuse recorded resolution of conflicted merges.
\r
923 <xref linkend="git-rev-parse(1)" />
\r
927 Pick out and massage parameters.
\r
933 <xref linkend="git-show-branch(1)" />
\r
937 Show branches and their commits.
\r
943 <xref linkend="git-verify-commit(1)" />
\r
947 Check the GPG signature of commits.
\r
953 <xref linkend="git-verify-tag(1)" />
\r
957 Check the GPG signature of tags.
\r
963 <xref linkend="git-whatchanged(1)" />
\r
967 Show logs with difference each commit introduces.
\r
973 <xref linkend="gitweb(1)" />
\r
977 Git web interface (web frontend to Git repositories).
\r
983 <section id="git(1)__interacting_with_others">
\r
984 <title>Interacting with Others</title>
\r
985 <simpara>These commands are to interact with foreign SCM and with other
\r
986 people via patch over e-mail.</simpara>
\r
990 <xref linkend="git-archimport(1)" />
\r
994 Import an Arch repository into Git.
\r
1000 <xref linkend="git-cvsexportcommit(1)" />
\r
1004 Export a single commit to a CVS checkout.
\r
1010 <xref linkend="git-cvsimport(1)" />
\r
1014 Salvage your data out of another SCM people love to hate.
\r
1020 <xref linkend="git-cvsserver(1)" />
\r
1024 A CVS server emulator for Git.
\r
1030 <xref linkend="git-imap-send(1)" />
\r
1034 Send a collection of patches from stdin to an IMAP folder.
\r
1040 <xref linkend="git-p4(1)" />
\r
1044 Import from and submit to Perforce repositories.
\r
1050 <xref linkend="git-quiltimport(1)" />
\r
1054 Applies a quilt patchset onto the current branch.
\r
1060 <xref linkend="git-request-pull(1)" />
\r
1064 Generates a summary of pending changes.
\r
1070 <xref linkend="git-send-email(1)" />
\r
1074 Send a collection of patches as emails.
\r
1080 <xref linkend="git-svn(1)" />
\r
1084 Bidirectional operation between a Subversion repository and Git.
\r
1091 <simplesect id="git(1)__low_level_commands_plumbing">
\r
1092 <title>Low-level commands (plumbing)</title>
\r
1093 <simpara>Although Git includes its
\r
1094 own porcelain layer, its low-level commands are sufficient to support
\r
1095 development of alternative porcelains. Developers of such porcelains
\r
1096 might start by reading about <xref linkend="git-update-index(1)" /> and
\r
1097 <xref linkend="git-read-tree(1)" />.</simpara>
\r
1098 <simpara>The interface (input, output, set of options and the semantics)
\r
1099 to these low-level commands are meant to be a lot more stable
\r
1100 than Porcelain level commands, because these commands are
\r
1101 primarily for scripted use. The interface to Porcelain commands
\r
1102 on the other hand are subject to change in order to improve the
\r
1103 end user experience.</simpara>
\r
1104 <simpara>The following description divides
\r
1105 the low-level commands into commands that manipulate objects (in
\r
1106 the repository, index, and working tree), commands that interrogate and
\r
1107 compare objects, and commands that move objects and references between
\r
1108 repositories.</simpara>
\r
1109 <section id="git(1)__manipulation_commands">
\r
1110 <title>Manipulation commands</title>
\r
1114 <xref linkend="git-apply(1)" />
\r
1118 Apply a patch to files and/or to the index.
\r
1124 <xref linkend="git-checkout-index(1)" />
\r
1128 Copy files from the index to the working tree.
\r
1134 <xref linkend="git-commit-tree(1)" />
\r
1138 Create a new commit object.
\r
1144 <xref linkend="git-hash-object(1)" />
\r
1148 Compute object ID and optionally creates a blob from a file.
\r
1154 <xref linkend="git-index-pack(1)" />
\r
1158 Build pack index file for an existing packed archive.
\r
1164 <xref linkend="git-merge-file(1)" />
\r
1168 Run a three-way file merge.
\r
1174 <xref linkend="git-merge-index(1)" />
\r
1178 Run a merge for files needing merging.
\r
1184 <xref linkend="git-mktag(1)" />
\r
1188 Creates a tag object.
\r
1194 <xref linkend="git-mktree(1)" />
\r
1198 Build a tree-object from ls-tree formatted text.
\r
1204 <xref linkend="git-pack-objects(1)" />
\r
1208 Create a packed archive of objects.
\r
1214 <xref linkend="git-prune-packed(1)" />
\r
1218 Remove extra objects that are already in pack files.
\r
1224 <xref linkend="git-read-tree(1)" />
\r
1228 Reads tree information into the index.
\r
1234 <xref linkend="git-symbolic-ref(1)" />
\r
1238 Read, modify and delete symbolic refs.
\r
1244 <xref linkend="git-unpack-objects(1)" />
\r
1248 Unpack objects from a packed archive.
\r
1254 <xref linkend="git-update-index(1)" />
\r
1258 Register file contents in the working tree to the index.
\r
1264 <xref linkend="git-update-ref(1)" />
\r
1268 Update the object name stored in a ref safely.
\r
1274 <xref linkend="git-write-tree(1)" />
\r
1278 Create a tree object from the current index.
\r
1284 <section id="git(1)__interrogation_commands">
\r
1285 <title>Interrogation commands</title>
\r
1289 <xref linkend="git-cat-file(1)" />
\r
1293 Provide content or type and size information for repository objects.
\r
1299 <xref linkend="git-diff-files(1)" />
\r
1303 Compares files in the working tree and the index.
\r
1309 <xref linkend="git-diff-index(1)" />
\r
1313 Compare a tree to the working tree or index.
\r
1319 <xref linkend="git-diff-tree(1)" />
\r
1323 Compares the content and mode of blobs found via two tree objects.
\r
1329 <xref linkend="git-for-each-ref(1)" />
\r
1333 Output information on each ref.
\r
1339 <xref linkend="git-ls-files(1)" />
\r
1343 Show information about files in the index and the working tree.
\r
1349 <xref linkend="git-ls-remote(1)" />
\r
1353 List references in a remote repository.
\r
1359 <xref linkend="git-ls-tree(1)" />
\r
1363 List the contents of a tree object.
\r
1369 <xref linkend="git-merge-base(1)" />
\r
1373 Find as good common ancestors as possible for a merge.
\r
1379 <xref linkend="git-name-rev(1)" />
\r
1383 Find symbolic names for given revs.
\r
1389 <xref linkend="git-pack-redundant(1)" />
\r
1393 Find redundant pack files.
\r
1399 <xref linkend="git-rev-list(1)" />
\r
1403 Lists commit objects in reverse chronological order.
\r
1409 <xref linkend="git-show-index(1)" />
\r
1413 Show packed archive index.
\r
1419 <xref linkend="git-show-ref(1)" />
\r
1423 List references in a local repository.
\r
1429 <xref linkend="git-unpack-file(1)" />
\r
1433 Creates a temporary file with a blob's contents.
\r
1439 <xref linkend="git-var(1)" />
\r
1443 Show a Git logical variable.
\r
1449 <xref linkend="git-verify-pack(1)" />
\r
1453 Validate packed Git archive files.
\r
1458 <simpara>In general, the interrogate commands do not touch the files in
\r
1459 the working tree.</simpara>
\r
1461 <section id="git(1)__synching_repositories">
\r
1462 <title>Synching repositories</title>
\r
1466 <xref linkend="git-daemon(1)" />
\r
1470 A really simple server for Git repositories.
\r
1476 <xref linkend="git-fetch-pack(1)" />
\r
1480 Receive missing objects from another repository.
\r
1486 <xref linkend="git-http-backend(1)" />
\r
1490 Server side implementation of Git over HTTP.
\r
1496 <xref linkend="git-send-pack(1)" />
\r
1500 Push objects over Git protocol to another repository.
\r
1506 <xref linkend="git-update-server-info(1)" />
\r
1510 Update auxiliary info file to help dumb servers.
\r
1515 <simpara>The following are helper commands used by the above; end users
\r
1516 typically do not use them directly.</simpara>
\r
1520 <xref linkend="git-http-fetch(1)" />
\r
1524 Download from a remote Git repository via HTTP.
\r
1530 <xref linkend="git-http-push(1)" />
\r
1534 Push objects over HTTP/DAV to another repository.
\r
1540 <xref linkend="git-parse-remote(1)" />
\r
1544 Routines to help parsing remote repository access parameters.
\r
1550 <xref linkend="git-receive-pack(1)" />
\r
1554 Receive what is pushed into the repository.
\r
1560 <xref linkend="git-shell(1)" />
\r
1564 Restricted login shell for Git-only SSH access.
\r
1570 <xref linkend="git-upload-archive(1)" />
\r
1574 Send archive back to git-archive.
\r
1580 <xref linkend="git-upload-pack(1)" />
\r
1584 Send objects packed back to git-fetch-pack.
\r
1590 <section id="git(1)__internal_helper_commands">
\r
1591 <title>Internal helper commands</title>
\r
1592 <simpara>These are internal helper commands used by other commands; end
\r
1593 users typically do not use them directly.</simpara>
\r
1597 <xref linkend="git-check-attr(1)" />
\r
1601 Display gitattributes information.
\r
1607 <xref linkend="git-check-ignore(1)" />
\r
1611 Debug gitignore / exclude files.
\r
1617 <xref linkend="git-check-mailmap(1)" />
\r
1621 Show canonical names and email addresses of contacts.
\r
1627 <xref linkend="git-check-ref-format(1)" />
\r
1631 Ensures that a reference name is well formed.
\r
1637 <xref linkend="git-column(1)" />
\r
1641 Display data in columns.
\r
1647 <xref linkend="git-credential(1)" />
\r
1651 Retrieve and store user credentials.
\r
1657 <xref linkend="git-credential-cache(1)" />
\r
1661 Helper to temporarily store passwords in memory.
\r
1667 <xref linkend="git-credential-store(1)" />
\r
1671 Helper to store credentials on disk.
\r
1677 <xref linkend="git-fmt-merge-msg(1)" />
\r
1681 Produce a merge commit message.
\r
1687 <xref linkend="git-interpret-trailers(1)" />
\r
1691 help add structured information into commit messages.
\r
1697 <xref linkend="git-mailinfo(1)" />
\r
1701 Extracts patch and authorship from a single e-mail message.
\r
1707 <xref linkend="git-mailsplit(1)" />
\r
1711 Simple UNIX mbox splitter program.
\r
1717 <xref linkend="git-merge-one-file(1)" />
\r
1721 The standard helper program to use with git-merge-index.
\r
1727 <xref linkend="git-patch-id(1)" />
\r
1731 Compute unique ID for a patch.
\r
1737 <xref linkend="git-sh-i18n(1)" />
\r
1741 Git's i18n setup code for shell scripts.
\r
1747 <xref linkend="git-sh-setup(1)" />
\r
1751 Common Git shell script setup code.
\r
1757 <xref linkend="git-stripspace(1)" />
\r
1761 Remove unnecessary whitespace.
\r
1768 <simplesect id="git(1)__configuration_mechanism">
\r
1769 <title>Configuration Mechanism</title>
\r
1770 <simpara>Git uses a simple text format to store customizations that are per
\r
1771 repository and are per user. Such a configuration file may look
\r
1772 like this:</simpara>
\r
1774 # A '#' or ';' character indicates a comment.
\r
1779 ; Don't trust file modes
\r
1784 name = "Junio C Hamano"
\r
1785 email = "gitster@pobox.com"</screen>
\r
1786 <simpara>Various commands read from the configuration file and adjust
\r
1787 their operation accordingly. See <xref linkend="git-config(1)" /> for a
\r
1788 list and more details about the configuration mechanism.</simpara>
\r
1790 <simplesect id="git(1)__identifier_terminology">
\r
1791 <title>Identifier Terminology</title>
\r
1799 Indicates the object name for any type of object.
\r
1809 Indicates a blob object name.
\r
1819 Indicates a tree object name.
\r
1829 Indicates a commit object name.
\r
1839 Indicates a tree, commit or tag object name. A
\r
1840 command that takes a <tree-ish> argument ultimately wants to
\r
1841 operate on a <tree> object but automatically dereferences
\r
1842 <commit> and <tag> objects that point at a <tree>.
\r
1848 <commit-ish>
\r
1852 Indicates a commit or tag object name. A
\r
1853 command that takes a <commit-ish> argument ultimately wants to
\r
1854 operate on a <commit> object but automatically dereferences
\r
1855 <tag> objects that point at a <commit>.
\r
1865 Indicates that an object type is required.
\r
1866 Currently one of: <emphasis>blob</emphasis>, <emphasis>tree</emphasis>, <emphasis>commit</emphasis>, or <emphasis>tag</emphasis>.
\r
1876 Indicates a filename - almost always relative to the
\r
1877 root of the tree structure <emphasis>GIT_INDEX_FILE</emphasis> describes.
\r
1883 <simplesect id="git(1)__symbolic_identifiers">
\r
1884 <title>Symbolic Identifiers</title>
\r
1885 <simpara>Any Git command accepting any <object> can also use the following
\r
1886 symbolic notation:</simpara>
\r
1894 indicates the head of the current branch.
\r
1904 a valid tag <emphasis>name</emphasis>
\r
1905 (i.e. a <emphasis>refs/tags/<tag></emphasis> reference).
\r
1915 a valid head <emphasis>name</emphasis>
\r
1916 (i.e. a <emphasis>refs/heads/<head></emphasis> reference).
\r
1921 <simpara>For a more complete list of ways to spell object names, see
\r
1922 "SPECIFYING REVISIONS" section in <xref linkend="gitrevisions(7)" />.</simpara>
\r
1924 <simplesect id="git(1)__file_directory_structure">
\r
1925 <title>File/Directory Structure</title>
\r
1926 <simpara>Please see the <xref linkend="gitrepository-layout(5)" /> document.</simpara>
\r
1927 <simpara>Read <xref linkend="githooks(5)" /> for more details about each hook.</simpara>
\r
1928 <simpara>Higher level SCMs may provide and manage additional information in the
\r
1929 <emphasis>$GIT_DIR</emphasis>.</simpara>
\r
1931 <simplesect id="git(1)__terminology">
\r
1932 <title>Terminology</title>
\r
1933 <simpara>Please see <xref linkend="gitglossary(7)" />.</simpara>
\r
1935 <simplesect id="git(1)__environment_variables">
\r
1936 <title>Environment Variables</title>
\r
1937 <simpara>Various Git commands use the following environment variables:</simpara>
\r
1938 <section id="git(1)__the_git_repository">
\r
1939 <title>The Git Repository</title>
\r
1940 <simpara>These environment variables apply to <emphasis>all</emphasis> core Git commands. Nb: it
\r
1941 is worth noting that they may be used/overridden by SCMS sitting above
\r
1942 Git so take care if using a foreign front-end.</simpara>
\r
1946 <emphasis>GIT_INDEX_FILE</emphasis>
\r
1950 This environment allows the specification of an alternate
\r
1951 index file. If not specified, the default of <emphasis>$GIT_DIR/index</emphasis>
\r
1958 <emphasis>GIT_INDEX_VERSION</emphasis>
\r
1962 This environment variable allows the specification of an index
\r
1963 version for new repositories. It won't affect existing index
\r
1964 files. By default index file version 2 or 3 is used. See
\r
1965 <xref linkend="git-update-index(1)" /> for more information.
\r
1971 <emphasis>GIT_OBJECT_DIRECTORY</emphasis>
\r
1975 If the object storage directory is specified via this
\r
1976 environment variable then the sha1 directories are created
\r
1977 underneath - otherwise the default <emphasis>$GIT_DIR/objects</emphasis>
\r
1978 directory is used.
\r
1984 <emphasis>GIT_ALTERNATE_OBJECT_DIRECTORIES</emphasis>
\r
1988 Due to the immutable nature of Git objects, old objects can be
\r
1989 archived into shared, read-only directories. This variable
\r
1990 specifies a ":" separated (on Windows ";" separated) list
\r
1991 of Git object directories which can be used to search for Git
\r
1992 objects. New objects will not be written to these directories.
\r
1998 <emphasis>GIT_DIR</emphasis>
\r
2002 If the <emphasis>GIT_DIR</emphasis> environment variable is set then it
\r
2003 specifies a path to use instead of the default <emphasis>.git</emphasis>
\r
2004 for the base of the repository.
\r
2005 The <emphasis>--git-dir</emphasis> command-line option also sets this value.
\r
2011 <emphasis>GIT_WORK_TREE</emphasis>
\r
2015 Set the path to the root of the working tree.
\r
2016 This can also be controlled by the <emphasis>--work-tree</emphasis> command-line
\r
2017 option and the core.worktree configuration variable.
\r
2023 <emphasis>GIT_NAMESPACE</emphasis>
\r
2027 Set the Git namespace; see <xref linkend="gitnamespaces(7)" /> for details.
\r
2028 The <emphasis>--namespace</emphasis> command-line option also sets this value.
\r
2034 <emphasis>GIT_CEILING_DIRECTORIES</emphasis>
\r
2038 This should be a colon-separated list of absolute paths. If
\r
2039 set, it is a list of directories that Git should not chdir up
\r
2040 into while looking for a repository directory (useful for
\r
2041 excluding slow-loading network directories). It will not
\r
2042 exclude the current working directory or a GIT_DIR set on the
\r
2043 command line or in the environment. Normally, Git has to read
\r
2044 the entries in this list and resolve any symlink that
\r
2045 might be present in order to compare them with the current
\r
2046 directory. However, if even this access is slow, you
\r
2047 can add an empty entry to the list to tell Git that the
\r
2048 subsequent entries are not symlinks and needn't be resolved;
\r
2050 <emphasis>GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink</emphasis>.
\r
2056 <emphasis>GIT_DISCOVERY_ACROSS_FILESYSTEM</emphasis>
\r
2060 When run in a directory that does not have ".git" repository
\r
2061 directory, Git tries to find such a directory in the parent
\r
2062 directories to find the top of the working tree, but by default it
\r
2063 does not cross filesystem boundaries. This environment variable
\r
2064 can be set to true to tell Git not to stop at filesystem
\r
2065 boundaries. Like <emphasis>GIT_CEILING_DIRECTORIES</emphasis>, this will not affect
\r
2066 an explicit repository directory set via <emphasis>GIT_DIR</emphasis> or on the
\r
2073 <emphasis>GIT_COMMON_DIR</emphasis>
\r
2077 If this variable is set to a path, non-worktree files that are
\r
2078 normally in $GIT_DIR will be taken from this path
\r
2079 instead. Worktree-specific files such as HEAD or index are
\r
2080 taken from $GIT_DIR. See <xref linkend="gitrepository-layout(5)" /> and
\r
2081 <xref linkend="git-worktree(1)" /> for
\r
2082 details. This variable has lower precedence than other path
\r
2083 variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY…
\r
2089 <section id="git(1)__git_commits">
\r
2090 <title>Git Commits</title>
\r
2094 <emphasis>GIT_AUTHOR_NAME</emphasis>
\r
2097 <emphasis>GIT_AUTHOR_EMAIL</emphasis>
\r
2100 <emphasis>GIT_AUTHOR_DATE</emphasis>
\r
2103 <emphasis>GIT_COMMITTER_NAME</emphasis>
\r
2106 <emphasis>GIT_COMMITTER_EMAIL</emphasis>
\r
2109 <emphasis>GIT_COMMITTER_DATE</emphasis>
\r
2112 <emphasis>EMAIL</emphasis>
\r
2116 see <xref linkend="git-commit-tree(1)" />
\r
2122 <section id="git(1)__git_diffs">
\r
2123 <title>Git Diffs</title>
\r
2127 <emphasis>GIT_DIFF_OPTS</emphasis>
\r
2131 Only valid setting is "--unified=??" or "-u??" to set the
\r
2132 number of context lines shown when a unified diff is created.
\r
2133 This takes precedence over any "-U" or "--unified" option
\r
2134 value passed on the Git diff command line.
\r
2140 <emphasis>GIT_EXTERNAL_DIFF</emphasis>
\r
2144 When the environment variable <emphasis>GIT_EXTERNAL_DIFF</emphasis> is set, the
\r
2145 program named by it is called, instead of the diff invocation
\r
2146 described above. For a path that is added, removed, or modified,
\r
2147 <emphasis>GIT_EXTERNAL_DIFF</emphasis> is called with 7 parameters:
\r
2149 <literallayout class="monospaced">path old-file old-hex old-mode new-file new-hex new-mode</literallayout>
\r
2150 <simpara>where:</simpara>
\r
2155 <old|new>-file
\r
2159 are files GIT_EXTERNAL_DIFF can use to read the
\r
2160 contents of <old|new>,
\r
2166 <old|new>-hex
\r
2170 are the 40-hexdigit SHA-1 hashes,
\r
2176 <old|new>-mode
\r
2180 are the octal representation of the file modes.
\r
2182 <simpara>The file parameters can point at the user's working file
\r
2183 (e.g. <emphasis>new-file</emphasis> in "git-diff-files"), <emphasis>/dev/null</emphasis> (e.g. <emphasis>old-file</emphasis>
\r
2184 when a new file is added), or a temporary file (e.g. <emphasis>old-file</emphasis> in the
\r
2185 index). <emphasis>GIT_EXTERNAL_DIFF</emphasis> should not worry about unlinking the
\r
2186 temporary file --- it is removed when <emphasis>GIT_EXTERNAL_DIFF</emphasis> exits.</simpara>
\r
2187 <simpara>For a path that is unmerged, <emphasis>GIT_EXTERNAL_DIFF</emphasis> is called with 1
\r
2188 parameter, <path>.</simpara>
\r
2189 <simpara>For each path <emphasis>GIT_EXTERNAL_DIFF</emphasis> is called, two environment variables,
\r
2190 <emphasis>GIT_DIFF_PATH_COUNTER</emphasis> and <emphasis>GIT_DIFF_PATH_TOTAL</emphasis> are set.</simpara>
\r
2195 <emphasis>GIT_DIFF_PATH_COUNTER</emphasis>
\r
2199 A 1-based counter incremented by one for every path.
\r
2205 <emphasis>GIT_DIFF_PATH_TOTAL</emphasis>
\r
2209 The total number of paths.
\r
2215 <section id="git(1)__other">
\r
2216 <title>other</title>
\r
2220 <emphasis>GIT_MERGE_VERBOSITY</emphasis>
\r
2224 A number controlling the amount of output shown by
\r
2225 the recursive merge strategy. Overrides merge.verbosity.
\r
2226 See <xref linkend="git-merge(1)" />
\r
2232 <emphasis>GIT_PAGER</emphasis>
\r
2236 This environment variable overrides <emphasis>$PAGER</emphasis>. If it is set
\r
2237 to an empty string or to the value "cat", Git will not launch
\r
2238 a pager. See also the <emphasis>core.pager</emphasis> option in
\r
2239 <xref linkend="git-config(1)" />.
\r
2245 <emphasis>GIT_EDITOR</emphasis>
\r
2249 This environment variable overrides <emphasis>$EDITOR</emphasis> and <emphasis>$VISUAL</emphasis>.
\r
2250 It is used by several Git commands when, on interactive mode,
\r
2251 an editor is to be launched. See also <xref linkend="git-var(1)" />
\r
2252 and the <emphasis>core.editor</emphasis> option in <xref linkend="git-config(1)" />.
\r
2258 <emphasis>GIT_SSH</emphasis>
\r
2261 <emphasis>GIT_SSH_COMMAND</emphasis>
\r
2265 If either of these environment variables is set then <emphasis>git fetch</emphasis>
\r
2266 and <emphasis>git push</emphasis> will use the specified command instead of <emphasis>ssh</emphasis>
\r
2267 when they need to connect to a remote system.
\r
2268 The command will be given exactly two or four arguments: the
\r
2269 <emphasis>username@host</emphasis> (or just <emphasis>host</emphasis>) from the URL and the shell
\r
2270 command to execute on that remote system, optionally preceded by
\r
2271 <emphasis>-p</emphasis> (literally) and the <emphasis>port</emphasis> from the URL when it specifies
\r
2272 something other than the default SSH port.
\r
2274 <simpara><emphasis>$GIT_SSH_COMMAND</emphasis> takes precedence over <emphasis>$GIT_SSH</emphasis>, and is interpreted
\r
2275 by the shell, which allows additional arguments to be included.
\r
2276 <emphasis>$GIT_SSH</emphasis> on the other hand must be just the path to a program
\r
2277 (which can be a wrapper shell script, if additional arguments are
\r
2278 needed).</simpara>
\r
2279 <simpara>Usually it is easier to configure any desired options through your
\r
2280 personal <emphasis>.ssh/config</emphasis> file. Please consult your ssh documentation
\r
2281 for further details.</simpara>
\r
2286 <emphasis>GIT_ASKPASS</emphasis>
\r
2290 If this environment variable is set, then Git commands which need to
\r
2291 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
\r
2292 will call this program with a suitable prompt as command-line argument
\r
2293 and read the password from its STDOUT. See also the <emphasis>core.askPass</emphasis>
\r
2294 option in <xref linkend="git-config(1)" />.
\r
2300 <emphasis>GIT_TERMINAL_PROMPT</emphasis>
\r
2304 If this environment variable is set to <emphasis>0</emphasis>, git will not prompt
\r
2305 on the terminal (e.g., when asking for HTTP authentication).
\r
2311 <emphasis>GIT_CONFIG_NOSYSTEM</emphasis>
\r
2315 Whether to skip reading settings from the system-wide
\r
2316 <emphasis>$(prefix)/etc/gitconfig</emphasis> file. This environment variable can
\r
2317 be used along with <emphasis>$HOME</emphasis> and <emphasis>$XDG_CONFIG_HOME</emphasis> to create a
\r
2318 predictable environment for a picky script, or you can set it
\r
2319 temporarily to avoid using a buggy <emphasis>/etc/gitconfig</emphasis> file while
\r
2320 waiting for someone with sufficient permissions to fix it.
\r
2326 <emphasis>GIT_FLUSH</emphasis>
\r
2330 If this environment variable is set to "1", then commands such
\r
2331 as <emphasis>git blame</emphasis> (in incremental mode), <emphasis>git rev-list</emphasis>, <emphasis>git log</emphasis>,
\r
2332 <emphasis>git check-attr</emphasis> and <emphasis>git check-ignore</emphasis> will
\r
2333 force a flush of the output stream after each record have been
\r
2335 variable is set to "0", the output of these commands will be done
\r
2336 using completely buffered I/O. If this environment variable is
\r
2337 not set, Git will choose buffered or record-oriented flushing
\r
2338 based on whether stdout appears to be redirected to a file or not.
\r
2344 <emphasis>GIT_TRACE</emphasis>
\r
2348 Enables general trace messages, e.g. alias expansion, built-in
\r
2349 command execution and external command execution.
\r
2351 <simpara>If this variable is set to "1", "2" or "true" (comparison
\r
2352 is case insensitive), trace messages will be printed to
\r
2354 <simpara>If the variable is set to an integer value greater than 2
\r
2355 and lower than 10 (strictly) then Git will interpret this
\r
2356 value as an open file descriptor and will try to write the
\r
2357 trace messages into this file descriptor.</simpara>
\r
2358 <simpara>Alternatively, if the variable is set to an absolute path
\r
2359 (starting with a <emphasis>/</emphasis> character), Git will interpret this
\r
2360 as a file path and will try to write the trace messages
\r
2361 into it.</simpara>
\r
2362 <simpara>Unsetting the variable, or setting it to empty, "0" or
\r
2363 "false" (case insensitive) disables trace messages.</simpara>
\r
2368 <emphasis>GIT_TRACE_PACK_ACCESS</emphasis>
\r
2372 Enables trace messages for all accesses to any packs. For each
\r
2373 access, the pack file name and an offset in the pack is
\r
2374 recorded. This may be helpful for troubleshooting some
\r
2375 pack-related performance problems.
\r
2376 See <emphasis>GIT_TRACE</emphasis> for available trace output options.
\r
2382 <emphasis>GIT_TRACE_PACKET</emphasis>
\r
2386 Enables trace messages for all packets coming in or out of a
\r
2387 given program. This can help with debugging object negotiation
\r
2388 or other protocol issues. Tracing is turned off at a packet
\r
2389 starting with "PACK" (but see <emphasis>GIT_TRACE_PACKFILE</emphasis> below).
\r
2390 See <emphasis>GIT_TRACE</emphasis> for available trace output options.
\r
2396 <emphasis>GIT_TRACE_PACKFILE</emphasis>
\r
2400 Enables tracing of packfiles sent or received by a
\r
2401 given program. Unlike other trace output, this trace is
\r
2402 verbatim: no headers, and no quoting of binary data. You almost
\r
2403 certainly want to direct into a file (e.g.,
\r
2404 <emphasis>GIT_TRACE_PACKFILE=/tmp/my.pack</emphasis>) rather than displaying it on
\r
2405 the terminal or mixing it with other trace output.
\r
2407 <simpara>Note that this is currently only implemented for the client side
\r
2408 of clones and fetches.</simpara>
\r
2413 <emphasis>GIT_TRACE_PERFORMANCE</emphasis>
\r
2417 Enables performance related trace messages, e.g. total execution
\r
2418 time of each Git command.
\r
2419 See <emphasis>GIT_TRACE</emphasis> for available trace output options.
\r
2425 <emphasis>GIT_TRACE_SETUP</emphasis>
\r
2429 Enables trace messages printing the .git, working tree and current
\r
2430 working directory after Git has completed its setup phase.
\r
2431 See <emphasis>GIT_TRACE</emphasis> for available trace output options.
\r
2437 <emphasis>GIT_TRACE_SHALLOW</emphasis>
\r
2441 Enables trace messages that can help debugging fetching /
\r
2442 cloning of shallow repositories.
\r
2443 See <emphasis>GIT_TRACE</emphasis> for available trace output options.
\r
2449 <emphasis>GIT_LITERAL_PATHSPECS</emphasis>
\r
2453 Setting this variable to <emphasis>1</emphasis> will cause Git to treat all
\r
2454 pathspecs literally, rather than as glob patterns. For example,
\r
2455 running <emphasis>GIT_LITERAL_PATHSPECS=1 git log -- '*.c'</emphasis> will search
\r
2456 for commits that touch the path <emphasis>*.c</emphasis>, not any paths that the
\r
2457 glob <emphasis>*.c</emphasis> matches. You might want this if you are feeding
\r
2458 literal paths to Git (e.g., paths previously given to you by
\r
2459 <emphasis>git ls-tree</emphasis>, <emphasis>--raw</emphasis> diff output, etc).
\r
2465 <emphasis>GIT_GLOB_PATHSPECS</emphasis>
\r
2469 Setting this variable to <emphasis>1</emphasis> will cause Git to treat all
\r
2470 pathspecs as glob patterns (aka "glob" magic).
\r
2476 <emphasis>GIT_NOGLOB_PATHSPECS</emphasis>
\r
2480 Setting this variable to <emphasis>1</emphasis> will cause Git to treat all
\r
2481 pathspecs as literal (aka "literal" magic).
\r
2487 <emphasis>GIT_ICASE_PATHSPECS</emphasis>
\r
2491 Setting this variable to <emphasis>1</emphasis> will cause Git to treat all
\r
2492 pathspecs as case-insensitive.
\r
2498 <emphasis>GIT_REFLOG_ACTION</emphasis>
\r
2502 When a ref is updated, reflog entries are created to keep
\r
2503 track of the reason why the ref was updated (which is
\r
2504 typically the name of the high-level command that updated
\r
2505 the ref), in addition to the old and new values of the ref.
\r
2506 A scripted Porcelain command can use set_reflog_action
\r
2507 helper function in <emphasis>git-sh-setup</emphasis> to set its name to this
\r
2508 variable when it is invoked as the top level command by the
\r
2509 end user, to be recorded in the body of the reflog.
\r
2515 <emphasis>GIT_REF_PARANOIA</emphasis>
\r
2519 If set to <emphasis>1</emphasis>, include broken or badly named refs when iterating
\r
2520 over lists of refs. In a normal, non-corrupted repository, this
\r
2521 does nothing. However, enabling it may help git to detect and
\r
2522 abort some operations in the presence of broken refs. Git sets
\r
2523 this variable automatically when performing destructive
\r
2524 operations like <xref linkend="git-prune(1)" />. You should not need to set
\r
2525 it yourself unless you want to be paranoid about making sure
\r
2526 an operation has touched every ref (e.g., because you are
\r
2527 cloning a repository to make a backup).
\r
2533 <emphasis>GIT_ALLOW_PROTOCOL</emphasis>
\r
2537 If set, provide a colon-separated list of protocols which are
\r
2538 allowed to be used with fetch/push/clone. This is useful to
\r
2539 restrict recursive submodule initialization from an untrusted
\r
2540 repository. Any protocol not mentioned will be disallowed (i.e.,
\r
2541 this is a whitelist, not a blacklist). If the variable is not
\r
2542 set at all, all protocols are enabled. The protocol names
\r
2543 currently used by git are:
\r
2548 <emphasis>file</emphasis>: any local file-based path (including <emphasis>file://</emphasis> URLs,
\r
2554 <emphasis>git</emphasis>: the anonymous git protocol over a direct TCP
\r
2555 connection (or proxy, if configured)
\r
2560 <emphasis>ssh</emphasis>: git over ssh (including <emphasis>host:path</emphasis> syntax,
\r
2561 <emphasis>ssh://</emphasis>, etc).
\r
2566 <emphasis>http</emphasis>: git over http, both "smart http" and "dumb http".
\r
2567 Note that this does <emphasis>not</emphasis> include <emphasis>https</emphasis>; if you want both,
\r
2568 you should specify both as <emphasis>http:https</emphasis>.
\r
2573 any external helpers are named by their protocol (e.g., use
\r
2574 <emphasis>hg</emphasis> to allow the <emphasis>git-remote-hg</emphasis> helper)
\r
2583 <simplesect id="git(1)__discussion_anchor_id_git_1__discussion_xreflabel_discussion">
\r
2584 <title>Discussion<anchor id="git(1)_Discussion" xreflabel="[Discussion]"/></title>
\r
2585 <simpara>More detail on the following is available from the
\r
2586 <ulink url="https://www.kernel.org/pub/software/scm/git/docs/user-manual.html#git-concepts"><citetitle>Git concepts chapter of the
\r
2587 user-manual</citetitle></ulink> and <xref linkend="gitcore-tutorial(7)" />.</simpara>
\r
2588 <simpara>A Git project normally consists of a working directory with a ".git"
\r
2589 subdirectory at the top level. The .git directory contains, among other
\r
2590 things, a compressed object database representing the complete history
\r
2591 of the project, an "index" file which links that history to the current
\r
2592 contents of the working tree, and named pointers into that history such
\r
2593 as tags and branch heads.</simpara>
\r
2594 <simpara>The object database contains objects of three main types: blobs, which
\r
2595 hold file data; trees, which point to blobs and other trees to build up
\r
2596 directory hierarchies; and commits, which each reference a single tree
\r
2597 and some number of parent commits.</simpara>
\r
2598 <simpara>The commit, equivalent to what other systems call a "changeset" or
\r
2599 "version", represents a step in the project's history, and each parent
\r
2600 represents an immediately preceding step. Commits with more than one
\r
2601 parent represent merges of independent lines of development.</simpara>
\r
2602 <simpara>All objects are named by the SHA-1 hash of their contents, normally
\r
2603 written as a string of 40 hex digits. Such names are globally unique.
\r
2604 The entire history leading up to a commit can be vouched for by signing
\r
2605 just that commit. A fourth object type, the tag, is provided for this
\r
2606 purpose.</simpara>
\r
2607 <simpara>When first created, objects are stored in individual files, but for
\r
2608 efficiency may later be compressed together into "pack files".</simpara>
\r
2609 <simpara>Named pointers called refs mark interesting points in history. A ref
\r
2610 may contain the SHA-1 name of an object or the name of another ref. Refs
\r
2611 with names beginning <emphasis>ref/head/</emphasis> contain the SHA-1 name of the most
\r
2612 recent commit (or "head") of a branch under development. SHA-1 names of
\r
2613 tags of interest are stored under <emphasis>ref/tags/</emphasis>. A special ref named
\r
2614 <emphasis>HEAD</emphasis> contains the name of the currently checked-out branch.</simpara>
\r
2615 <simpara>The index file is initialized with a list of all paths and, for each
\r
2616 path, a blob object and a set of attributes. The blob object represents
\r
2617 the contents of the file as of the head of the current branch. The
\r
2618 attributes (last modified time, size, etc.) are taken from the
\r
2619 corresponding file in the working tree. Subsequent changes to the
\r
2620 working tree can be found by comparing these attributes. The index may
\r
2621 be updated with new content, and new commits may be created from the
\r
2622 content stored in the index.</simpara>
\r
2623 <simpara>The index is also capable of storing multiple entries (called "stages")
\r
2624 for a given pathname. These stages are used to hold the various
\r
2625 unmerged version of a file when a merge is in progress.</simpara>
\r
2627 <simplesect id="git(1)__further_documentation">
\r
2628 <title>FURTHER DOCUMENTATION</title>
\r
2629 <simpara>See the references in the "description" section to get started
\r
2630 using Git. The following is probably more detail than necessary
\r
2631 for a first-time user.</simpara>
\r
2632 <simpara>The <ulink url="https://www.kernel.org/pub/software/scm/git/docs/user-manual.html#git-concepts"><citetitle>Git concepts chapter of the
\r
2633 user-manual</citetitle></ulink> and <xref linkend="gitcore-tutorial(7)" /> both provide
\r
2634 introductions to the underlying Git architecture.</simpara>
\r
2635 <simpara>See <xref linkend="gitworkflows(7)" /> for an overview of recommended workflows.</simpara>
\r
2636 <simpara>See also the <ulink url="https://www.kernel.org/pub/software/scm/git/docs/howto-index.html"><citetitle>howto</citetitle></ulink> documents for some useful
\r
2637 examples.</simpara>
\r
2638 <simpara>The internals are documented in the
\r
2639 <ulink url="https://www.kernel.org/pub/software/scm/git/docs/technical/api-index.html"><citetitle>Git API documentation</citetitle></ulink>.</simpara>
\r
2640 <simpara>Users migrating from CVS may also want to
\r
2641 read <xref linkend="gitcvs-migration(7)" />.</simpara>
\r
2643 <simplesect id="git(1)__authors">
\r
2644 <title>Authors</title>
\r
2645 <simpara>Git was started by Linus Torvalds, and is currently maintained by Junio
\r
2646 C Hamano. Numerous contributions have come from the Git mailing list
\r
2647 <<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>>. <ulink url="http://www.openhub.net/p/git/contributors/summary">http://www.openhub.net/p/git/contributors/summary</ulink>
\r
2648 gives you a more complete list of contributors.</simpara>
\r
2649 <simpara>If you have a clone of git.git itself, the
\r
2650 output of <xref linkend="git-shortlog(1)" /> and <xref linkend="git-blame(1)" /> can show you
\r
2651 the authors for specific parts of the project.</simpara>
\r
2653 <simplesect id="git(1)__reporting_bugs">
\r
2654 <title>Reporting Bugs</title>
\r
2655 <simpara>Report bugs to the Git mailing list <<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>> where the
\r
2656 development and maintenance is primarily done. You do not have to be
\r
2657 subscribed to the list to send a message there.</simpara>
\r
2659 <simplesect id="git(1)__see_also">
\r
2660 <title>SEE ALSO</title>
\r
2661 <simpara><xref linkend="gittutorial(7)" />, <xref linkend="gittutorial-2(7)" />,
\r
2662 <xref linkend="giteveryday(7)" />, <xref linkend="gitcvs-migration(7)" />,
\r
2663 <xref linkend="gitglossary(7)" />, <xref linkend="gitcore-tutorial(7)" />,
\r
2664 <xref linkend="gitcli(7)" />, <ulink url="https://www.kernel.org/pub/software/scm/git/docs/user-manual.html"><citetitle>The Git User's Manual</citetitle></ulink>,
\r
2665 <xref linkend="gitworkflows(7)" /></simpara>
\r
2667 <simplesect id="git(1)__git">
\r
2668 <title>GIT</title>
\r
2669 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>
\r