From 31ec193137f8e88e8c589a4a63c285889d668f42 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Fri, 2 Mar 2007 10:35:38 +0000 Subject: [PATCH] Autogenerated man pages for v1.5.0.2-273-g8ab3 --- man1/git-add.1 | 4 +- man1/git-bundle.1 | 10 ++-- man1/git-commit-tree.1 | 2 +- man1/git-commit.1 | 2 +- man1/git-config.1 | 2 +- man1/git-diff-files.1 | 2 +- man1/git-diff-index.1 | 2 +- man1/git-diff-tree.1 | 92 ++++++++++++++++++++++++++++- man1/git-diff.1 | 2 +- man1/git-fetch.1 | 2 +- man1/git-log.1 | 92 ++++++++++++++++++++++++++++- man1/git-merge.1 | 2 +- man1/git-pull.1 | 2 +- man1/git-push.1 | 2 +- man1/git-quiltimport.1 | 19 ++---- man1/git-rebase.1 | 2 +- man1/git-rev-list.1 | 92 ++++++++++++++++++++++++++++- man1/git-send-email.1 | 37 +++--------- man1/git-show.1 | 92 ++++++++++++++++++++++++++++- man1/git-svn.1 | 130 ++++++++++++++++------------------------- man7/git.7 | 2 +- 21 files changed, 448 insertions(+), 144 deletions(-) diff --git a/man1/git-add.1 b/man1/git-add.1 index ab9cacb6f..ab4311f4a 100644 --- a/man1/git-add.1 +++ b/man1/git-add.1 @@ -2,7 +2,7 @@ .\" 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\-ADD" "1" "01/17/2007" "" "" +.TH "GIT\-ADD" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -35,7 +35,7 @@ Be verbose. \-f Allow adding otherwise ignored files. .TP -\\i, \-\-interactive +\-i, \-\-interactive Add modified contents in the working tree interactively to the index. .TP \-\- diff --git a/man1/git-bundle.1 b/man1/git-bundle.1 index 93678bb1e..68d2b7472 100644 --- a/man1/git-bundle.1 +++ b/man1/git-bundle.1 @@ -2,7 +2,7 @@ .\" 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\-BUNDLE" "1" "03/01/2007" "" "" +.TH "GIT\-BUNDLE" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -12,7 +12,7 @@ git\-bundle \- Move objects and refs by archive .SH "SYNOPSIS" \fIgit\-bundle\fR create [git\-rev\-list args] \fIgit\-bundle\fR verify \fIgit\-bundle\fR list\-heads [refname\&...] \fIgit\-bundle\fR unbundle [refname\&...] .SH "DESCRIPTION" -Some workflows require that one or more branches of development on one machine be replicated on another machine, but the two machines cannot be directly connected so the interactive git protocols (git, ssh, rsync, http) cannot be used. This command provides suport for git\-fetch and git\-pull to operate by packaging objects and references in an archive at the originating machine, then importing those into another repository using \fBgit\-fetch\fR(1) and \fBgit\-pull\fR(1) after moving the archive by some means (i.e., by sneakernet). As no direct connection between repositories exists, the user must specify a basis for the bundle that is held by the destination repository: the bundle assumes that all objects in the basis are already in the destination repository. +Some workflows require that one or more branches of development on one machine be replicated on another machine, but the two machines cannot be directly connected so the interactive git protocols (git, ssh, rsync, http) cannot be used. This command provides support for git\-fetch and git\-pull to operate by packaging objects and references in an archive at the originating machine, then importing those into another repository using \fBgit\-fetch\fR(1) and \fBgit\-pull\fR(1) after moving the archive by some means (i.e., by sneakernet). As no direct connection between repositories exists, the user must specify a basis for the bundle that is held by the destination repository: the bundle assumes that all objects in the basis are already in the destination repository. .SH "OPTIONS" .TP create @@ -28,14 +28,14 @@ unbundle Passes the objects in the bundle to \fBgit\-index\-pack\fR(1) for storage in the repository, then prints the names of all defined references. If a reflist is given, only references matching those in the given list are printed. This command is really plumbing, intended to be called only by \fBgit\-fetch\fR(1). .TP [git\-rev\-list\-args\&...] -A list of arguments, accepatble to git\-rev\-parse and git\-rev\-list, that specify the specific objects and references to transport. For example, "master~10..master" causes the current master reference to be packaged along with all objects added since its 10th ancestor commit. There is no explicit limit to the number of references and objects that may be packaged. +A list of arguments, acceptable to git\-rev\-parse and git\-rev\-list, that specify the specific objects and references to transport. For example, "master~10..master" causes the current master reference to be packaged along with all objects added since its 10th ancestor commit. There is no explicit limit to the number of references and objects that may be packaged. .TP [refname\&...] -A list of references used to limit the references reported as available. This is principally of use to git\-fetch, which expects to recieve only those references asked for and not necessarily everything in the pack (in this case, git\-bundle is acting like \fBgit\-fetch\-pack\fR(1)). +A list of references used to limit the references reported as available. This is principally of use to git\-fetch, which expects to receive only those references asked for and not necessarily everything in the pack (in this case, git\-bundle is acting like \fBgit\-fetch\-pack\fR(1)). .SH "SPECIFYING REFERENCES" git\-bundle will only package references that are shown by git\-show\-ref: this includes heads, tags, and remote heads. References such as master~1 cannot be packaged, but are perfectly suitable for defining the basis. More than one reference may be packaged, and more than one basis can be specified. The objects packaged are those not contained in the union of the given bases. Each basis can be specified explicitly (e.g., ^master~10), or implicitly (e.g., master~10..master, master \-\-since=10.days.ago). -It is very important that the basis used be held by the destination. It is ok to err on the side of conservatism, causing the bundle file to contain objects already in the destination as these are ignored when unpacking at the destination. +It is very important that the basis used be held by the destination. It is okay to err on the side of conservatism, causing the bundle file to contain objects already in the destination as these are ignored when unpacking at the destination. .SH "EXAMPLE" Assume two repositories exist as R1 on machine A, and R2 on machine B. For whatever reason, direct connection between A and B is not allowed, but we can move data from A to B via some mechanism (CD, email, etc). We want to update R2 with developments made on branch master in R1. We set a tag in R1 (lastR2bundle) after the previous such transport, and move it afterwards to help build the bundle. diff --git a/man1/git-commit-tree.1 b/man1/git-commit-tree.1 index f52ac8145..6d0416a13 100644 --- a/man1/git-commit-tree.1 +++ b/man1/git-commit-tree.1 @@ -2,7 +2,7 @@ .\" 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" "02/19/2007" "" "" +.TH "GIT\-COMMIT\-TREE" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/man1/git-commit.1 b/man1/git-commit.1 index d2b4c4105..aa277cbca 100644 --- a/man1/git-commit.1 +++ b/man1/git-commit.1 @@ -2,7 +2,7 @@ .\" 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" "02/19/2007" "" "" +.TH "GIT\-COMMIT" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/man1/git-config.1 b/man1/git-config.1 index 0565a05f3..f3bb81783 100644 --- a/man1/git-config.1 +++ b/man1/git-config.1 @@ -2,7 +2,7 @@ .\" 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\-CONFIG" "1" "02/26/2007" "" "" +.TH "GIT\-CONFIG" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/man1/git-diff-files.1 b/man1/git-diff-files.1 index 10817bb90..20428c99f 100644 --- a/man1/git-diff-files.1 +++ b/man1/git-diff-files.1 @@ -2,7 +2,7 @@ .\" 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\-FILES" "1" "02/28/2007" "" "" +.TH "GIT\-DIFF\-FILES" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/man1/git-diff-index.1 b/man1/git-diff-index.1 index 368d8f71a..66028d7bb 100644 --- a/man1/git-diff-index.1 +++ b/man1/git-diff-index.1 @@ -2,7 +2,7 @@ .\" 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\-INDEX" "1" "02/14/2007" "" "" +.TH "GIT\-DIFF\-INDEX" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/man1/git-diff-tree.1 b/man1/git-diff-tree.1 index 7eea66ddc..f708052e7 100644 --- a/man1/git-diff-tree.1 +++ b/man1/git-diff-tree.1 @@ -2,7 +2,7 @@ .\" 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\-TREE" "1" "02/14/2007" "" "" +.TH "GIT\-DIFF\-TREE" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -264,7 +264,96 @@ full commit message> \fIraw\fR The \fIraw\fR format shows the entire commit exactly as stored in the commit object. Notably, the SHA1s are displayed in full, regardless of whether \-\-abbrev or \-\-no\-abbrev are used, and \fIparents\fR information show the true parent commits, without taking grafts nor history simplification into account. +.TP +\(bu +\fIformat:\fR + +The \fIformat:\fR format allows you to specify which information you want to show. It works a little bit like printf format, with the notable exception that you get a newline with \fI%n\fR instead of \fI\\n\fR. .RE +E.g, \fIformat:"The author of %h was %an, %ar%nThe title was >>%s<<"\fR would show something like this: + +The author of fe6e0ee was Junio C Hamano, 23 hours ago The title was >>t4119: test autocomputing \-p for traditional diff input.<< + +The placeholders are: +.TP 3 +\(bu +\fI%H\fR: commit hash +.TP +\(bu +\fI%h\fR: abbreviated commit hash +.TP +\(bu +\fI%T\fR: tree hash +.TP +\(bu +\fI%t\fR: abbreviated tree hash +.TP +\(bu +\fI%P\fR: parent hashes +.TP +\(bu +\fI%p\fR: abbreviated parent hashes +.TP +\(bu +\fI%an\fR: author name +.TP +\(bu +\fI%ae\fR: author email +.TP +\(bu +\fI%ad\fR: author date +.TP +\(bu +\fI%aD\fR: author date, RFC2822 style +.TP +\(bu +\fI%ar\fR: author date, relative +.TP +\(bu +\fI%at\fR: author date, UNIX timestamp +.TP +\(bu +\fI%cn\fR: committer name +.TP +\(bu +\fI%ce\fR: committer email +.TP +\(bu +\fI%cd\fR: committer date +.TP +\(bu +\fI%cD\fR: committer date, RFC2822 style +.TP +\(bu +\fI%cr\fR: committer date, relative +.TP +\(bu +\fI%ct\fR: committer date, UNIX timestamp +.TP +\(bu +\fI%e\fR: encoding +.TP +\(bu +\fI%s\fR: subject +.TP +\(bu +\fI%b\fR: body +.TP +\(bu +\fI%Cred\fR: switch color to red +.TP +\(bu +\fI%Cgreen\fR: switch color to green +.TP +\(bu +\fI%Cblue\fR: switch color to blue +.TP +\(bu +\fI%Creset\fR: reset color +.TP +\(bu +\fI%n\fR: newline +.RS .TP \-\-encoding[=] The commit objects record the encoding used for the log message in their encoding header; this option can be used to tell the command to re\-code the commit log message in the encoding preferred by the user. For non plumbing commands this defaults to UTF\-8. @@ -280,6 +369,7 @@ This flag changes the way a merge commit patch is displayed, in a similar way to .TP \-\-always Show the commit itself and the commit log message even if the diff itself is empty. +.RE .SH "LIMITING OUTPUT" If you're only interested in differences in a subset of files, for example some architecture\-specific files, you might do: .sp diff --git a/man1/git-diff.1 b/man1/git-diff.1 index b1dc30da2..746b5fc15 100644 --- a/man1/git-diff.1 +++ b/man1/git-diff.1 @@ -2,7 +2,7 @@ .\" 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" "1" "02/28/2007" "" "" +.TH "GIT\-DIFF" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/man1/git-fetch.1 b/man1/git-fetch.1 index 97241d33a..e396bdb91 100644 --- a/man1/git-fetch.1 +++ b/man1/git-fetch.1 @@ -2,7 +2,7 @@ .\" 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" "02/10/2007" "" "" +.TH "GIT\-FETCH" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/man1/git-log.1 b/man1/git-log.1 index 3b9738ae6..8d79821ca 100644 --- a/man1/git-log.1 +++ b/man1/git-log.1 @@ -2,7 +2,7 @@ .\" 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\-LOG" "1" "02/19/2007" "" "" +.TH "GIT\-LOG" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -114,7 +114,96 @@ full commit message> \fIraw\fR The \fIraw\fR format shows the entire commit exactly as stored in the commit object. Notably, the SHA1s are displayed in full, regardless of whether \-\-abbrev or \-\-no\-abbrev are used, and \fIparents\fR information show the true parent commits, without taking grafts nor history simplification into account. +.TP +\(bu +\fIformat:\fR + +The \fIformat:\fR format allows you to specify which information you want to show. It works a little bit like printf format, with the notable exception that you get a newline with \fI%n\fR instead of \fI\\n\fR. .RE +E.g, \fIformat:"The author of %h was %an, %ar%nThe title was >>%s<<"\fR would show something like this: + +The author of fe6e0ee was Junio C Hamano, 23 hours ago The title was >>t4119: test autocomputing \-p for traditional diff input.<< + +The placeholders are: +.TP 3 +\(bu +\fI%H\fR: commit hash +.TP +\(bu +\fI%h\fR: abbreviated commit hash +.TP +\(bu +\fI%T\fR: tree hash +.TP +\(bu +\fI%t\fR: abbreviated tree hash +.TP +\(bu +\fI%P\fR: parent hashes +.TP +\(bu +\fI%p\fR: abbreviated parent hashes +.TP +\(bu +\fI%an\fR: author name +.TP +\(bu +\fI%ae\fR: author email +.TP +\(bu +\fI%ad\fR: author date +.TP +\(bu +\fI%aD\fR: author date, RFC2822 style +.TP +\(bu +\fI%ar\fR: author date, relative +.TP +\(bu +\fI%at\fR: author date, UNIX timestamp +.TP +\(bu +\fI%cn\fR: committer name +.TP +\(bu +\fI%ce\fR: committer email +.TP +\(bu +\fI%cd\fR: committer date +.TP +\(bu +\fI%cD\fR: committer date, RFC2822 style +.TP +\(bu +\fI%cr\fR: committer date, relative +.TP +\(bu +\fI%ct\fR: committer date, UNIX timestamp +.TP +\(bu +\fI%e\fR: encoding +.TP +\(bu +\fI%s\fR: subject +.TP +\(bu +\fI%b\fR: body +.TP +\(bu +\fI%Cred\fR: switch color to red +.TP +\(bu +\fI%Cgreen\fR: switch color to green +.TP +\(bu +\fI%Cblue\fR: switch color to blue +.TP +\(bu +\fI%Creset\fR: reset color +.TP +\(bu +\fI%n\fR: newline +.RS .TP \-\-encoding[=] The commit objects record the encoding used for the log message in their encoding header; this option can be used to tell the command to re\-code the commit log message in the encoding preferred by the user. For non plumbing commands this defaults to UTF\-8. @@ -130,6 +219,7 @@ Show the change the commit introduces in a patch form. .TP \&... Show only commits that affect the specified paths. +.RE .SH "EXAMPLES" .TP git log \-\-no\-merges diff --git a/man1/git-merge.1 b/man1/git-merge.1 index efebba1fa..b13c44052 100644 --- a/man1/git-merge.1 +++ b/man1/git-merge.1 @@ -2,7 +2,7 @@ .\" 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" "02/18/2007" "" "" +.TH "GIT\-MERGE" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/man1/git-pull.1 b/man1/git-pull.1 index 29d46b37c..ef0d88440 100644 --- a/man1/git-pull.1 +++ b/man1/git-pull.1 @@ -2,7 +2,7 @@ .\" 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" "02/09/2007" "" "" +.TH "GIT\-PULL" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/man1/git-push.1 b/man1/git-push.1 index d6c11ffce..204790ce1 100644 --- a/man1/git-push.1 +++ b/man1/git-push.1 @@ -2,7 +2,7 @@ .\" 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\-PUSH" "1" "01/20/2007" "" "" +.TH "GIT\-PUSH" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/man1/git-quiltimport.1 b/man1/git-quiltimport.1 index 747350258..f7690c7ff 100644 --- a/man1/git-quiltimport.1 +++ b/man1/git-quiltimport.1 @@ -2,7 +2,7 @@ .\" 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\-QUILTIMPORT" "1" "10/03/2006" "" "" +.TH "GIT\-QUILTIMPORT" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -16,11 +16,10 @@ git\-quiltimport \- Applies a quilt patchset onto the current branch .fi .SH "DESCRIPTION" Applies a quilt patchset onto the current git branch, preserving the patch boundaries, patch order, and patch descriptions present in the quilt patchset. -.sp + For each patch the code attempts to extract the author from the patch description. If that fails it falls back to the author specified with \-\-author. If the \-\-author flag was not given the patch description is displayed and the user is asked to interactively enter the author of the patch. -.sp + If a subject is not found in the patch description the patch name is preserved as the 1 line subject in the git description. -.sp .SH "OPTIONS" .TP \-\-dry\-run @@ -31,18 +30,12 @@ The author name and email address to use when no author information can be found .TP \-\-patches The directory to find the quilt patches and the quilt series file. -.sp -.nf -The default for the patch directory is patches -or the value of the $QUILT_PATCHES environment -variable. -.fi + +The default for the patch directory is patches or the value of the $QUILT_PATCHES environment variable. .SH "AUTHOR" Written by Eric Biederman -.sp .SH "DOCUMENTATION" Documentation by Eric Biederman -.sp .SH "GIT" Part of the \fBgit\fR(7) suite -.sp + diff --git a/man1/git-rebase.1 b/man1/git-rebase.1 index abbf4acb1..ab06b6cf9 100644 --- a/man1/git-rebase.1 +++ b/man1/git-rebase.1 @@ -2,7 +2,7 @@ .\" 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" "02/18/2007" "" "" +.TH "GIT\-REBASE" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/man1/git-rev-list.1 b/man1/git-rev-list.1 index 0b0ece3a3..f5221df86 100644 --- a/man1/git-rev-list.1 +++ b/man1/git-rev-list.1 @@ -2,7 +2,7 @@ .\" 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\-REV\-LIST" "1" "02/14/2007" "" "" +.TH "GIT\-REV\-LIST" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -156,7 +156,96 @@ full commit message> \fIraw\fR The \fIraw\fR format shows the entire commit exactly as stored in the commit object. Notably, the SHA1s are displayed in full, regardless of whether \-\-abbrev or \-\-no\-abbrev are used, and \fIparents\fR information show the true parent commits, without taking grafts nor history simplification into account. +.TP +\(bu +\fIformat:\fR + +The \fIformat:\fR format allows you to specify which information you want to show. It works a little bit like printf format, with the notable exception that you get a newline with \fI%n\fR instead of \fI\\n\fR. .RE +E.g, \fIformat:"The author of %h was %an, %ar%nThe title was >>%s<<"\fR would show something like this: + +The author of fe6e0ee was Junio C Hamano, 23 hours ago The title was >>t4119: test autocomputing \-p for traditional diff input.<< + +The placeholders are: +.TP 3 +\(bu +\fI%H\fR: commit hash +.TP +\(bu +\fI%h\fR: abbreviated commit hash +.TP +\(bu +\fI%T\fR: tree hash +.TP +\(bu +\fI%t\fR: abbreviated tree hash +.TP +\(bu +\fI%P\fR: parent hashes +.TP +\(bu +\fI%p\fR: abbreviated parent hashes +.TP +\(bu +\fI%an\fR: author name +.TP +\(bu +\fI%ae\fR: author email +.TP +\(bu +\fI%ad\fR: author date +.TP +\(bu +\fI%aD\fR: author date, RFC2822 style +.TP +\(bu +\fI%ar\fR: author date, relative +.TP +\(bu +\fI%at\fR: author date, UNIX timestamp +.TP +\(bu +\fI%cn\fR: committer name +.TP +\(bu +\fI%ce\fR: committer email +.TP +\(bu +\fI%cd\fR: committer date +.TP +\(bu +\fI%cD\fR: committer date, RFC2822 style +.TP +\(bu +\fI%cr\fR: committer date, relative +.TP +\(bu +\fI%ct\fR: committer date, UNIX timestamp +.TP +\(bu +\fI%e\fR: encoding +.TP +\(bu +\fI%s\fR: subject +.TP +\(bu +\fI%b\fR: body +.TP +\(bu +\fI%Cred\fR: switch color to red +.TP +\(bu +\fI%Cgreen\fR: switch color to green +.TP +\(bu +\fI%Cblue\fR: switch color to blue +.TP +\(bu +\fI%Creset\fR: reset color +.TP +\(bu +\fI%n\fR: newline +.RS .TP \-\-encoding[=] The commit objects record the encoding used for the log message in their encoding header; this option can be used to tell the command to re\-code the commit log message in the encoding preferred by the user. For non plumbing commands this defaults to UTF\-8. @@ -169,6 +258,7 @@ Print the contents of the commit in raw\-format; each record is separated with a .TP \-\-parents Print the parents of the commit. +.RE .SS "Diff Formatting" Below are listed options that control the formatting of diff output. Some of them are specific to \fBgit\-rev\-list\fR(1), however other diff options may be given. See \fBgit\-diff\-files\fR(1) for more options. .TP diff --git a/man1/git-send-email.1 b/man1/git-send-email.1 index c4a6903e4..2c50ea283 100644 --- a/man1/git-send-email.1 +++ b/man1/git-send-email.1 @@ -2,7 +2,7 @@ .\" 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\-EMAIL" "1" "10/29/2006" "" "" +.TH "GIT\-SEND\-EMAIL" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -11,29 +11,22 @@ git\-send\-email \- Send a collection of patches as emails .SH "SYNOPSIS" \fIgit\-send\-email\fR [options] [\&... file|directory] -.sp .SH "DESCRIPTION" Takes the patches given on the command line and emails them out. -.sp + The header of the email is configurable by command line options. If not specified on the command line, the user will be prompted with a ReadLine enabled interface to provide the necessary information. -.sp .SH "OPTIONS" The options available are: -.sp .TP \-\-bcc Specify a "Bcc:" value for each email. -.sp -.nf + The \-\-bcc option must be repeated for each user you want on the bcc list. -.fi .TP \-\-cc Specify a starting "Cc:" value for each email. -.sp -.nf + The \-\-cc option must be repeated for each user you want on the cc list. -.fi .TP \-\-chain\-reply\-to, \-\-no\-chain\-reply\-to If this is set, each email will be sent as a reply to the previous email sent. If disabled with "\-\-no\-chain\-reply\-to", all emails after the first will be sent as replies to the first email sent. When using this, it is recommended that the first file given be an overview of the entire patch series. Default is \-\-chain\-reply\-to @@ -54,17 +47,7 @@ Do not add emails found in Signed\-off\-by: lines to the cc list. Make git\-send\-email less verbose. One line per email should be all that is output. .TP \-\-smtp\-server -If set, specifies the outgoing SMTP server to use. A full pathname of a sendmail\-like program can be specified instead; the program must support the -\-i -option. Default value can be specified by the -\fIsendemail.smtpserver\fR -configuration option; the built\-in default is -/usr/sbin/sendmail -or -/usr/lib/sendmail -if such program is available, or -localhost -otherwise. +If set, specifies the outgoing SMTP server to use. A full pathname of a sendmail\-like program can be specified instead; the program must support the \-i option. Default value can be specified by the \fIsendemail.smtpserver\fR configuration option; the built\-in default is /usr/sbin/sendmail or /usr/lib/sendmail if such program is available, or localhost otherwise. .TP \-\-subject Specify the initial subject of the email thread. Only necessary if \-\-compose is also set. If \-\-compose is not set, this will be prompted for. @@ -74,18 +57,14 @@ Do not add the From: address to the cc: list, if it shows up in a From: line. .TP \-\-to Specify the primary recipient of the emails generated. Generally, this will be the upstream maintainer of the project involved. -.sp -.nf + The \-\-to option must be repeated for each user you want on the to list. -.fi .SH "AUTHOR" Written by Ryan Anderson -.sp + git\-send\-email is originally based upon send_lots_of_email.pl by Greg Kroah\-Hartman. -.sp .SH "DOCUMENTATION" Documentation by Ryan Anderson -.sp .SH "GIT" Part of the \fBgit\fR(7) suite -.sp + diff --git a/man1/git-show.1 b/man1/git-show.1 index 3214a43c0..8129b2439 100644 --- a/man1/git-show.1 +++ b/man1/git-show.1 @@ -2,7 +2,7 @@ .\" 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\-SHOW" "1" "02/28/2007" "" "" +.TH "GIT\-SHOW" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -125,10 +125,100 @@ full commit message> \fIraw\fR The \fIraw\fR format shows the entire commit exactly as stored in the commit object. Notably, the SHA1s are displayed in full, regardless of whether \-\-abbrev or \-\-no\-abbrev are used, and \fIparents\fR information show the true parent commits, without taking grafts nor history simplification into account. +.TP +\(bu +\fIformat:\fR + +The \fIformat:\fR format allows you to specify which information you want to show. It works a little bit like printf format, with the notable exception that you get a newline with \fI%n\fR instead of \fI\\n\fR. .RE +E.g, \fIformat:"The author of %h was %an, %ar%nThe title was >>%s<<"\fR would show something like this: + +The author of fe6e0ee was Junio C Hamano, 23 hours ago The title was >>t4119: test autocomputing \-p for traditional diff input.<< + +The placeholders are: +.TP 3 +\(bu +\fI%H\fR: commit hash +.TP +\(bu +\fI%h\fR: abbreviated commit hash +.TP +\(bu +\fI%T\fR: tree hash +.TP +\(bu +\fI%t\fR: abbreviated tree hash +.TP +\(bu +\fI%P\fR: parent hashes +.TP +\(bu +\fI%p\fR: abbreviated parent hashes +.TP +\(bu +\fI%an\fR: author name +.TP +\(bu +\fI%ae\fR: author email +.TP +\(bu +\fI%ad\fR: author date +.TP +\(bu +\fI%aD\fR: author date, RFC2822 style +.TP +\(bu +\fI%ar\fR: author date, relative +.TP +\(bu +\fI%at\fR: author date, UNIX timestamp +.TP +\(bu +\fI%cn\fR: committer name +.TP +\(bu +\fI%ce\fR: committer email +.TP +\(bu +\fI%cd\fR: committer date +.TP +\(bu +\fI%cD\fR: committer date, RFC2822 style +.TP +\(bu +\fI%cr\fR: committer date, relative +.TP +\(bu +\fI%ct\fR: committer date, UNIX timestamp +.TP +\(bu +\fI%e\fR: encoding +.TP +\(bu +\fI%s\fR: subject +.TP +\(bu +\fI%b\fR: body +.TP +\(bu +\fI%Cred\fR: switch color to red +.TP +\(bu +\fI%Cgreen\fR: switch color to green +.TP +\(bu +\fI%Cblue\fR: switch color to blue +.TP +\(bu +\fI%Creset\fR: reset color +.TP +\(bu +\fI%n\fR: newline +.RS .TP \-\-encoding[=] The commit objects record the encoding used for the log message in their encoding header; this option can be used to tell the command to re\-code the commit log message in the encoding preferred by the user. For non plumbing commands this defaults to UTF\-8. +.RE .SH "EXAMPLES" .TP git show v1.0.0 diff --git a/man1/git-svn.1 b/man1/git-svn.1 index 7ded04c97..7edbe2f8d 100644 --- a/man1/git-svn.1 +++ b/man1/git-svn.1 @@ -2,7 +2,7 @@ .\" 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" "02/23/2007" "" "" +.TH "GIT\-SVN" "1" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -39,8 +39,9 @@ Set the \fIrewriteRoot\fR option in the [svn\-remote] config. .TP \-\-username= For transports that SVN handles authentication for (http, https, and plain svn), specify the username. For other transports (eg svn+ssh://), you must include the username in the URL, eg svn+ssh://foo@svn.bar.com/project - -\-\-prefix= This allows one to specify a prefix which is prepended to the names of remotes if trunk/branches/tags are specified. The prefix does not automatically include a trailing slash, so be sure you include one in the argument if that is what you want. This is useful if you wish to track multiple projects that share a common repository. +.TP +\-\-prefix= +This allows one to specify a prefix which is prepended to the names of remotes if trunk/branches/tags are specified. The prefix does not automatically include a trailing slash, so be sure you include one in the argument if that is what you want. This is useful if you wish to track multiple projects that share a common repository. .TP \fIfetch\fR Fetch unfetched revisions from the Subversion remote we are tracking. The name of the [svn\-remote "\&..."] section in the .git/config file may be specified as an optional command\-line argument. @@ -50,57 +51,46 @@ Runs \fIinit\fR and \fIfetch\fR. It will automatically create a directory based .TP \fIrebase\fR This fetches revisions from the SVN parent of the current HEAD and rebases the current (uncommitted to SVN) work against it. -.sp -.nf -This works similarly to 'svn update' or 'git\-pull' except that -it preserves linear history with 'git\-rebase' instead of -\'git\-merge' for ease of dcommit\-ing with git\-svn. -.fi -.sp -.nf -This accepts all options that 'git\-svn fetch' and 'git\-rebase' -accepts. However '\-\-fetch\-all' only fetches from the current -[svn\-remote], and not all [svn\-remote] definitions. -.fi -.sp -.nf -Like 'git\-rebase'; this requires that the working tree be clean -and have no uncommitted changes. -.fi + +This works similarly to \fIsvn update\fR or \fIgit\-pull\fR except that it preserves linear history with \fIgit\-rebase\fR instead of \fIgit\-merge\fR for ease of dcommit\-ing with git\-svn. + +This accepts all options that \fIgit\-svn fetch\fR and \fIgit\-rebase\fR accepts. However \fI\-\-fetch\-all\fR only fetches from the current [svn\-remote], and not all [svn\-remote] definitions. + +Like \fIgit\-rebase\fR; this requires that the working tree be clean and have no uncommitted changes. .TP \fIdcommit\fR Commit each diff from a specified head directly to the SVN repository, and then rebase or reset (depending on whether or not there is a diff between SVN and head). This will create a revision in SVN for each commit in git. It is recommended that you run git\-svn fetch and rebase (not pull or merge) your commits against the latest changes in the SVN repository. An optional command\-line argument may be specified as an alternative to HEAD. This is advantageous over \fIset\-tree\fR (below) because it produces cleaner, more linear history. .TP \fIlog\fR This should make it easy to look up svn log messages when svn users refer to \-r/\-\-revision numbers. -.sp -.nf + The following features from `svn log' are supported: -.fi -.sp -.nf -\-\-revision=[:] \- is supported, non\-numeric args are not: - HEAD, NEXT, BASE, PREV, etc ... -\-v/\-\-verbose \- it's not completely compatible with - the \-\-verbose output in svn log, but - reasonably close. -\-\-limit= \- is NOT the same as \-\-max\-count, - doesn't count merged/excluded commits -\-\-incremental \- supported -.fi -.sp -.nf +.RS +.TP +\-\-revision=[:] +is supported, non\-numeric args are not: HEAD, NEXT, BASE, PREV, etc \&... +.TP +\-v/\-\-verbose +it's not completely compatible with the \-\-verbose output in svn log, but reasonably close. +.TP +\-\-limit= +is NOT the same as \-\-max\-count, doesn't count merged/excluded commits +.TP +\-\-incremental +supported +.RE +.IP New features: -.fi -.sp -.nf -\-\-show\-commit \- shows the git commit sha1, as well -\-\-oneline \- our version of \-\-pretty=oneline -.fi -.sp -.nf +.RS +.TP +\-\-show\-commit +shows the git commit sha1, as well +.TP +\-\-oneline +our version of \-\-pretty=oneline +.RE +.IP Any other arguments are passed directly to `git log' -.fi .TP \fIset\-tree\fR You should consider using \fIdcommit\fR instead of this command. Commit specified commit or tree objects to SVN. This relies on your imported fetch data being up\-to\-date. This makes absolutely no attempts to do patching when committing to SVN, it simply overwrites files with those specified in the tree or commit. All merging is assumed to have taken place independently of git\-svn functions. @@ -164,19 +154,17 @@ config key: svn.authorsfile \-q , \-\-quiet Make git\-svn less verbose. .TP -\-\-repack[=] -\-\-repack\-flags= These should help keep disk usage sane for large fetches with many revisions. -.sp -.nf -\-\-repack takes an optional argument for the number of revisions -to fetch before repacking. This defaults to repacking every -1000 commits fetched if no argument is specified. -.fi +\-\-repack[=] , \-\-repack\-flags= +These should help keep disk usage sane for large fetches with many revisions. + +\-\-repack takes an optional argument for the number of revisions to fetch before repacking. This defaults to repacking every 1000 commits fetched if no argument is specified. + +\-\-repack\-flags are passed directly to \fBgit\-repack\fR(1). .sp .nf -\-\-repack\-flags are passed directly to gitlink:git\-repack[1]. +config key: svn.repack +config key: svn.repackflags .fi -config key: svn.repack config key: svn.repackflags .TP \-m , \-\-merge , \-s , \-\-strategy= These are only used with the \fIdcommit\fR and \fIrebase\fR commands. @@ -203,31 +191,15 @@ config key: svn.followparent .TP svn.noMetadata , svn\-remote..noMetadata This gets rid of the git\-svn\-id: lines at the end of every commit. -.sp -.nf -If you lose your .git/svn/git\-svn/.rev_db file, git\-svn will not -be able to rebuild it and you won't be able to fetch again, -either. This is fine for one\-shot imports. -.fi -.sp -.nf -The 'git\-svn log' command will not work on repositories using -this, either. Using this conflicts with the 'useSvmProps' -option for (hopefully) obvious reasons. -.fi + +If you lose your .git/svn/git\-svn/.rev_db file, git\-svn will not be able to rebuild it and you won't be able to fetch again, either. This is fine for one\-shot imports. + +The \fIgit\-svn log\fR command will not work on repositories using this, either. Using this conflicts with the \fIuseSvmProps\fR option for (hopefully) obvious reasons. .TP svn.useSvmProps , svn\-remote..useSvmProps This allows git\-svn to re\-map repository URLs and UUIDs from mirrors created using SVN::Mirror (or svk) for metadata. -.sp -.nf -If an SVN revision has a property, "svm:headrev", it is likely -that the revision was created by SVN::Mirror (also used by SVK). -The property contains a repository UUID and a revision. We want -to make it look like we are mirroring the original URL, so -introduce a helper function that returns the original identity -URL and UUID, and use it when generating metadata in commit -messages. -.fi + +If an SVN revision has a property, "svm:headrev", it is likely that the revision was created by SVN::Mirror (also used by SVK). The property contains a repository UUID and a revision. We want to make it look like we are mirroring the original URL, so introduce a helper function that returns the original identity URL and UUID, and use it when generating metadata in commit messages. .TP svn.useSvnsyncProps , svn\-remote..useSvnsyncprops Similar to the useSvmProps option; this is for users of the svnsync(1) command distributed with SVN 1.4.x and later. @@ -238,7 +210,7 @@ This allows users to create repositories from alternate URLs. For example, an ad Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps options all affect the metadata generated and used by git\-svn; they \fBmust\fR be set in the configuration file before any history is imported and these settings should never be changed once they are set. Additionally, only one of these four options can be used per\-svn\-remote section because they affect the \fIgit\-svn\-id:\fR metadata line. -.SS "Basic Examples" +.SH "BASIC EXAMPLES" Tracking and contributing to a the trunk of a Subversion\-managed project: .sp .nf @@ -270,7 +242,7 @@ Tracking and contributing to an entire Subversion\-managed project (complete wit # with the appropriate name): git reset \-\-hard remotes/trunk # You may only dcommit to one branch/tag/trunk at a time. The usage -# of dcommit/rebase/show\-ignore should be teh same as above. +# of dcommit/rebase/show\-ignore should be the same as above. .fi .SH "REBASE VS. PULL/MERGE" Originally, git\-svn recommended that the remotes/git\-svn branch be pulled or merged from. This is because the author favored \fIgit\-svn set\-tree B\fR to commit a single head rather than the \fIgit\-svn set\-tree A..B\fR notation to commit multiple commits. diff --git a/man7/git.7 b/man7/git.7 index 6c083316d..b962fdde5 100644 --- a/man7/git.7 +++ b/man7/git.7 @@ -2,7 +2,7 @@ .\" 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" "03/01/2007" "" "" +.TH "GIT" "7" "03/02/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) -- 2.26.2