.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-AM" "1" "01/09/2007" "" ""
+.TH "GIT\-AM" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-am \- Apply a series of patches in a mailbox
+git\-am \- Apply a series of patches from a mailbox
.SH "SYNOPSIS"
.sp
.nf
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-APPLY" "1" "12/26/2006" "" ""
+.TH "GIT\-APPLY" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-apply \- Apply patch on a git index file and a work tree
+git\-apply \- Apply a patch on a git index file and a working tree
.SH "SYNOPSIS"
.sp
.nf
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-ARCHIVE" "1" "10/03/2006" "" ""
+.TH "GIT\-ARCHIVE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-archive \- Creates a archive of the files in the named tree
+git\-archive \- Creates an archive of files from a named tree
.SH "SYNOPSIS"
\fIgit\-archive\fR \-\-format=<fmt> [\-\-list] [\-\-prefix=<prefix>/] [<extra>] [\-\-remote=<repo>] <tree\-ish> [path\&...]
-.sp
.SH "DESCRIPTION"
Creates an archive of the specified format containing the tree structure for the named tree. If <prefix> is specified it is prepended to the filenames in the archive.
-.sp
+
\fIgit\-archive\fR behaves differently when given a tree ID versus when given a commit ID or tag ID. In the first case the current time is used as modification time of each file in the archive. In the latter case the commit time as recorded in the referenced commit object is used instead. Additionally the commit ID is stored in a global extended pax header if the tar format is used; it can be extracted using \fIgit\-get\-tar\-commit\-id\fR. In ZIP files it is stored as a file comment.
-.sp
.SH "OPTIONS"
.TP
\-\-format=<fmt>
-Format of the resulting archive:
-\fItar\fR,
-\fIzip\fR\&...
+Format of the resulting archive: \fItar\fR, \fIzip\fR\&...
.TP
\-\-list
Show all available formats.
.SH "CONFIGURATION"
By default, file and directories modes are set to 0666 or 0777 in tar archives. It is possible to change this by setting the "umask" variable in the repository configuration as follows :
.sp
-.sp
.nf
umask = 002 ;# group friendly
.fi
The special umask value "user" indicates that the user's current umask will be used instead. The default value remains 0, which means world readable/writable files and directories.
-.sp
.SH "EXAMPLES"
.TP
git archive \-\-format=tar \-\-prefix=junk/ HEAD | (cd /var/tmp/ && tar xf \-)
-Create a tar archive that contains the contents of the latest commit on the current branch, and extracts it in
-/var/tmp/junk
-directory.
+Create a tar archive that contains the contents of the latest commit on the current branch, and extracts it in /var/tmp/junk directory.
.TP
git archive \-\-format=tar \-\-prefix=git\-1.4.0/ v1.4.0 | gzip >git\-1.4.0.tar.gz
Create a compressed tarball for v1.4.0 release.
Create a compressed tarball for v1.4.0 release, but without a global extended pax header.
.TP
git archive \-\-format=zip \-\-prefix=git\-docs/ HEAD:Documentation/ > git\-1.4.0\-docs.zip
-Put everything in the current head's Documentation/ directory into
-\fIgit\-1.4.0\-docs.zip\fR, with the prefix
-\fIgit\-docs/\fR.
+Put everything in the current head's Documentation/ directory into \fIgit\-1.4.0\-docs.zip\fR, with the prefix \fIgit\-docs/\fR.
.SH "AUTHOR"
Written by Franck Bui\-Huu and Rene Scharfe.
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-BISECT" "1" "10/03/2006" "" ""
+.TH "GIT\-BISECT" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-bisect \- Find the change that introduced a bug
+git\-bisect \- Find the change that introduced a bug by binary search
.SH "SYNOPSIS"
\fIgit bisect\fR <subcommand> <options>
-.sp
.SH "DESCRIPTION"
The command takes various subcommands, and different options depending on the subcommand:
.sp
-.sp
.nf
git bisect start [<paths>...]
git bisect bad <rev>
git bisect log
.fi
This command uses \fIgit\-rev\-list \-\-bisect\fR option to help drive the binary search process to find which change introduced a bug, given an old "good" commit object name and a later "bad" commit object name.
-.sp
+
The way you use it is:
.sp
-.sp
.nf
$ git bisect start
$ git bisect bad # Current version is bad
.fi
When you give at least one bad and one good versions, it will bisect the revision tree and say something like:
.sp
-.sp
.nf
Bisecting: 675 revisions left to test after this
.fi
and check out the state in the middle. Now, compile that kernel, and boot it. Now, let's say that this booted kernel works fine, then just do
.sp
-.sp
.nf
$ git bisect good # this one is good
.fi
which will now say
.sp
-.sp
.nf
Bisecting: 337 revisions left to test after this
.fi
and you continue along, compiling that one, testing it, and depending on whether it is good or bad, you say "git bisect good" or "git bisect bad", and ask for the next bisection.
-.sp
+
Until you have no more left, and you'll have been left with the first bad kernel rev in "refs/bisect/bad".
-.sp
+
Oh, and then after you want to reset to the original head, do a
.sp
-.sp
.nf
$ git bisect reset
.fi
to get back to the master branch, instead of being in one of the bisection branches ("git bisect start" will do that for you too, actually: it will reset the bisection state, and before it does that it checks that you're not using some old bisection branch).
-.sp
+
During the bisection process, you can say
.sp
-.sp
.nf
$ git bisect visualize
.fi
to see the currently remaining suspects in gitk.
-.sp
+
The good/bad input is logged, and git bisect log shows what you have done so far. You can truncate its output somewhere and save it in a file, and run
.sp
-.sp
.nf
$ git bisect replay that\-file
.fi
if you find later you made a mistake telling good/bad about a revision.
-.sp
+
If in a middle of bisect session, you know what the bisect suggested to try next is not a good one to test (e.g. the change the commit introduces is known not to work in your environment and you know it does not have anything to do with the bug you are chasing), you may want to find a near\-by commit and try that instead. It goes something like this:
.sp
-.sp
.nf
$ git bisect good/bad # previous round was good/bad.
Bisecting: 337 revisions left to test after this
# was suggested
.fi
Then compile and test the one you chose to try. After that, tell bisect what the result was as usual.
-.sp
+
You can further cut down the number of trials if you know what part of the tree is involved in the problem you are tracking down, by giving paths parameters when you say bisect start, like this:
.sp
-.sp
.nf
$ git bisect start arch/i386 include/asm\-i386
.fi
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-BRANCH" "1" "01/17/2007" "" ""
+.TH "GIT\-BRANCH" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-branch \- List, create, or delete branches.
+git\-branch \- List, create, or delete branches
.SH "SYNOPSIS"
.sp
.nf
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-CAT\-FILE" "1" "10/03/2006" "" ""
+.TH "GIT\-CAT\-FILE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-cat\-file \- Provide content or type information for repository objects
+git\-cat\-file \- Provide content or type/size information for repository objects
.SH "SYNOPSIS"
\fIgit\-cat\-file\fR [\-t | \-s | \-e | \-p | <type>] <object>
-.sp
.SH "DESCRIPTION"
Provides content or type of objects in the repository. The type is required unless \fI\-t\fR or \fI\-p\fR is used to find the object type, or \fI\-s\fR is used to find the object size.
-.sp
.SH "OPTIONS"
.TP
<object>
Typically this matches the real type of <object> but asking for a type that can trivially be dereferenced from the given <object> is also permitted. An example is to ask for a "tree" with <object> being a commit object that contains it, or to ask for a "blob" with <object> being a tag object that points at it.
.SH "OUTPUT"
If \fI\-t\fR is specified, one of the <type>.
-.sp
+
If \fI\-s\fR is specified, the size of the <object> in bytes.
-.sp
+
If \fI\-e\fR is specified, no output.
-.sp
+
If \fI\-p\fR is specified, the contents of <object> are pretty\-printed.
-.sp
+
Otherwise the raw (though uncompressed) contents of the <object> will be returned.
-.sp
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-CHECKOUT\-INDEX" "1" "10/03/2006" "" ""
+.TH "GIT\-CHECKOUT\-INDEX" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-checkout\-index \- Copy files from the index to the working directory
+git\-checkout\-index \- Copy files from the index to the working tree
.SH "SYNOPSIS"
.sp
.nf
.fi
.SH "DESCRIPTION"
Will copy all files listed from the index to the working directory (not overwriting existing files).
-.sp
.SH "OPTIONS"
.TP
\-u|\-\-index
Instead of taking list of paths from the command line, read list of paths from the standard input. Paths are separated by LF (i.e. one path per line) by default.
.TP
\-z
-Only meaningful with
-\-\-stdin; paths are separated with NUL character instead of LF.
+Only meaningful with \-\-stdin; paths are separated with NUL character instead of LF.
.TP
\-\-
Do not interpret any more arguments as options.
+
The order of the flags used to matter, but not anymore.
-.sp
+
Just doing git\-checkout\-index does nothing. You probably meant git\-checkout\-index \-a. And if you want to force it, you want git\-checkout\-index \-f \-a.
-.sp
+
Intuitiveness is not the goal here. Repeatability is. The reason for the "no arguments means no work" behavior is that from scripts you are supposed to be able to do:
.sp
-.sp
.nf
$ find . \-name '*.h' \-print0 | xargs \-0 git\-checkout\-index \-f \-\-
.fi
which will force all existing *.h files to be replaced with their cached copies. If an empty command line implied "all", then this would force\-refresh everything in the index, which was not the point. But since git\-checkout\-index accepts \-\-stdin it would be faster to use:
.sp
-.sp
.nf
$ find . \-name '*.h' \-print0 | git\-checkout\-index \-f \-z \-\-stdin
.fi
The \-\- is just a good idea when you know the rest will be filenames; it will prevent problems with a filename of, for example, \-a. Using \-\- is probably a good policy in scripts.
-.sp
.SH "USING \-\-TEMP OR \-\-STAGE=ALL"
When \-\-temp is used (or implied by \-\-stage=all) git\-checkout\-index will create a temporary file for each index entry being checked out. The index will not be updated with stat information. These options can be useful if the caller needs all stages of all unmerged entries so that the unmerged files can be processed by an external merge tool.
-.sp
+
A listing will be written to stdout providing the association of temporary file names to tracked path names. The listing format has two variations:
-.sp
.TP 3
1.
tempname TAB path RS
-.sp
-The first format is what gets used when
-\-\-stage
-is omitted or is not
-\-\-stage=all. The field tempname is the temporary file name holding the file content and path is the tracked path name in the index. Only the requested entries are output.
+
+The first format is what gets used when \-\-stage is omitted or is not \-\-stage=all. The field tempname is the temporary file name holding the file content and path is the tracked path name in the index. Only the requested entries are output.
.TP
2.
stage1temp SP stage2temp SP stage3tmp TAB path RS
-.sp
-The second format is what gets used when
-\-\-stage=all. The three stage temporary fields (stage1temp, stage2temp, stage3temp) list the name of the temporary file if there is a stage entry in the index or
-.
-if there is no stage entry. Paths which only have a stage 0 entry will always be omitted from the output.
+
+The second format is what gets used when \-\-stage=all. The three stage temporary fields (stage1temp, stage2temp, stage3temp) list the name of the temporary file if there is a stage entry in the index or . if there is no stage entry. Paths which only have a stage 0 entry will always be omitted from the output.
+
In both formats RS (the record separator) is newline by default but will be the null byte if \-z was passed on the command line. The temporary file names are always safe strings; they will never contain directory separators or whitespace characters. The path field is always relative to the current directory and the temporary file names are always relative to the top level directory.
-.sp
+
If the object being copied out to a temporary file is a symbolic link the content of the link will be written to a normal file. It is up to the end\-user or the Porcelain to make use of this information.
-.sp
.SH "EXAMPLES"
.TP
To update and refresh only the files already checked out
.fi
.TP
Using git\-checkout\-index to "export an entire tree"
-The prefix ability basically makes it trivial to use
-git\-checkout\-index
-as an "export as tree" function. Just read the desired tree into the index, and do:
+The prefix ability basically makes it trivial to use git\-checkout\-index as an "export as tree" function. Just read the desired tree into the index, and do:
.sp
.nf
$ git\-checkout\-index \-\-prefix=git\-export\-dir/ \-a
.fi
-git\-checkout\-index
-will "export" the index into the specified directory.
-.sp
+git\-checkout\-index will "export" the index into the specified directory.
+
The final "/" is important. The exported name is literally just prefixed with the specified string. Contrast this with the following example.
.TP
Export files with a prefix
.nf
$ git\-checkout\-index \-\-prefix=.merged\- Makefile
.fi
-This will check out the currently cached copy of
-Makefile
-into the file
-.merged\-Makefile.
+This will check out the currently cached copy of Makefile into the file .merged\-Makefile.
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-CLONE" "1" "01/07/2007" "" ""
+.TH "GIT\-CLONE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-clone \- Clones a repository
+git\-clone \- Clones a repository into a new directory
.SH "SYNOPSIS"
.sp
.nf
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-COMMIT\-TREE" "1" "01/17/2007" "" ""
+.TH "GIT\-COMMIT\-TREE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-commit\-tree \- Creates a new commit object
+git\-commit\-tree \- Create a new commit object
.SH "SYNOPSIS"
\fIgit\-commit\-tree\fR <tree> [\-p <parent commit>]* < changelog
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-COMMIT" "1" "01/17/2007" "" ""
+.TH "GIT\-COMMIT" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-commit \- Record your changes
+git\-commit \- Record changes to the repository
.SH "SYNOPSIS"
.sp
.nf
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-COUNT\-OBJECTS" "1" "12/27/2006" "" ""
+.TH "GIT\-COUNT\-OBJECTS" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-count\-objects \- Reports on unpacked objects
+git\-count\-objects \- Count unpacked number of objects and their disk consumption
.SH "SYNOPSIS"
\fIgit\-count\-objects\fR [\-v]
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-CVSEXPORTCOMMIT" "1" "10/03/2006" "" ""
+.TH "GIT\-CVSEXPORTCOMMIT" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-cvsexportcommit \- Export a commit to a CVS checkout
+git\-cvsexportcommit \- Export a single commit to a CVS checkout
.SH "SYNOPSIS"
\fIgit\-cvsexportcommit\fR [\-h] [\-v] [\-c] [\-p] [\-a] [\-f] [\-m msgprefix] [PARENTCOMMIT] COMMITID
-.sp
.SH "DESCRIPTION"
Exports a commit from GIT to a CVS checkout, making it easier to merge patches from a git repository into a CVS repository.
-.sp
+
Execute it from the root of the CVS working copy. GIT_DIR must be defined. See examples below.
-.sp
+
It does its best to do the safe thing, it will check that the files are unchanged and up to date in the CVS checkout, and it will not autocommit by default.
-.sp
+
Supports file additions, removals, and commits that affect binary files.
-.sp
+
If the commit is a merge commit, you must tell git\-cvsapplycommit what parent should the changeset be done against.
-.sp
.SH "OPTIONS"
.TP
\-c
.fi
.SH "AUTHOR"
Written by Martin Langhoff <martin@catalyst.net.nz>
-.sp
.SH "DOCUMENTATION"
Documentation by Martin Langhoff <martin@catalyst.net.nz>
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-CVSIMPORT" "1" "01/17/2007" "" ""
+.TH "GIT\-CVSIMPORT" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-cvsimport \- Import a CVS repository into git
+git\-cvsimport \- Salvage your data out of another SCM people love to hate
.SH "SYNOPSIS"
.sp
.nf
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-DIFF\-STAGES" "1" "12/26/2006" "" ""
+.TH "GIT\-DIFF\-STAGES" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-diff\-stages \- Compares content and mode of blobs between stages in an unmerged index file
+git\-diff\-stages \- Compares two merge stages in the index
.SH "SYNOPSIS"
\fIgit\-diff\-stages\fR [<common diff options>] <stage1> <stage2> [<path>\&...]
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-FETCH" "1" "01/02/2007" "" ""
+.TH "GIT\-FETCH" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-fetch \- Download objects and a head from another repository
+git\-fetch \- Download objects and refs from another repository
.SH "SYNOPSIS"
\fIgit\-fetch\fR <options> <repository> <refspec>\&...
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-FORMAT\-PATCH" "1" "01/18/2007" "" ""
+.TH "GIT\-FORMAT\-PATCH" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
\fIgit\-format\-patch\fR [\-n | \-k] [\-o <dir> | \-\-stdout] [\-\-attach] [\-\-thread]
[\-s | \-\-signoff] [\-\-diff\-options] [\-\-start\-number <n>]
[\-\-in\-reply\-to=Message\-Id] [\-\-suffix=.<sfx>]
+ [\-\-ignore\-if\-in\-upstream]
<since>[..<until>]
.fi
.SH "DESCRIPTION"
\-\-in\-reply\-to=Message\-Id
Make the first mail (or all the mails with \-\-no\-thread) appear as a reply to the given Message\-Id, which avoids breaking threads to provide a new patch series.
.TP
+\-\-ignore\-if\-in\-upstream
+Do not include a patch that matches a commit in <until>..<since>. This will examine all patches reachable from <since> but not from <until> and compare them with the patches being generated, and any patch that matches is ignored.
+.TP
\-\-suffix=.<sfx>
-Instead of using .txt as the suffix for generated filenames, use specifed suffix. A common alternative is \-\-suffix=.patch.
+Instead of using .patch as the suffix for generated filenames, use specifed suffix. A common alternative is \-\-suffix=.txt.
Note that you would need to include the leading dot . if you want a filename like 0001\-description\-of\-my\-change.patch, and the first letter does not have to be a dot. Leaving it empty would not add any suffix.
.SH "CONFIGURATION"
-You can specify extra mail header lines to be added to each message in the repository configuration as follows:
+You can specify extra mail header lines to be added to each message in the repository configuration. Also you can specify the default suffix different from the built\-in one:
.sp
.nf
-headers = "Organization: git\-foo\\n"
-.fi
-You can specify default suffix used:
-.sp
-.nf
-suffix = .patch
+[format]
+ headers = "Organization: git\-foo\\n"
+ suffix = .txt
.fi
.SH "EXAMPLES"
.TP
.TP
git\-format\-patch \-M \-B origin
The same as the previous one. Additionally, it detects and handles renames and complete rewrites intelligently to produce a renaming patch. A renaming patch reduces the amount of text output, and generally makes it easier to review it. Note that the "patch" program does not understand renaming patches, so use it only when you know the recipient uses git to apply your patch.
+.TP
+git\-format\-patch \-3
+Extract three topmost commits from the current branch and format them as e\-mailable patches.
.SH "SEE ALSO"
\fBgit\-am\fR(1), \fBgit\-send\-email\fR(1)
.SH "AUTHOR"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-HASH\-OBJECT" "1" "10/03/2006" "" ""
+.TH "GIT\-HASH\-OBJECT" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-hash\-object \- Computes object ID and optionally creates a blob from a file
+git\-hash\-object \- Compute object ID and optionally creates a blob from a file
.SH "SYNOPSIS"
\fIgit\-hash\-object\fR [\-t <type>] [\-w] [\-\-stdin] [\-\-] <file>\&...
-.sp
.SH "DESCRIPTION"
Computes the object ID value for an object with specified type with the contents of the named file (which can be outside of the work tree), and optionally writes the resulting object into the object database. Reports its object ID to its standard output. This is used by "git\-cvsimport" to update the index without modifying files in the work tree. When <type> is not specified, it defaults to "blob".
-.sp
.SH "OPTIONS"
.TP
\-t <type>
Read the object from standard input instead of from a file.
.SH "AUTHOR"
Written by Junio C Hamano <junkio@cox.net>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-HTTP\-FETCH" "1" "10/03/2006" "" ""
+.TH "GIT\-HTTP\-FETCH" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-http\-fetch \- downloads a remote git repository via HTTP
+git\-http\-fetch \- Download from a remote git repository via HTTP
.SH "SYNOPSIS"
\fIgit\-http\-fetch\fR [\-c] [\-t] [\-a] [\-d] [\-v] [\-w filename] [\-\-recover] [\-\-stdin] <commit> <url>
-.sp
.SH "DESCRIPTION"
Downloads a remote git repository via HTTP.
-.sp
.SH "OPTIONS"
.TP
commit\-id
Writes the commit\-id into the filename under $GIT_DIR/refs/<filename> on the local end after the transfer is complete.
.TP
\-\-stdin
-Instead of a commit id on the commandline (which is not expected in this case),
-\fIgit\-http\-fetch\fR
-expects lines on stdin in the format
+Instead of a commit id on the commandline (which is not expected in this case), \fIgit\-http\-fetch\fR expects lines on stdin in the format
.sp
.nf
<commit\-id>['\\t'<filename\-as\-in\-\-w>]
.fi
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-HTTP\-PUSH" "1" "10/12/2006" "" ""
+.TH "GIT\-HTTP\-PUSH" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-http\-push \- Push missing objects using HTTP/DAV
+git\-http\-push \- Push objects over HTTP/DAV to another repository
.SH "SYNOPSIS"
\fIgit\-http\-push\fR [\-\-complete] [\-\-force] [\-\-verbose] <url> <ref> [<ref>\&...]
-.sp
.SH "DESCRIPTION"
Sends missing objects to remote repository, and updates the remote branch.
-.sp
.SH "OPTIONS"
.TP
\-\-complete
The remote refs to update.
.SH "SPECIFYING THE REFS"
A \fI<ref>\fR specification can be either a single pattern, or a pair of such patterns separated by a colon ":" (this means that a ref name cannot have a colon in it). A single pattern \fI<name>\fR is just a shorthand for \fI<name>:<name>\fR.
-.sp
+
Each pattern pair consists of the source side (before the colon) and the destination side (after the colon). The ref to be pushed is determined by finding a match that matches the source side, and where it is pushed is determined by using the destination side.
-.sp
.TP 3
\(bu
It is an error if <src> does not match exactly one of the local refs.
<src> == <dst> and the ref that matched the <src> must not exist in the set of remote refs; the ref matched <src> locally is used as the name of the destination.
.RE
Without \fI\-\-force\fR, the <src> ref is stored at the remote only if <dst> does not exist, or <dst> is a proper subset (i.e. an ancestor) of <src>. This check, known as "fast forward check", is performed in order to avoid accidentally overwriting the remote ref and lose other peoples' commits from there.
-.sp
+
With \fI\-\-force\fR, the fast forward check is disabled for all refs.
-.sp
+
Optionally, a <ref> parameter can be prefixed with a plus \fI+\fR sign to disable the fast\-forward check only on that ref.
-.sp
.SH "AUTHOR"
Written by Nick Hengeveld <nickh@reactrix.com>
-.sp
.SH "DOCUMENTATION"
Documentation by Nick Hengeveld
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-INIT" "1" "01/13/2007" "" ""
+.TH "GIT\-INIT" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-init \- Creates an empty git repository
+git\-init \- Create an empty git repository or reinitialize an existing one
.SH "SYNOPSIS"
\fIgit\-init\fR [\-\-template=<template_directory>] [\-\-shared[=<permissions>]]
.SH "OPTIONS"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-INSTAWEB" "1" "10/03/2006" "" ""
+.TH "GIT\-INSTAWEB" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-instaweb \- instantly browse your working repository in gitweb
+git\-instaweb \- Instantly browse your working repository in gitweb
.SH "SYNOPSIS"
\fIgit\-instaweb\fR [\-\-local] [\-\-httpd=<httpd>] [\-\-port=<port>] [\-\-browser=<browser>]
-.sp
+
\fIgit\-instaweb\fR [\-\-start] [\-\-stop] [\-\-restart]
-.sp
.SH "DESCRIPTION"
A simple script to setup gitweb and a web server for browsing the local repository.
-.sp
.SH "OPTIONS"
.TP
\-l|\-\-local
The port number to bind the httpd to. (Default: 1234)
.TP
\-b|\-\-browser
-The web browser command\-line to execute to view the gitweb page. If blank, the URL of the gitweb instance will be printed to stdout. (Default:
-\fIfirefox\fR)
+The web browser command\-line to execute to view the gitweb page. If blank, the URL of the gitweb instance will be printed to stdout. (Default: \fIfirefox\fR)
.TP
\-\-start
Start the httpd instance and exit. This does not generate any of the configuration files for spawning a new instance.
.SH "CONFIGURATION"
You may specify configuration in your .git/config
.sp
-.sp
.nf
[instaweb]
local = true
.fi
.SH "AUTHOR"
Written by Eric Wong <normalperson@yhbt.net>
-.sp
.SH "DOCUMENTATION"
Documentation by Eric Wong <normalperson@yhbt.net>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-LOCAL\-FETCH" "1" "10/03/2006" "" ""
+.TH "GIT\-LOCAL\-FETCH" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-local\-fetch \- Duplicates another git repository on a local system
+git\-local\-fetch \- Duplicate another git repository on a local system
.SH "SYNOPSIS"
\fIgit\-local\-fetch\fR [\-c] [\-t] [\-a] [\-d] [\-v] [\-w filename] [\-\-recover] [\-l] [\-s] [\-n] commit\-id path
-.sp
.SH "DESCRIPTION"
Duplicates another git repository on a local system.
-.sp
.SH "OPTIONS"
.TP
\-c
Writes the commit\-id into the filename under $GIT_DIR/refs/<filename> on the local end after the transfer is complete.
.TP
\-\-stdin
-Instead of a commit id on the commandline (which is not expected in this case),
-\fIgit\-local\-fetch\fR
-expects lines on stdin in the format
+Instead of a commit id on the commandline (which is not expected in this case), \fIgit\-local\-fetch\fR expects lines on stdin in the format
.sp
.nf
<commit\-id>['\\t'<filename\-as\-in\-\-w>]
.fi
.SH "AUTHOR"
Written by Junio C Hamano <junkio@cox.net>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-LS\-FILES" "1" "10/03/2006" "" ""
+.TH "GIT\-LS\-FILES" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-ls\-files \- Information about files in the index/working directory
+git\-ls\-files \- Show information about files in the index and the working tree
.SH "SYNOPSIS"
.sp
.nf
.fi
.SH "DESCRIPTION"
This merges the file listing in the directory cache index with the actual working directory list, and shows different combinations of the two.
-.sp
+
One or more of the options below may be used to determine the files shown:
-.sp
.SH "OPTIONS"
.TP
\-c|\-\-cached
.TP
\-t
Identify the file status with the following tags (followed by a space) at the start of each line:
+
H
+
cached
+
M
+
unmerged
+
R
+
removed/deleted
+
C
+
modified/changed
+
K
+
to be killed
+
?
+
other
+
.TP
\-v
-Similar to
-\-t, but use lowercase letters for files that are marked as
-\fIalways matching index\fR.
+Similar to \-t, but use lowercase letters for files that are marked as \fIalways matching index\fR.
.TP
\-\-full\-name
When run from a subdirectory, the command usually outputs paths relative to the current directory. This option forces paths to be output relative to the project top directory.
.SH "OUTPUT"
show files just outputs the filename unless \fI\-\-stage\fR is specified in which case it outputs:
.sp
-.sp
.nf
[<tag> ]<mode> <object> <stage> <file>
.fi
"git\-ls\-files \-\-unmerged" and "git\-ls\-files \-\-stage" can be used to examine detailed information on unmerged paths.
-.sp
+
For an unmerged path, instead of recording a single mode/SHA1 pair, the dircache records up to three such pairs; one from tree O in stage 1, A in stage 2, and B in stage 3. This information can be used by the user (or the porcelain) to see what should eventually be recorded at the path. (see git\-read\-tree for more information on state)
-.sp
+
When \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively.
-.sp
.SH "EXCLUDE PATTERNS"
\fIgit\-ls\-files\fR can use a list of "exclude patterns" when traversing the directory tree and finding files to show when the flags \-\-others or \-\-ignored are specified.
-.sp
+
These exclude patterns come from these places:
-.sp
.TP 3
1.
command line flag \-\-exclude=<pattern> specifies a single pattern.
command line flag \-\-exclude\-from=<file> specifies a list of patterns stored in a file.
.TP
3.
-command line flag \-\-exclude\-per\-directory=<name> specifies a name of the file in each directory
-\fIgit\-ls\-files\fR
-examines, and if exists, its contents are used as an additional list of patterns.
+command line flag \-\-exclude\-per\-directory=<name> specifies a name of the file in each directory \fIgit\-ls\-files\fR examines, and if exists, its contents are used as an additional list of patterns.
+
An exclude pattern file used by (2) and (3) contains one pattern per line. A line that starts with a \fI#\fR can be used as comment for readability.
-.sp
+
There are three lists of patterns that are in effect at a given time. They are built and ordered in the following way:
-.sp
.TP 3
\(bu
\-\-exclude=<pattern> from the command line; patterns are ordered in the same order as they appear on the command line.
.TP
\(bu
When \-\-exclude\-per\-directory=<name> is specified, upon entering a directory that has such a file, its contents are appended at the end of the current "list of patterns". They are popped off when leaving the directory.
+
Each pattern in the pattern list specifies "a match pattern" and optionally the fate; either a file that matches the pattern is considered excluded or included. A filename is matched against the patterns in the three lists; the \-\-exclude\-from list is checked first, then the \-\-exclude\-per\-directory list, and then finally the \-\-exclude list. The last match determines its fate. If there is no match in the three lists, the fate is "included".
-.sp
+
A pattern specified on the command line with \-\-exclude or read from the file specified with \-\-exclude\-from is relative to the top of the directory tree. A pattern read from a file specified by \-\-exclude\-per\-directory is relative to the directory that the pattern file appears in.
-.sp
+
An exclude pattern is of the following format:
-.sp
.TP 3
\(bu
-an optional prefix
-\fI!\fR
-which means that the fate this pattern specifies is "include", not the usual "exclude"; the remainder of the pattern string is interpreted according to the following rules.
+an optional prefix \fI!\fR which means that the fate this pattern specifies is "include", not the usual "exclude"; the remainder of the pattern string is interpreted according to the following rules.
.TP
\(bu
-if it does not contain a slash
-\fI/\fR, it is a shell glob pattern and used to match against the filename without leading directories.
+if it does not contain a slash \fI/\fR, it is a shell glob pattern and used to match against the filename without leading directories.
.TP
\(bu
otherwise, it is a shell glob pattern, suitable for consumption by fnmatch(3) with FNM_PATHNAME flag. I.e. a slash in the pattern must match a slash in the pathname. "Documentation/*.html" matches "Documentation/git.html" but not "ppc/ppc.html". As a natural exception, "/*.c" matches "cat\-file.c" but not "mozilla\-sha1/sha1.c".
+
An example:
.sp
-.sp
.nf
$ cat .git/info/exclude
# ignore objects and archives, anywhere in the tree.
.fi
Another example:
.sp
-.sp
.nf
$ cat .gitignore
vmlinux*
$ echo '!/vmlinux*' >arch/foo/kernel/.gitignore
.fi
The second .gitignore keeps arch/foo/kernel/vmlinux.lds.S file from getting ignored.
-.sp
.SH "SEE ALSO"
\fBgit\-read\-tree\fR(1)
-.sp
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-LS\-TREE" "1" "10/03/2006" "" ""
+.TH "GIT\-LS\-TREE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-ls\-tree \- Lists the contents of a tree object
+git\-ls\-tree \- List the contents of a tree object
.SH "SYNOPSIS"
.sp
.nf
.fi
.SH "DESCRIPTION"
Lists the contents of a given tree object, like what "/bin/ls \-a" does in the current working directory. Note that the usage is subtly different, though \- \fIpaths\fR denote just a list of patterns to match, e.g. so specifying directory name (without \fI\-r\fR) will behave differently, and order of the arguments does not matter.
-.sp
.SH "OPTIONS"
.TP
<tree\-ish>
Recurse into sub\-trees.
.TP
\-t
-Show tree entries even when going to recurse them. Has no effect if
-\fI\-r\fR
-was not passed.
-\fI\-d\fR
-implies
-\fI\-t\fR.
+Show tree entries even when going to recurse them. Has no effect if \fI\-r\fR was not passed. \fI\-d\fR implies \fI\-t\fR.
.TP
\-z
\\0 line termination on output.
<mode> SP <type> SP <object> TAB <file>
.fi
When the \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively.
-.sp
.SH "AUTHOR"
Written by Petr Baudis <pasky@suse.cz> Completely rewritten from scratch by Junio C Hamano <junkio@cox.net>, another major rewrite by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-MAILINFO" "1" "01/17/2007" "" ""
+.TH "GIT\-MAILINFO" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-mailinfo \- Extracts patch from a single e\-mail message
+git\-mailinfo \- Extracts patch and authorship from a single e\-mail message
.SH "SYNOPSIS"
\fIgit\-mailinfo\fR [\-k] [\-u | \-\-encoding=<encoding>] <msg> <patch>
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-MAILSPLIT" "1" "10/03/2006" "" ""
+.TH "GIT\-MAILSPLIT" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-mailsplit \- Totally braindamaged mbox splitter program
+git\-mailsplit \- Simple UNIX mbox splitter program
.SH "SYNOPSIS"
\fIgit\-mailsplit\fR [\-b] [\-f<nn>] [\-d<prec>] \-o<directory> [\-\-] [<mbox>\&...]
-.sp
.SH "DESCRIPTION"
Splits a mbox file into a list of files: "0001" "0002" .. in the specified directory so you can process them further from there.
-.sp
.SH "OPTIONS"
.TP
<mbox>
Skip the first <nn> numbers, for example if \-f3 is specified, start the numbering with 0004.
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net>
-.sp
.SH "DOCUMENTATION"
Documentation by Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-MERGE\-BASE" "1" "10/03/2006" "" ""
+.TH "GIT\-MERGE\-BASE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-merge\-base \- Finds as good a common ancestor as possible for a merge
+git\-merge\-base \- Find as good common ancestors as possible for a merge
.SH "SYNOPSIS"
\fIgit\-merge\-base\fR [\-\-all] <commit> <commit>
-.sp
.SH "DESCRIPTION"
"git\-merge\-base" finds as good a common ancestor as possible between the two commits. That is, given two commits A and B \fIgit\-merge\-base A B\fR will output a commit which is reachable from both A and B through the parent relationship.
-.sp
+
Given a selection of equally good common ancestors it should not be relied on to decide in any particular way.
-.sp
+
The "git\-merge\-base" algorithm is still in flux \- use the source\&...
-.sp
.SH "OPTIONS"
.TP
\-\-all
Output all common ancestors for the two commits instead of just one.
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-MERGE\-FILE" "1" "12/17/2006" "" ""
+.TH "GIT\-MERGE\-FILE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-merge\-file \- three\-way file merge
+git\-merge\-file \- Run a three\-way file merge
.SH "SYNOPSIS"
.sp
.nf
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-MERGE\-INDEX" "1" "12/13/2006" "" ""
+.TH "GIT\-MERGE\-INDEX" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-merge\-index \- Runs a merge for files needing merging
+git\-merge\-index \- Run a merge for files needing merging
.SH "SYNOPSIS"
\fIgit\-merge\-index\fR [\-o] [\-q] <merge\-program> (\-a | \-\- | <file>*)
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-MERGE\-ONE\-FILE" "1" "10/03/2006" "" ""
+.TH "GIT\-MERGE\-ONE\-FILE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-merge\-one\-file \- The standard helper program to use with "git\-merge\-index"
+git\-merge\-one\-file \- The standard helper program to use with git\-merge\-index
.SH "SYNOPSIS"
\fIgit\-merge\-one\-file\fR
-.sp
.SH "DESCRIPTION"
This is the standard helper program to use with "git\-merge\-index" to resolve a merge after the trivial merge done with "git\-read\-tree \-m".
-.sp
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>, Junio C Hamano <junkio@cox.net> and Petr Baudis <pasky@suse.cz>.
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-MERGE" "1" "12/28/2006" "" ""
+.TH "GIT\-MERGE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-merge \- Grand Unified Merge Driver
+git\-merge \- Join two or more development histories together
.SH "SYNOPSIS"
.sp
.nf
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-MV" "1" "10/03/2006" "" ""
+.TH "GIT\-MV" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-mv \- Move or rename a file, directory or symlink
+git\-mv \- Move or rename a file, a directory, or a symlink
.SH "SYNOPSIS"
\fIgit\-mv\fR <options>\&... <args>\&...
-.sp
.SH "DESCRIPTION"
This script is used to move or rename a file, directory or symlink.
.sp
-.sp
.nf
git\-mv [\-f] [\-n] <source> <destination>
git\-mv [\-f] [\-n] [\-k] <source> ... <destination directory>
.fi
In the first form, it renames <source>, which must exist and be either a file, symlink or directory, to <destination>. In the second form, the last argument has to be an existing directory; the given sources will be moved into this directory.
-.sp
+
The index is updated after successful completion, but the change must still be committed.
-.sp
.SH "OPTIONS"
.TP
\-f
Force renaming or moving of a file even if the target exists
.TP
\-k
-Skip move or rename actions which would lead to an error condition. An error happens when a source is neither existing nor controlled by GIT, or when it would overwrite an existing file unless
-\fI\-f\fR
-is given.
+Skip move or rename actions which would lead to an error condition. An error happens when a source is neither existing nor controlled by GIT, or when it would overwrite an existing file unless \fI\-f\fR is given.
.TP
\-n
Do nothing; only show what would happen
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org> Rewritten by Ryan Anderson <ryan@michonline.com> Move functionality added by Josef Weidendorfer <Josef.Weidendorfer@gmx.de>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-PACK\-REDUNDANT" "1" "10/03/2006" "" ""
+.TH "GIT\-PACK\-REDUNDANT" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-pack\-redundant \- Program used to find redundant pack files
+git\-pack\-redundant \- Find redundant pack files
.SH "SYNOPSIS"
\fIgit\-pack\-redundant\fR [ \-\-verbose ] [ \-\-alt\-odb ] < \-\-all | .pack filename \&... >
-.sp
.SH "DESCRIPTION"
This program computes which packs in your repository are redundant. The output is suitable for piping to \fIxargs rm\fR if you are in the root of the repository.
-.sp
+
git\-pack\-redundant accepts a list of objects on standard input. Any objects given will be ignored when checking which packs are required. This makes the following command useful when wanting to remove packs which contain unreachable objects.
-.sp
+
git\-fsck\-objects \-\-full \-\-unreachable | cut \-d \fI \fR \-f3 | git\-pack\-redundant \-\-all | xargs rm
-.sp
.SH "OPTIONS"
.TP
\-\-all
Outputs some statistics to stderr. Has a small performance penalty.
.SH "AUTHOR"
Written by Lukas Sandström <lukass@etek.chalmers.se>
-.sp
.SH "DOCUMENTATION"
Documentation by Lukas Sandström <lukass@etek.chalmers.se>
-.sp
.SH "SEE ALSO"
\fBgit\-pack\-objects\fR(1) \fBgit\-repack\fR(1) \fBgit\-prune\-packed\fR(1)
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-PARSE\-REMOTE" "1" "01/17/2007" "" ""
+.TH "GIT\-PARSE\-REMOTE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-parse\-remote \- Routines to help parsing $GIT_DIR/remotes/
+git\-parse\-remote \- Routines to help parsing remote repository access parameters
.SH "SYNOPSIS"
\fI. git\-parse\-remote\fR
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-PATCH\-ID" "1" "10/03/2006" "" ""
+.TH "GIT\-PATCH\-ID" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-patch\-id \- Generate a patch ID
+git\-patch\-id \- Compute unique ID for a patch
.SH "SYNOPSIS"
\fIgit\-patch\-id\fR < <patch>
-.sp
.SH "DESCRIPTION"
A "patch ID" is nothing but a SHA1 of the diff associated with a patch, with whitespace and line numbers ignored. As such, it's "reasonably stable", but at the same time also reasonably unique, i.e., two patches that have the same "patch ID" are almost guaranteed to be the same thing.
-.sp
+
IOW, you can use this thing to look for likely duplicate commits.
-.sp
+
When dealing with git\-diff\-tree output, it takes advantage of the fact that the patch is prefixed with the object name of the commit, and outputs two 40\-byte hexadecimal string. The first string is the patch ID, and the second string is the commit ID. This can be used to make a mapping from patch ID to commit ID.
-.sp
.SH "OPTIONS"
.TP
<patch>
The diff to create the ID of.
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-PEEK\-REMOTE" "1" "10/03/2006" "" ""
+.TH "GIT\-PEEK\-REMOTE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-peek\-remote \- Lists the references in a remote repository
+git\-peek\-remote \- List the references in a remote repository
.SH "SYNOPSIS"
\fIgit\-peek\-remote\fR [\-\-exec=<git\-upload\-pack>] [<host>:]<directory>
-.sp
.SH "DESCRIPTION"
Lists the references the remote repository has, and optionally stores them in the local repository under the same name.
-.sp
.SH "OPTIONS"
.TP
\-\-exec=<git\-upload\-pack>
-Use this to specify the path to
-\fIgit\-upload\-pack\fR
-on the remote side, if it is not found on your $PATH. Some installations of sshd ignores the user's environment setup scripts for login shells (e.g. .bash_profile) and your privately installed git may not be found on the system default $PATH. Another workaround suggested is to set up your $PATH in ".bashrc", but this flag is for people who do not want to pay the overhead for non\-interactive shells, but prefer having a lean .bashrc file (they set most of the things up in .bash_profile).
+Use this to specify the path to \fIgit\-upload\-pack\fR on the remote side, if it is not found on your $PATH. Some installations of sshd ignores the user's environment setup scripts for login shells (e.g. .bash_profile) and your privately installed git may not be found on the system default $PATH. Another workaround suggested is to set up your $PATH in ".bashrc", but this flag is for people who do not want to pay the overhead for non\-interactive shells, but prefer having a lean .bashrc file (they set most of the things up in .bash_profile).
.TP
<host>
-A remote host that houses the repository. When this part is specified,
-\fIgit\-upload\-pack\fR
-is invoked via ssh.
+A remote host that houses the repository. When this part is specified, \fIgit\-upload\-pack\fR is invoked via ssh.
.TP
<directory>
The repository to sync from.
.SH "AUTHOR"
Written by Junio C Hamano <junkio@cox.net>
-.sp
.SH "DOCUMENTATION"
Documentation by Junio C Hamano.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-PRUNE\-PACKED" "1" "01/13/2007" "" ""
+.TH "GIT\-PRUNE\-PACKED" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-prune\-packed \- Program used to remove the extra object files that are now residing in a pack file.
+git\-prune\-packed \- Remove extra objects that are already in pack files
.SH "SYNOPSIS"
\fIgit\-prune\-packed\fR [\-n] [\-q]
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-PULL" "1" "01/15/2007" "" ""
+.TH "GIT\-PULL" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-pull \- Pull and merge from another repository or a local branch
+git\-pull \- Fetch from and merge with another repository or a local branch
.SH "SYNOPSIS"
\fIgit\-pull\fR <options> <repository> <refspec>\&...
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-REBASE" "1" "11/07/2006" "" ""
+.TH "GIT\-REBASE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-rebase \- Rebase local commits to a new head
+git\-rebase \- Forward\-port local commits to the updated upstream head
.SH "SYNOPSIS"
\fIgit\-rebase\fR [\-v] [\-\-merge] [\-\-onto <newbase>] <upstream> [<branch>]
-.sp
+
\fIgit\-rebase\fR \-\-continue | \-\-skip | \-\-abort
-.sp
.SH "DESCRIPTION"
git\-rebase replaces <branch> with a new branch of the same name. When the \-\-onto option is provided the new branch starts out with a HEAD equal to <newbase>, otherwise it is equal to <upstream>. It then attempts to create a new commit for each commit from the original <branch> that does not exist in the <upstream> branch.
-.sp
+
It is possible that a merge failure will prevent this process from being completely automatic. You will have to resolve any such merge failure and run git rebase \-\-continue. Another option is to bypass the commit that caused the merge failure with git rebase \-\-skip. To restore the original <branch> and remove the .dotest working files, use the command git rebase \-\-abort instead.
-.sp
+
Note that if <branch> is not specified on the command line, the currently checked out branch is used.
-.sp
+
Assume the following history exists and the current branch is "topic":
.sp
-.sp
.nf
A\-\-\-B\-\-\-C topic
/
.fi
From this point, the result of either of the following commands:
.sp
-.sp
.nf
git\-rebase master
git\-rebase master topic
.fi
would be:
.sp
-.sp
.nf
A'\-\-B'\-\-C' topic
/
D\-\-\-E\-\-\-F\-\-\-G master
.fi
The latter form is just a short\-hand of git checkout topic followed by git rebase master.
-.sp
+
Here is how you would transplant a topic branch based on one branch to another, to pretend that you forked the topic branch from the latter branch, using rebase \-\-onto.
-.sp
+
First let's assume your \fItopic\fR is based on branch \fInext\fR. For example feature developed in \fItopic\fR depends on some functionality which is found in \fInext\fR.
.sp
-.sp
.nf
o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
\\
.fi
We would want to make \fItopic\fR forked from branch \fImaster\fR, for example because the functionality \fItopic\fR branch depend on got merged into more stable \fImaster\fR branch, like this:
.sp
-.sp
.nf
o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
| \\
.fi
We can get this using the following command:
.sp
-.sp
.nf
git\-rebase \-\-onto master next topic
.fi
Another example of \-\-onto option is to rebase part of a branch. If we have the following situation:
.sp
-.sp
.nf
H\-\-\-I\-\-\-J topicB
/
.fi
then the command
.sp
-.sp
.nf
git\-rebase \-\-onto master topicA topicB
.fi
would result in:
.sp
-.sp
.nf
H'\-\-I'\-\-J' topicB
/
A\-\-\-B\-\-\-C\-\-\-D master
.fi
This is useful when topicB does not depend on topicA.
-.sp
+
In case of conflict, git\-rebase will stop at the first problematic commit and leave conflict markers in the tree. You can use git diff to locate the markers (<<<<<<) and make edits to resolve the conflict. For each file you edit, you need to tell git that the conflict has been resolved, typically this would be done with
.sp
-.sp
.nf
git update\-index <filename>
.fi
After resolving the conflict manually and updating the index with the desired resolution, you can continue the rebasing process with
.sp
-.sp
.nf
git rebase \-\-continue
.fi
Alternatively, you can undo the git\-rebase with
.sp
-.sp
.nf
git rebase \-\-abort
.fi
Use merging strategies to rebase. When the recursive (default) merge strategy is used, this allows rebase to be aware of renames on the upstream side.
.TP
\-s <strategy>, \-\-strategy=<strategy>
-Use the given merge strategy; can be supplied more than once to specify them in the order they should be tried. If there is no
-\-s
-option, a built\-in list of strategies is used instead (git\-merge\-recursive
-when merging a single head,
-git\-merge\-octopus
-otherwise). This implies \-\-merge.
+Use the given merge strategy; can be supplied more than once to specify them in the order they should be tried. If there is no \-s option, a built\-in list of strategies is used instead (git\-merge\-recursive when merging a single head, git\-merge\-octopus otherwise). This implies \-\-merge.
.TP
\-v, \-\-verbose
Display a diffstat of what changed upstream since the last rebase.
This resolves any number of heads, but the result of the merge is always the current branch head. It is meant to be used to supersede old development history of side branches.
.SH "NOTES"
When you rebase a branch, you are changing its history in a way that will cause problems for anyone who already has a copy of the branch in their repository and tries to pull updates from you. You should understand the implications of using \fIgit rebase\fR on a repository that you share.
-.sp
+
When the git rebase command is run, it will first execute a "pre\-rebase" hook if one exists. You can use this hook to do sanity checks and reject the rebase if it isn't appropriate. Please see the template pre\-rebase hook script for an example.
-.sp
+
You must be in the top directory of your project to start (or continue) a rebase. Upon completion, <branch> will be the current branch.
-.sp
.SH "AUTHOR"
Written by Junio C Hamano <junkio@cox.net>
-.sp
.SH "DOCUMENTATION"
Documentation by Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-RECEIVE\-PACK" "1" "10/03/2006" "" ""
+.TH "GIT\-RECEIVE\-PACK" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-receive\-pack \- Receive what is pushed into it
+git\-receive\-pack \- Receive what is pushed into the repository
.SH "SYNOPSIS"
\fIgit\-receive\-pack\fR <directory>
-.sp
.SH "DESCRIPTION"
Invoked by \fIgit\-send\-pack\fR and updates the repository with the information fed from the remote end.
-.sp
+
This command is usually not invoked directly by the end user. The UI for the protocol is on the \fIgit\-send\-pack\fR side, and the program pair is meant to be used to push updates to remote repository. For pull operations, see \fIgit\-fetch\-pack\fR.
-.sp
+
The command allows for creation and fast forwarding of sha1 refs (heads/tags) on the remote end (strictly speaking, it is the local end receive\-pack runs, but to the user who is sitting at the send\-pack end, it is updating the remote. Confused?)
-.sp
+
Before each ref is updated, if $GIT_DIR/hooks/update file exists and executable, it is called with three parameters:
.sp
-.sp
.nf
$GIT_DIR/hooks/update refname sha1\-old sha1\-new
.fi
The refname parameter is relative to $GIT_DIR; e.g. for the master head this is "refs/heads/master". Two sha1 are the object names for the refname before and after the update. Note that the hook is called before the refname is updated, so either should match what is recorded in refname.
-.sp
+
The hook should exit with non\-zero status if it wants to disallow updating the named ref. Otherwise it should exit with zero.
-.sp
+
Using this hook, it is easy to generate mails on updates to the local repository. This example script sends a mail with the commits pushed to the repository:
.sp
-.sp
.nf
#!/bin/sh
# mail out commit update information.
.fi
Another hook $GIT_DIR/hooks/post\-update, if exists and executable, is called with the list of refs that have been updated. This can be used to implement repository wide cleanup task if needed. The exit code from this hook invocation is ignored; the only thing left for git\-receive\-pack to do at that point is to exit itself anyway. This hook can be used, for example, to run "git\-update\-server\-info" if the repository is packed and is served via a dumb transport.
.sp
-.sp
.nf
#!/bin/sh
exec git\-update\-server\-info
.fi
There are other real\-world examples of using update and post\-update hooks found in the Documentation/howto directory.
-.sp
+
git\-receive\-pack honours the receive.denyNonFastforwards flag, which tells it if updates to a ref should be denied if they are not fast\-forwards.
-.sp
.SH "OPTIONS"
.TP
<directory>
The repository to sync into.
.SH "SEE ALSO"
\fBgit\-send\-pack\fR(1)
-.sp
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by Junio C Hamano.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-REPACK" "1" "10/23/2006" "" ""
+.TH "GIT\-REPACK" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-repack \- Script used to pack a repository from a collection of objects into pack files.
+git\-repack \- Pack unpacked objects in a repository
.SH "SYNOPSIS"
\fIgit\-repack\fR [\-a] [\-d] [\-f] [\-l] [\-n] [\-q] [\-\-window=N] [\-\-depth=N]
-.sp
.SH "DESCRIPTION"
This script is used to combine all objects that do not currently reside in a "pack", into a pack.
-.sp
+
A pack is a collection of objects, individually compressed, with delta compression applied, stored in a single file, with an associated index file.
-.sp
+
Packs are used to reduce the load on mirror systems, backup engines, disk storage, etc.
-.sp
.SH "OPTIONS"
.TP
\-a
-Instead of incrementally packing the unpacked objects, pack everything available into a single pack. Especially useful when packing a repository that is used for a private development and there no need to worry about people fetching via dumb protocols from it. Use with
-\fI\-d\fR.
+Instead of incrementally packing the unpacked objects, pack everything available into a single pack. Especially useful when packing a repository that is used for a private development and there no need to worry about people fetching via dumb protocols from it. Use with \fI\-d\fR.
.TP
\-d
-After packing, if the newly created packs make some existing packs redundant, remove the redundant packs. Also runs
-\fBgit\-prune\-packed\fR(1).
+After packing, if the newly created packs make some existing packs redundant, remove the redundant packs. Also runs \fBgit\-prune\-packed\fR(1).
.TP
\-l
-Pass the
-\-\-local
-option to
-git pack\-objects, see
-\fBgit\-pack\-objects\fR(1).
+Pass the \-\-local option to git pack\-objects, see \fBgit\-pack\-objects\fR(1).
.TP
\-f
-Pass the
-\-\-no\-reuse\-delta
-option to
-git pack\-objects, see
-\fBgit\-pack\-objects\fR(1).
+Pass the \-\-no\-reuse\-delta option to git pack\-objects, see \fBgit\-pack\-objects\fR(1).
.TP
\-q
-Pass the
-\-q
-option to
-git pack\-objects, see
-\fBgit\-pack\-objects\fR(1).
+Pass the \-q option to git pack\-objects, see \fBgit\-pack\-objects\fR(1).
.TP
\-n
-Do not update the server information with
-git update\-server\-info.
+Do not update the server information with git update\-server\-info.
.TP
\-\-window=[N], \-\-depth=[N]
-These two options affect how the objects contained in the pack are stored using delta compression. The objects are first internally sorted by type, size and optionally names and compared against the other objects within
-\-\-window
-to see if using delta compression saves space.
-\-\-depth
-limits the maximum delta depth; making it too deep affects the performance on the unpacker side, because delta data needs to be applied that many times to get to the necessary object. The default value for both \-\-window and \-\-depth is 10.
+These two options affect how the objects contained in the pack are stored using delta compression. The objects are first internally sorted by type, size and optionally names and compared against the other objects within \-\-window to see if using delta compression saves space. \-\-depth limits the maximum delta depth; making it too deep affects the performance on the unpacker side, because delta data needs to be applied that many times to get to the necessary object. The default value for both \-\-window and \-\-depth is 10.
.SH "CONFIGURATION"
When configuration variable repack.UseDeltaBaseOffset is set for the repository, the command passes \-\-delta\-base\-offset option to git\-pack\-objects; this typically results in slightly smaller packs, but the generated packs are incompatible with versions of git older than (and including) v1.4.3; do not set the variable in a repository that older version of git needs to be able to read (this includes repositories from which packs can be copied out over http or rsync, and people who obtained packs that way can try to use older git with it).
-.sp
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by Ryan Anderson <ryan@michonline.com>
-.sp
.SH "SEE ALSO"
\fBgit\-pack\-objects\fR(1) \fBgit\-prune\-packed\fR(1)
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-REPO\-CONFIG" "1" "01/17/2007" "" ""
+.TH "GIT\-REPO\-CONFIG" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-repo\-config \- Get and set repository or global options.
+git\-repo\-config \- Get and set repository or global options
.SH "SYNOPSIS"
.sp
.nf
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-RERERE" "1" "01/17/2007" "" ""
+.TH "GIT\-RERERE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-rerere \- Reuse recorded resolve
+git\-rerere \- Reuse recorded resolution of conflicted merges
.SH "SYNOPSIS"
\fIgit\-rerere\fR [clear|diff|status|gc]
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-SEND\-PACK" "1" "01/17/2007" "" ""
+.TH "GIT\-SEND\-PACK" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-send\-pack \- Push missing objects packed
+git\-send\-pack \- Push objects over git protocol to another reposiotory
.SH "SYNOPSIS"
\fIgit\-send\-pack\fR [\-\-all] [\-\-force] [\-\-exec=<git\-receive\-pack>] [<host>:]<directory> [<ref>\&...]
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-SHELL" "1" "10/03/2006" "" ""
+.TH "GIT\-SHELL" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-shell \- Restricted login shell for GIT over SSH only
+git\-shell \- Restricted login shell for GIT\-only SSH access
.SH "SYNOPSIS"
\fIgit\-shell\fR \-c <command> <argument>
-.sp
.SH "DESCRIPTION"
This is meant to be used as a login shell for SSH accounts you want to restrict to GIT pull/push access only. It permits execution only of server\-side GIT commands implementing the pull/push functionality. The commands can be executed only by the \fI\-c\fR option; the shell is not interactive.
-.sp
+
Currently, only the git\-receive\-pack and git\-upload\-pack commands are permitted to be called, with a single required argument.
-.sp
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by Petr Baudis and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-SSH\-FETCH" "1" "10/03/2006" "" ""
+.TH "GIT\-SSH\-FETCH" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-ssh\-fetch \- Pulls from a remote repository over ssh connection
+git\-ssh\-fetch \- Fetch from a remote repository over ssh connection
.SH "SYNOPSIS"
\fIgit\-ssh\-fetch\fR [\-c] [\-t] [\-a] [\-d] [\-v] [\-w filename] [\-\-recover] commit\-id url
-.sp
.SH "DESCRIPTION"
Pulls from a remote repository over ssh connection, invoking git\-ssh\-upload on the other end. It functions identically to git\-ssh\-upload, aside from which end you run it on.
-.sp
.SH "OPTIONS"
.TP
commit\-id
Writes the commit\-id into the filename under $GIT_DIR/refs/ on the local end after the transfer is complete.
.SH "AUTHOR"
Written by Daniel Barkalow <barkalow@iabervon.org>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-SSH\-UPLOAD" "1" "10/03/2006" "" ""
+.TH "GIT\-SSH\-UPLOAD" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-ssh\-upload \- Pushes to a remote repository over ssh connection
+git\-ssh\-upload \- Push to a remote repository over ssh connection
.SH "SYNOPSIS"
\fIgit\-ssh\-upload\fR [\-c] [\-t] [\-a] [\-d] [\-v] [\-w filename] [\-\-recover] commit\-id url
-.sp
.SH "DESCRIPTION"
Pushes from a remote repository over ssh connection, invoking git\-ssh\-fetch on the other end. It functions identically to git\-ssh\-fetch, aside from which end you run it on.
-.sp
.SH "OPTIONS"
.TP
commit\-id
Writes the commit\-id into the filename under [URL]/refs/ on the remote end after the transfer is complete.
.SH "AUTHOR"
Written by Daniel Barkalow <barkalow@iabervon.org>
-.sp
.SH "DOCUMENTATION"
Documentation by Daniel Barkalow
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-STATUS" "1" "01/17/2007" "" ""
+.TH "GIT\-STATUS" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-status \- Show working tree status
+git\-status \- Show the working tree status
.SH "SYNOPSIS"
\fIgit\-status\fR <options>\&...
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-SVN" "1" "01/17/2007" "" ""
+.TH "GIT\-SVN" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-svn \- bidirectional operation between Subversion and git
+git\-svn \- Bidirectional operation between a single Subversion branch and git
.SH "SYNOPSIS"
\fIgit\-svn\fR <command> [options] [arguments]
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-SYMBOLIC\-REF" "1" "01/16/2007" "" ""
+.TH "GIT\-SYMBOLIC\-REF" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-symbolic\-ref \- read and modify symbolic refs
+git\-symbolic\-ref \- Read and modify symbolic refs
.SH "SYNOPSIS"
\fIgit\-symbolic\-ref\fR [\-q] <name> [<ref>]
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-TAR\-TREE" "1" "01/17/2007" "" ""
+.TH "GIT\-TAR\-TREE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-tar\-tree \- Creates a tar archive of the files in the named tree
+git\-tar\-tree \- Create a tar archive of the files in the named tree object
.SH "SYNOPSIS"
\fIgit\-tar\-tree\fR [\-\-remote=<repo>] <tree\-ish> [ <base> ]
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-UPDATE\-INDEX" "1" "11/13/2006" "" ""
+.TH "GIT\-UPDATE\-INDEX" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-update\-index \- Modifies the index or directory cache
+git\-update\-index \- Register file contents in the working tree to the index
.SH "SYNOPSIS"
.sp
.nf
.fi
.SH "DESCRIPTION"
Modifies the index or directory cache. Each file mentioned is updated into the index and any \fIunmerged\fR or \fIneeds updating\fR state is cleared.
-.sp
+
The way "git\-update\-index" handles files it is told about can be modified using the various options:
-.sp
.SH "OPTIONS"
.TP
\-\-add
When these flags are specified, the object name recorded for the paths are not updated. Instead, these options sets and unsets the "assume unchanged" bit for the paths. When the "assume unchanged" bit is on, git stops checking the working tree files for possible modifications, so you need to manually unset the bit to tell git when you change the working tree file. This is sometimes helpful when working with a big project on a filesystem that has very slow lstat(2) system call (e.g. cifs).
.TP
\-\-again, \-g
-Runs
-git\-update\-index
-itself on the paths whose index entries are different from those from the
-HEAD
-commit.
+Runs git\-update\-index itself on the paths whose index entries are different from those from the HEAD commit.
.TP
\-\-unresolve
-Restores the
-\fIunmerged\fR
-or
-\fIneeds updating\fR
-state of a file during a merge if it was cleared by accident.
+Restores the \fIunmerged\fR or \fIneeds updating\fR state of a file during a merge if it was cleared by accident.
.TP
\-\-info\-only
Do not create objects in the object database for all <file> arguments that follow this flag; just insert their object IDs into the index.
Remove the file from the index even when the working directory still has such a file. (Implies \-\-remove.)
.TP
\-\-replace
-By default, when a file
-path
-exists in the index, git\-update\-index refuses an attempt to add
-path/file. Similarly if a file
-path/file
-exists, a file
-path
-cannot be added. With \-\-replace flag, existing entries that conflicts with the entry being added are automatically removed with warning messages.
+By default, when a file path exists in the index, git\-update\-index refuses an attempt to add path/file. Similarly if a file path/file exists, a file path cannot be added. With \-\-replace flag, existing entries that conflicts with the entry being added are automatically removed with warning messages.
.TP
\-\-stdin
Instead of taking list of paths from the command line, read list of paths from the standard input. Paths are separated by LF (i.e. one path per line) by default.
Report what is being added and removed from index.
.TP
\-z
-Only meaningful with
-\-\-stdin; paths are separated with NUL character instead of LF.
+Only meaningful with \-\-stdin; paths are separated with NUL character instead of LF.
.TP
\-\-
Do not interpret any more arguments as options.
.TP
<file>
-Files to act on. Note that files beginning with
-\fI.\fR
-are discarded. This includes
-./file
-and
-dir/./file. If you don't want this, then use cleaner names. The same applies to directories ending
-\fI/\fR
-and paths with
-\fI//\fR
+Files to act on. Note that files beginning with \fI.\fR are discarded. This includes ./file and dir/./file. If you don't want this, then use cleaner names. The same applies to directories ending \fI/\fR and paths with \fI//\fR
.SH "USING \-\-REFRESH"
\fI\-\-refresh\fR does not calculate a new sha1 file or bring the index up\-to\-date for mode/content changes. But what it \fBdoes\fR do is to "re\-match" the stat information of a file with the index, so that you can refresh the index for a file that hasn't been changed but where the stat entry is out of date.
-.sp
+
For example, you'd want to do this after doing a "git\-read\-tree", to link up the stat index details with the proper files.
-.sp
.SH "USING \-\-CACHEINFO OR \-\-INFO\-ONLY"
\fI\-\-cacheinfo\fR is used to register a file that is not in the current working directory. This is useful for minimum\-checkout merging.
-.sp
+
To pretend you have a file with mode and sha1 at path, say:
.sp
-.sp
.nf
$ git\-update\-index \-\-cacheinfo mode sha1 path
.fi
\fI\-\-info\-only\fR is used to register files without placing them in the object database. This is useful for status\-only repositories.
-.sp
+
Both \fI\-\-cacheinfo\fR and \fI\-\-info\-only\fR behave similarly: the index is updated but the object database isn't. \fI\-\-cacheinfo\fR is useful when the object is in the database but the file isn't available locally. \fI\-\-info\-only\fR is useful when the file is available, but you do not wish to update the object database.
-.sp
.SH "USING \-\-INDEX\-INFO"
\-\-index\-info is a more powerful mechanism that lets you feed multiple entry definitions from the standard input, and designed specifically for scripts. It can take inputs of three formats:
-.sp
.TP 3
1.
mode SP sha1 TAB path
-.sp
+
The first format is what "git\-apply \-\-index\-info" reports, and used to reconstruct a partial tree that is used for phony merge base tree when falling back on 3\-way merge.
.TP
2.
mode SP type SP sha1 TAB path
-.sp
+
The second format is to stuff git\-ls\-tree output into the index file.
.TP
3.
mode SP sha1 SP stage TAB path
-.sp
+
This format is to put higher order stages into the index file and matches git\-ls\-files \-\-stage output.
+
To place a higher stage entry to the index, the path should first be removed by feeding a mode=0 entry for the path, and then feeding necessary input lines in the third format.
-.sp
+
For example, starting with this index:
.sp
-.sp
.nf
$ git ls\-files \-s
100644 8a1218a1024a212bb3db30becd860315f9f3ac52 0 frotz
.fi
you can feed the following input to \-\-index\-info:
.sp
-.sp
.nf
$ git update\-index \-\-index\-info
0 0000000000000000000000000000000000000000 frotz
.fi
The first line of the input feeds 0 as the mode to remove the path; the SHA1 does not matter as long as it is well formatted. Then the second and third line feeds stage 1 and stage 2 entries for that path. After the above, we would end up with this:
.sp
-.sp
.nf
$ git ls\-files \-s
100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1 frotz
.fi
.SH "USING \(lqASSUME UNCHANGED\(rq BIT"
Many operations in git depend on your filesystem to have an efficient lstat(2) implementation, so that st_mtime information for working tree files can be cheaply checked to see if the file contents have changed from the version recorded in the index file. Unfortunately, some filesystems have inefficient lstat(2). If your filesystem is one of them, you can set "assume unchanged" bit to paths you have not changed to cause git not to do this check. Note that setting this bit on a path does not mean git will check the contents of the file to see if it has changed \(em it makes git to omit any checking and assume it has \fBnot\fR changed. When you make changes to working tree files, you have to explicitly tell git about it by dropping "assume unchanged" bit, either before or after you modify them.
-.sp
+
In order to set "assume unchanged" bit, use \-\-assume\-unchanged option. To unset, use \-\-no\-assume\-unchanged.
-.sp
+
The command looks at core.ignorestat configuration variable. When this is true, paths updated with git\-update\-index paths\&... and paths updated with other git commands that update both index and working tree (e.g. git\-apply \-\-index, git\-checkout\-index \-u, and git\-read\-tree \-u) are automatically marked as "assume unchanged". Note that "assume unchanged" bit is \fBnot\fR set if git\-update\-index \-\-refresh finds the working tree file matches the index (use git\-update\-index \-\-really\-refresh if you want to mark them as "assume unchanged").
-.sp
.SH "EXAMPLES"
To update and refresh only the files already checked out:
.sp
-.sp
.nf
$ git\-checkout\-index \-n \-f \-a && git\-update\-index \-\-ignore\-missing \-\-refresh
.fi
.br
\fB3. \fRthis does lstat(2) and finds index matches the path.
.br
-\fB4. \fRthis does lstat(2) and finds index does
-\fBnot\fR
-match the path.
+\fB4. \fRthis does lstat(2) and finds index does \fBnot\fR match the path.
.br
\fB5. \fRregistering the new version to index sets "assume unchanged" bit.
.br
.br
.SH "CONFIGURATION"
The command honors core.filemode configuration variable. If your repository is on an filesystem whose executable bits are unreliable, this should be set to \fIfalse\fR (see \fBgit\-repo\-config\fR(1)). This causes the command to ignore differences in file modes recorded in the index and the file mode on the filesystem if they differ only on executable bit. On such an unfortunate filesystem, you may need to use git\-update\-index \-\-chmod=.
-.sp
+
The command looks at core.ignorestat configuration variable. See \fIUsing "assume unchanged" bit\fR section above.
-.sp
.SH "SEE ALSO"
\fBgit\-repo\-config\fR(1)
-.sp
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-UPDATE\-REF" "1" "11/02/2006" "" ""
+.TH "GIT\-UPDATE\-REF" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-update\-ref \- update the object name stored in a ref safely
+git\-update\-ref \- Update the object name stored in a ref safely
.SH "SYNOPSIS"
\fIgit\-update\-ref\fR [\-m <reason>] (\-d <ref> <oldvalue> | <ref> <newvalue> [<oldvalue>])
-.sp
.SH "DESCRIPTION"
Given two arguments, stores the <newvalue> in the <ref>, possibly dereferencing the symbolic refs. E.g. git\-update\-ref HEAD <newvalue> updates the current branch head to the new object.
-.sp
+
Given three arguments, stores the <newvalue> in the <ref>, possibly dereferencing the symbolic refs, after verifying that the current value of the <ref> matches <oldvalue>. E.g. git\-update\-ref refs/heads/master <newvalue> <oldvalue> updates the master branch head to <newvalue> only if its current value is <oldvalue>. You can specify 40 "0" or an empty string as <oldvalue> to make sure that the ref you are creating does not exist.
-.sp
+
It also allows a "ref" file to be a symbolic pointer to another ref file by starting with the four\-byte header sequence of "ref:".
-.sp
+
More importantly, it allows the update of a ref file to follow these symbolic pointers, whether they are symlinks or these "regular file symbolic refs". It follows \fBreal\fR symlinks only if they start with "refs/": otherwise it will just try to read them and update them as a regular file (i.e. it will allow the filesystem to follow them, but will overwrite such a symlink to somewhere else with a regular filename).
-.sp
+
In general, using
.sp
-.sp
.nf
git\-update\-ref HEAD "$head"
.fi
should be a _lot_ safer than doing
.sp
-.sp
.nf
echo "$head" > "$GIT_DIR/HEAD"
.fi
both from a symlink following standpoint \fBand\fR an error checking standpoint. The "refs/" rule for symlinks means that symlinks that point to "outside" the tree are safe: they'll be followed for reading but not for writing (so we'll never write through a ref symlink to some other tree, if you have copied a whole archive by creating a symlink tree).
-.sp
+
With \-d flag, it deletes the named <ref> after verifying it still contains <oldvalue>.
-.sp
.SH "LOGGING UPDATES"
If config parameter "core.logAllRefUpdates" is true or the file "$GIT_DIR/logs/<ref>" exists then git\-update\-ref will append a line to the log file "$GIT_DIR/logs/<ref>" (dereferencing all symbolic refs before creating the log name) describing the change in ref value. Log lines are formatted as:
-.sp
.TP 3
1.
oldsha1 SP newsha1 SP committer LF
-.sp
+
Where "oldsha1" is the 40 character hexadecimal value previously stored in <ref>, "newsha1" is the 40 character hexadecimal value of <newvalue> and "committer" is the committer's name, email address and date in the standard GIT committer ident format.
+
Optionally with \-m:
-.sp
.TP 3
1.
oldsha1 SP newsha1 SP committer TAB message LF
-.sp
+
Where all fields are as described above and "message" is the value supplied to the \-m option.
+
An update will fail (without changing <ref>) if the current user is unable to create a new log file, append to the existing log file or does not have committer information available.
-.sp
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-UPLOAD\-ARCHIVE" "1" "10/03/2006" "" ""
+.TH "GIT\-UPLOAD\-ARCHIVE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-upload\-archive \- Send archive
+git\-upload\-archive \- Send archive back to git\-archive
.SH "SYNOPSIS"
\fIgit\-upload\-archive\fR <directory>
-.sp
.SH "DESCRIPTION"
Invoked by \fIgit\-archive \-\-remote\fR and sends a generated archive to the other end over the git protocol.
-.sp
+
This command is usually not invoked directly by the end user. The UI for the protocol is on the \fIgit\-archive\fR side, and the program pair is meant to be used to get an archive from a remote repository.
-.sp
.SH "OPTIONS"
.TP
<directory>
The repository to get a tar archive from.
.SH "AUTHOR"
Written by Franck Bui\-Huu.
-.sp
.SH "DOCUMENTATION"
Documentation by Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-UPLOAD\-PACK" "1" "10/03/2006" "" ""
+.TH "GIT\-UPLOAD\-PACK" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-upload\-pack \- Send missing objects packed
+git\-upload\-pack \- Send objects packed back to git\-fetch\-pack
.SH "SYNOPSIS"
\fIgit\-upload\-pack\fR <directory>
-.sp
.SH "DESCRIPTION"
Invoked by \fIgit\-fetch\-pack\fR, learns what objects the other side is missing, and sends them after packing.
-.sp
+
This command is usually not invoked directly by the end user. The UI for the protocol is on the \fIgit\-fetch\-pack\fR side, and the program pair is meant to be used to pull updates from a remote repository. For push operations, see \fIgit\-send\-pack\fR.
-.sp
.SH "OPTIONS"
.TP
<directory>
The repository to sync from.
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by Junio C Hamano.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-VAR" "1" "10/03/2006" "" ""
+.TH "GIT\-VAR" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-var \- Print the git users identity
+git\-var \- Show a git logical variable
.SH "SYNOPSIS"
\fIgit\-var\fR [ \-l | <variable> ]
-.sp
.SH "DESCRIPTION"
Prints a git logical variable.
-.sp
.SH "OPTIONS"
.TP
\-l
-Cause the logical variables to be listed. In addition, all the variables of the git configuration file .git/config are listed as well. (However, the configuration variables listing functionality is deprecated in favor of
-git\-repo\-config \-l.)
+Cause the logical variables to be listed. In addition, all the variables of the git configuration file .git/config are listed as well. (However, the configuration variables listing functionality is deprecated in favor of git\-repo\-config \-l.)
.SH "EXAMPLE"
.sp
.nf
The password(5) name field is longer than a giant static buffer.
.SH "SEE ALSO"
\fBgit\-commit\-tree\fR(1) \fBgit\-tag\fR(1) \fBgit\-repo\-config\fR(1)
-.sp
.SH "AUTHOR"
Written by Eric Biederman <ebiederm@xmission.com>
-.sp
.SH "DOCUMENTATION"
Documentation by Eric Biederman and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-WRITE\-TREE" "1" "10/03/2006" "" ""
+.TH "GIT\-WRITE\-TREE" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-write\-tree \- Creates a tree object from the current index
+git\-write\-tree \- Create a tree object from the current index
.SH "SYNOPSIS"
\fIgit\-write\-tree\fR [\-\-missing\-ok] [\-\-prefix=<prefix>/]
-.sp
.SH "DESCRIPTION"
Creates a tree object using the current index.
-.sp
+
The index must be in a fully merged state.
-.sp
+
Conceptually, git\-write\-tree sync()s the current index contents into a set of tree files. In order to have that match what is actually in your directory right now, you need to have done a git\-update\-index phase before you did the git\-write\-tree.
-.sp
.SH "OPTIONS"
.TP
\-\-missing\-ok
-Normally
-git\-write\-tree
-ensures that the objects referenced by the directory exist in the object database. This option disables this check.
+Normally git\-write\-tree ensures that the objects referenced by the directory exist in the object database. This option disables this check.
.TP
\-\-prefix=<prefix>/
-Writes a tree object that represents a subdirectory
-<prefix>. This can be used to write the tree object for a subproject that is in the named subdirectory.
+Writes a tree object that represents a subdirectory <prefix>. This can be used to write the tree object for a subproject that is in the named subdirectory.
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GITK" "1" "01/18/2007" "" ""
+.TH "GITK" "1" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-gitk \- git repository browser
+gitk \- The git repository browser
.SH "SYNOPSIS"
\fIgitk\fR [<option>\&...] [<revs>] [\-\-] [<path>\&...]
.SH "DESCRIPTION"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT" "7" "01/17/2007" "" ""
+.TH "GIT" "7" "01/19/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.SS "Main porcelain commands"
.TP
\fBgit\-add\fR(1)
-Add paths to the index.
+Add file contents to the changeset to be committed next.
.TP
\fBgit\-am\fR(1)
-Apply patches from a mailbox, but cooler.
+Apply a series of patches from a mailbox.
.TP
\fBgit\-applymbox\fR(1)
-Apply patches from a mailbox, original version by Linus.
+Apply a series of patches in a mailbox.
.TP
\fBgit\-archive\fR(1)
Creates an archive of files from a named tree.
Find the change that introduced a bug by binary search.
.TP
\fBgit\-branch\fR(1)
-Create and Show branches.
+List, create, or delete branches.
.TP
\fBgit\-checkout\fR(1)
Checkout and switch to a branch.
.TP
\fBgit\-cherry\-pick\fR(1)
-Cherry\-pick the effect of an existing commit.
+Apply the change introduced by an existing commit.
.TP
\fBgit\-clean\fR(1)
Remove untracked files from the working tree.
Show changes between commits, commit and working tree, etc.
.TP
\fBgit\-fetch\fR(1)
-Download from a remote repository via various protocols.
+Download objects and refs from another repository.
.TP
\fBgit\-format\-patch\fR(1)
Prepare patches for e\-mail submission.
The git repository browser.
.TP
\fBgit\-log\fR(1)
-Shows commit logs.
+Show commit logs.
.TP
\fBgit\-ls\-remote\fR(1)
-Shows references in a remote or local repository.
+List references in a remote repository.
.TP
\fBgit\-merge\fR(1)
-Grand unified merge driver.
+Join two or more development histories together.
.TP
\fBgit\-mv\fR(1)
Move or rename a file, a directory, or a symlink.
Pack heads and tags for efficient repository access.
.TP
\fBgit\-pull\fR(1)
-Fetch from and merge with a remote repository or a local branch.
+Fetch from and merge with another repository or a local branch.
.TP
\fBgit\-push\fR(1)
Update remote refs along with associated objects.
.TP
\fBgit\-rebase\fR(1)
-Rebase local commits to the updated upstream head.
+Forward\-port local commits to the updated upstream head.
.TP
\fBgit\-repack\fR(1)
Pack unpacked objects in a repository.
Remove files from the working tree and from the index.
.TP
\fBgit\-shortlog\fR(1)
-Summarizes \fIgit log\fR output.
+Summarize \fIgit log\fR output.
.TP
\fBgit\-show\fR(1)
-Show one commit log and its diff.
+Show various types of objects.
.TP
\fBgit\-show\-branch\fR(1)
Show branches and their commits.
.TP
\fBgit\-status\fR(1)
-Shows the working tree status.
+Show the working tree status.
.TP
\fBgit\-verify\-tag\fR(1)
Check the GPG signature of tag.
.TP
\fBgit\-whatchanged\fR(1)
-Shows commit logs and differences they introduce.
+Show logs with difference each commit introduces.
.SS "Ancillary Commands"
Manipulators:
.TP
Apply one patch extracted from an e\-mail.
.TP
\fBgit\-archimport\fR(1)
-Import an arch repository into git.
+Import an Arch repository into git.
.TP
\fBgit\-convert\-objects\fR(1)
Converts old\-style git repository.
.TP
-\fBgit\-cvsimport\fR(1)
-Salvage your data out of another SCM people love to hate.
-.TP
\fBgit\-cvsexportcommit\fR(1)
Export a single commit to a CVS checkout.
.TP
+\fBgit\-cvsimport\fR(1)
+Salvage your data out of another SCM people love to hate.
+.TP
\fBgit\-cvsserver\fR(1)
A CVS server emulator for git.
.TP
\fBgit\-relink\fR(1)
Hardlink common objects in local repositories.
.TP
+\fBgit\-sh\-setup\fR(1)
+Common git shell script setup code.
+.TP
\fBgit\-svn\fR(1)
Bidirectional operation between a single Subversion branch and git.
.TP
\fBgit\-svnimport\fR(1)
Import a SVN repository into git.
.TP
-\fBgit\-sh\-setup\fR(1)
-Common git shell script setup code.
-.TP
\fBgit\-symbolic\-ref\fR(1)
Read and modify symbolic refs.
.TP
Annotate file lines with commit info.
.TP
\fBgit\-blame\fR(1)
-Find out where each line in a file came from.
+Show what revision and author last modified each line of a file.
.TP
\fBgit\-check\-ref\-format\fR(1)
Make sure ref name is well formed.
Instantly browse your working repository in gitweb.
.TP
\fBgit\-mailinfo\fR(1)
-Extracts patch and authorship information from a single e\-mail message, optionally transliterating the commit message into utf\-8.
+Extracts patch and authorship from a single e\-mail message.
.TP
\fBgit\-mailsplit\fR(1)
-A stupid program to split UNIX mbox format mailbox into individual pieces of e\-mail.
+Simple UNIX mbox splitter program.
.TP
\fBgit\-merge\-tree\fR(1)
Show three\-way merge without touching index.
.TP
+\fBgit\-parse\-remote\fR(1)
+Routines to help parsing remote repository access parameters.
+.TP
\fBgit\-patch\-id\fR(1)
Compute unique ID for a patch.
.TP
-\fBgit\-parse\-remote\fR(1)
-Routines to help parsing $GIT_DIR/remotes/ files.
-.TP
\fBgit\-request\-pull\fR(1)
-git\-request\-pull.
+Generates a summary of pending changes.
.TP
\fBgit\-rev\-parse\fR(1)
Pick out and massage parameters.
A helper for git\-status and git\-commit.
.TP
\fBgit\-send\-email\fR(1)
-Send patch e\-mails out of "format\-patch \-\-mbox" output.
-.TP
-\fBgit\-symbolic\-ref\fR(1)
-Read and modify symbolic refs.
+Send a collection of patches as emails.
.TP
\fBgit\-stripspace\fR(1)
Filter out empty lines.
+.TP
+\fBgit\-symbolic\-ref\fR(1)
+Read and modify symbolic refs.
.SH "LOW\-LEVEL COMMANDS (PLUMBING)"
Although git includes its own porcelain layer, its low\-level commands are sufficient to support development of alternative porcelains. Developers of such porcelains might start by reading about \fBgit\-update\-index\fR(1) and \fBgit\-read\-tree\fR(1).
.SS "Manipulation commands"
.TP
\fBgit\-apply\fR(1)
-Reads a "diff \-up1" or git generated patch file and applies it to the working tree.
+Apply a patch on a git index file and a working tree.
.TP
\fBgit\-checkout\-index\fR(1)
Copy files from the index to the working tree.
.TP
\fBgit\-commit\-tree\fR(1)
-Creates a new commit object.
+Create a new commit object.
.TP
\fBgit\-hash\-object\fR(1)
-Computes the object ID from a file.
+Compute object ID and optionally creates a blob from a file.
.TP
\fBgit\-index\-pack\fR(1)
-Build pack idx file for an existing packed archive.
+Build pack index file for an existing packed archive.
.TP
\fBgit\-init\fR(1)
-Creates an empty git repository, or reinitialize an existing one.
+Create an empty git repository or reinitialize an existing one.
.TP
\fBgit\-merge\-file\fR(1)
-Runs a threeway merge.
+Run a three\-way file merge.
.TP
\fBgit\-merge\-index\fR(1)
-Runs a merge for files needing merging.
+Run a merge for files needing merging.
.TP
\fBgit\-mktag\fR(1)
Creates a tag object.
Build a tree\-object from ls\-tree formatted text.
.TP
\fBgit\-pack\-objects\fR(1)
-Creates a packed archive of objects.
+Create a packed archive of objects.
.TP
\fBgit\-prune\-packed\fR(1)
Remove extra objects that are already in pack files.
Reads tree information into the index.
.TP
\fBgit\-repo\-config\fR(1)
-Get and set options in .git/config.
+Get and set repository or global options.
.TP
\fBgit\-unpack\-objects\fR(1)
-Unpacks objects out of a packed archive.
+Unpack objects from a packed archive.
.TP
\fBgit\-update\-index\fR(1)
-Registers files in the working tree to the index.
+Register file contents in the working tree to the index.
.TP
\fBgit\-write\-tree\fR(1)
-Creates a tree from the index.
+Create a tree object from the current index.
.SS "Interrogation commands"
.TP
\fBgit\-cat\-file\fR(1)
\fBgit\-describe\fR(1)
Show the most recent tag that is reachable from a commit.
.TP
-\fBgit\-diff\-index\fR(1)
-Compares content and mode of blobs between the index and repository.
-.TP
\fBgit\-diff\-files\fR(1)
Compares files in the working tree and the index.
.TP
+\fBgit\-diff\-index\fR(1)
+Compares content and mode of blobs between the index and repository.
+.TP
\fBgit\-diff\-stages\fR(1)
-Compares two "merge stages" in the index.
+Compares two merge stages in the index.
.TP
\fBgit\-diff\-tree\fR(1)
Compares the content and mode of blobs found via two tree objects.
Verifies the connectivity and validity of the objects in the database.
.TP
\fBgit\-ls\-files\fR(1)
-Information about files in the index and the working tree.
+Show information about files in the index and the working tree.
.TP
\fBgit\-ls\-tree\fR(1)
-Displays a tree object in human readable form.
+List the contents of a tree object.
.TP
\fBgit\-merge\-base\fR(1)
-Finds as good common ancestors as possible for a merge.
+Find as good common ancestors as possible for a merge.
.TP
\fBgit\-name\-rev\fR(1)
Find symbolic names for given revs.
Lists commit objects in reverse chronological order.
.TP
\fBgit\-show\-index\fR(1)
-Displays contents of a pack idx file.
+Show packed archive index.
.TP
\fBgit\-show\-ref\fR(1)
List references in a local repository.
.TP
\fBgit\-tar\-tree\fR(1)
-Creates a tar archive of the files in the named tree object.
+Create a tar archive of the files in the named tree object.
.TP
\fBgit\-unpack\-file\fR(1)
Creates a temporary file with a blob's contents.
.TP
\fBgit\-var\fR(1)
-Displays a git logical variable.
+Show a git logical variable.
.TP
\fBgit\-verify\-pack\fR(1)
-Validates packed git archive files.
+Validate packed git archive files.
In general, the interrogate commands do not touch the files in the working tree.
.SS "Synching repositories"
.TP
\fBgit\-fetch\-pack\fR(1)
-Updates from a remote repository (engine for ssh and local transport).
+Receive missing objects from another repository.
.TP
\fBgit\-http\-fetch\fR(1)
-Downloads a remote git repository via HTTP by walking commit chain.
+Download from a remote git repository via HTTP.
+.TP
+\fBgit\-http\-push\fR(1)
+Push objects over HTTP/DAV to another repository.
.TP
\fBgit\-local\-fetch\fR(1)
-Duplicates another git repository on a local system by walking commit chain.
+Duplicate another git repository on a local system.
.TP
\fBgit\-peek\-remote\fR(1)
-Lists references on a remote repository using upload\-pack protocol (engine for ssh and local transport).
+List the references in a remote repository.
.TP
\fBgit\-receive\-pack\fR(1)
-Invoked by \fIgit\-send\-pack\fR to receive what is pushed to it.
+Receive what is pushed into the repository.
.TP
\fBgit\-send\-pack\fR(1)
-Pushes to a remote repository, intelligently.
-.TP
-\fBgit\-http\-push\fR(1)
-Push missing objects using HTTP/DAV.
+Push objects over git protocol to another reposiotory.
.TP
\fBgit\-shell\fR(1)
-Restricted shell for GIT\-only SSH access.
+Restricted login shell for GIT\-only SSH access.
.TP
\fBgit\-ssh\-fetch\fR(1)
-Pulls from a remote repository over ssh connection by walking commit chain.
+Fetch from a remote repository over ssh connection.
.TP
\fBgit\-ssh\-upload\fR(1)
-Helper "server\-side" program used by git\-ssh\-fetch.
+Push to a remote repository over ssh connection.
.TP
\fBgit\-update\-server\-info\fR(1)
-Updates auxiliary information on a dumb server to help clients discover references and packs on it.
+Update auxiliary info file to help dumb servers.
.TP
\fBgit\-upload\-archive\fR(1)
-Invoked by \fIgit\-archive\fR to send a generated archive.
+Send archive back to git\-archive.
.TP
\fBgit\-upload\-pack\fR(1)
-Invoked by \fIgit\-fetch\-pack\fR to push what are asked for.
+Send objects packed back to git\-fetch\-pack.
.SH "CONFIGURATION MECHANISM"
Starting from 0.99.9 (actually mid 0.99.8.GIT), .git/config file is used to hold per\-repository configuration options. It is a simple text file modeled after .ini format familiar to some people. Here is an example:
.sp
projects / git.git / commitdiff