From a7b8c4c40747b7e293c137cf16d3a3be8c1bdd5b Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Tue, 17 Apr 2007 08:28:12 +0000 Subject: [PATCH] Autogenerated manpages for v1.5.1.1-135-gf948 --- man1/git-am.1 | 23 +++++++++-------- man1/git-annotate.1 | 56 +++++++++++++++++++++++++++++++++------- man1/git-apply.1 | 15 ++++++----- man1/git-applymbox.1 | 7 +++-- man1/git-blame.1 | 59 +++++++++++++++++++++++++++++++------------ man1/git-checkout.1 | 10 ++++---- man1/git-lost-found.1 | 12 ++++----- man1/git-rm.1 | 5 +++- 8 files changed, 131 insertions(+), 56 deletions(-) diff --git a/man1/git-am.1 b/man1/git-am.1 index f5f3693f0..3b9ff979a 100644 --- a/man1/git-am.1 +++ b/man1/git-am.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\-AM" "1" "04/04/2007" "Git 1.5.1.31.ge421f" "Git Manual" +.TH "GIT\-AM" "1" "04/17/2007" "Git 1.5.1.1.135.gf948" "Git Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -24,27 +24,27 @@ Splits mail messages in a mailbox into commit log message, authorship informatio \&... The list of mailbox files to read patches from. If you do not supply this argument, reads from the standard input. .TP -\-\-signoff +\-s, \-\-signoff Add Signed\-off\-by: line to the commit message, using the committer identity of yourself. .TP -\-\-dotest= +\-d=, \-\-dotest= Instead of .dotest directory, use as a working area to store extracted patches. .TP -\-\-keep +\-k, \-\-keep Pass \-k flag to git\-mailinfo (see \fBgit\-mailinfo\fR(1)). .TP -\-\-utf8 +\-u, \-\-utf8 Pass \-u flag to git\-mailinfo (see \fBgit\-mailinfo\fR(1)). The proposed commit log message taken from the e\-mail are re\-coded into UTF\-8 encoding (configuration variable i18n.commitencoding can be used to specify project's preferred encoding if it is not UTF\-8). This was optional in prior versions of git, but now it is the default. You could use \-\-no\-utf8 to override this. .TP \-\-no\-utf8 -Do not pass \-u flag to git\-mailinfo (see \fBgit\-mailinfo\fR(1)). +Pass \-n flag to git\-mailinfo (see \fBgit\-mailinfo\fR(1)). .TP -\-\-binary +\-b, \-\-binary Pass \-\-allow\-binary\-replacement flag to git\-apply (see \fBgit\-apply\fR(1)). .TP -\-\-3way +\-3, \-\-3way When the patch does not apply cleanly, fall back on 3\-way merge, if the patch records the identity of blobs it is supposed to apply to, and we have those blobs locally. .TP \-\-skip @@ -56,11 +56,14 @@ This flag is passed to the git\-apply program that applies the patch. \-C, \-p These flags are passed to the git\-apply program that applies the patch. .TP -\-\-interactive +\-i, \-\-interactive Run interactively, just like git\-applymbox. .TP -\-\-resolved +\-r, \-\-resolved After a patch failure (e.g. attempting to apply conflicting patch), the user has applied it by hand and the index file stores the result of the application. Make a commit using the authorship and commit log extracted from the e\-mail message and the current index file, and continue. +.TP +\-\-resolvemsg= +When a patch failure occurs, will be printed to the screen before exiting. This overrides the standard message informing you to use \-\-resolved or \-\-skip to handle the failure. This is solely for internal use between git\-rebase and git\-am. .SH "DISCUSSION" The commit author name is taken from the "From: " line of the message, and commit author time is taken from the "Date: " line of the message. The "Subject: " line is used as the title of the commit, after stripping common prefix "[PATCH ]". It is supposed to describe what the commit is about concisely as a one line text. diff --git a/man1/git-annotate.1 b/man1/git-annotate.1 index 5311dc6ba..cdb0b79dc 100644 --- a/man1/git-annotate.1 +++ b/man1/git-annotate.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\-ANNOTATE" "1" "04/04/2007" "Git 1.5.1.31.ge421f" "Git Manual" +.TH "GIT\-ANNOTATE" "1" "04/17/2007" "Git 1.5.1.1.135.gf948" "Git Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -15,17 +15,55 @@ git\-annotate [options] file [revision] Annotates each line in the given file with information from the commit which introduced the line. Optionally annotate from a given revision. .SH "OPTIONS" .TP -\-l, \-\-long -Show long rev (Defaults off). +\-b +Show blank SHA\-1 for boundary commits. This can also be controlled via the blame.blankboundary config option. .TP -\-t, \-\-time -Show raw timestamp (Defaults off). +\-\-root +Do not treat root commits as boundaries. This can also be controlled via the blame.showroot config option. .TP -\-r, \-\-rename -Follow renames (Defaults on). +\-\-show\-stats +Include additional statistics at the end of blame output. .TP -\-S, \-\-rev\-file -Use revs from revs\-file instead of calling git\-rev\-list. +\-L n,m +Annotate only the specified line range (lines count from 1). +.TP +\-l +Show long rev (Default: off). +.TP +\-t +Show raw timestamp (Default: off). +.TP +\-S +Use revs from revs\-file instead of calling \fBgit\-rev\-list\fR(1). +.TP +\-p, \-\-porcelain +Show in a format designed for machine consumption. +.TP +\-\-incremental +Show the result incrementally in a format designed for machine consumption. +.TP +\-\-contents +When is not specified, the command annotates the changes starting backwards from the working tree copy. This flag makes the command pretend as if the working tree copy has the contents of he named file (specify \- to make the command read from the standard input). +.TP +\-M|| +Detect moving lines in the file as well. When a commit moves a block of lines in a file (e.g. the original file has A and then B, and the commit changes it to B and then A), traditional \fIblame\fR algorithm typically blames the lines that were moved up (i.e. B) to the parent and assigns blame to the lines that were moved down (i.e. A) to the child commit. With this option, both groups of lines are blamed on the parent. +.sp +.nf + is optional but it is the lower bound on the number of +alphanumeric characters that git must detect as moving +within a file for it to associate those lines with the parent +commit. +.fi +.TP +\-C|| +In addition to \-M, detect lines copied from other files that were modified in the same commit. This is useful when you reorganize your program and move code around across files. When this option is given twice, the command looks for copies from all other files in the parent for the commit that creates the file in addition. +.sp +.nf + is optional but it is the lower bound on the number of +alphanumeric characters that git must detect as moving +between files for it to associate those lines with the parent +commit. +.fi .TP \-h, \-\-help Show help message. diff --git a/man1/git-apply.1 b/man1/git-apply.1 index 4d21bbe88..4f5139491 100644 --- a/man1/git-apply.1 +++ b/man1/git-apply.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\-APPLY" "1" "04/04/2007" "Git 1.5.1.31.ge421f" "Git Manual" +.TH "GIT\-APPLY" "1" "04/17/2007" "Git 1.5.1.1.135.gf948" "Git Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -12,11 +12,12 @@ git\-apply \- Apply a patch on a git index file and a working tree .SH "SYNOPSIS" .sp .nf -\fIgit\-apply\fR [\-\-stat] [\-\-numstat] [\-\-summary] [\-\-check] [\-\-index] [\-\-apply] - [\-\-no\-add] [\-\-index\-info] [\-\-allow\-binary\-replacement | \-\-binary] - [\-R | \-\-reverse] [\-\-reject] [\-z] [\-pNUM] [\-CNUM] [\-\-inaccurate\-eof] - [\-\-whitespace=] [\-\-exclude=PATH] - [\-\-cached] [\-\-verbose] [\&...] +\fIgit\-apply\fR [\-\-stat] [\-\-numstat] [\-\-summary] [\-\-check] [\-\-index] + [\-\-apply] [\-\-no\-add] [\-\-index\-info] [\-R | \-\-reverse] + [\-\-allow\-binary\-replacement | \-\-binary] [\-\-reject] [\-z] + [\-pNUM] [\-CNUM] [\-\-inaccurate\-eof] [\-\-cached] + [\-\-whitespace=] + [\-\-exclude=PATH] [\-\-verbose] [\&...] .fi .SH "DESCRIPTION" Reads supplied diff output and applies it on a git index file and a work tree. @@ -101,7 +102,7 @@ strip outputs warnings for a few such errors, strips out the trailing whitespace \-\-inaccurate\-eof Under certain circumstances, some versions of diff do not correctly detect a missing new\-line at the end of the file. As a result, patches created by such diff programs do not record incomplete lines correctly. This option adds support for applying such patches by working around this bug. .TP -\-\-verbose +\-v, \-\-verbose Report progress to stderr. By default, only a message about the current patch being applied will be printed. This option will cause additional information to be reported. .SH "CONFIGURATION" .TP diff --git a/man1/git-applymbox.1 b/man1/git-applymbox.1 index db57d00a3..97247060c 100644 --- a/man1/git-applymbox.1 +++ b/man1/git-applymbox.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\-APPLYMBOX" "1" "04/04/2007" "Git 1.5.1.31.ge421f" "Git Manual" +.TH "GIT\-APPLYMBOX" "1" "04/17/2007" "Git 1.5.1.1.135.gf948" "Git Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -25,10 +25,13 @@ Usually the program \fIcleans up\fR the Subject: header line to extract the titl Patches are applied with git\-apply command, and unless it cleanly applies without fuzz, the processing fails. With this flag, if a tree that the patch applies cleanly is found in a repository, the patch is applied to the tree and then a 3\-way merge between the resulting tree and the current tree. .TP \-u -The commit log message, author name and author email are taken from the e\-mail, and after minimally decoding MIME transfer encoding, re\-coded in UTF\-8 by transliterating them. This used to be optional but now it is the default. +Pass \-u flag to git\-mailinfo (see \fBgit\-mailinfo\fR(1)). The proposed commit log message taken from the e\-mail are re\-coded into UTF\-8 encoding (configuration variable i18n.commitencoding can be used to specify project's preferred encoding if it is not UTF\-8). This used to be optional but now it is the default. Note that the patch is always used as\-is without charset conversion, even with this flag. .TP +\-n +Pass \-n flag to git\-mailinfo (see \fBgit\-mailinfo\fR(1)). +.TP \-c .dotest/ When the patch contained in an e\-mail does not cleanly apply, the command exits with an error message. The patch and extracted message are found in .dotest/, and you could re\-run \fIgit applymbox\fR with \fI\-c .dotest/\fR flag to restart the process after inspecting and fixing them. .TP diff --git a/man1/git-blame.1 b/man1/git-blame.1 index 36d2a0223..cf0884fc9 100644 --- a/man1/git-blame.1 +++ b/man1/git-blame.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\-BLAME" "1" "04/04/2007" "Git 1.5.1.31.ge421f" "Git Manual" +.TH "GIT\-BLAME" "1" "04/17/2007" "Git 1.5.1.1.135.gf948" "Git Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -12,8 +12,9 @@ git\-blame \- Show what revision and author last modified each line of a file .SH "SYNOPSIS" .sp .nf -\fIgit\-blame\fR [\-c] [\-l] [\-t] [\-f] [\-n] [\-p] [\-\-incremental] [\-L n,m] [\-S ] - [\-M] [\-C] [\-C] [\-\-since=] [ | \-\-contents ] [\-\-] +\fIgit\-blame\fR [\-c] [\-l] [\-t] [\-f] [\-n] [\-p] [\-\-incremental] [\-L n,m] + [\-S ] [\-M] [\-C] [\-C] [\-\-since=] + [ | \-\-contents ] [\-\-] .fi .SH "DESCRIPTION" Annotates each line in the given file with information from the revision which last modified the line. Optionally, start annotating from the given revision. @@ -31,27 +32,27 @@ ea4c7f9bf69e781dd0cd88d2bccb2bf5cc15c9a7 git\-blame: Make the output .fi .SH "OPTIONS" .TP -\-c, \-\-compatibility -Use the same output mode as \fBgit\-annotate\fR(1) (Default: off). +\-b +Show blank SHA\-1 for boundary commits. This can also be controlled via the blame.blankboundary config option. +.TP +\-\-root +Do not treat root commits as boundaries. This can also be controlled via the blame.showroot config option. +.TP +\-\-show\-stats +Include additional statistics at the end of blame output. .TP \-L n,m Annotate only the specified line range (lines count from 1). .TP -\-l, \-\-long +\-l Show long rev (Default: off). .TP -\-t, \-\-time +\-t Show raw timestamp (Default: off). .TP -\-S, \-\-rev\-file +\-S Use revs from revs\-file instead of calling \fBgit\-rev\-list\fR(1). .TP -\-f, \-\-show\-name -Show filename in the original commit. By default filename is shown if there is any line that came from a file with different name, due to rename detection. -.TP -\-n, \-\-show\-number -Show line number in the original commit (Default: off). -.TP \-p, \-\-porcelain Show in a format designed for machine consumption. .TP @@ -61,14 +62,40 @@ Show the result incrementally in a format designed for machine consumption. \-\-contents When is not specified, the command annotates the changes starting backwards from the working tree copy. This flag makes the command pretend as if the working tree copy has the contents of he named file (specify \- to make the command read from the standard input). .TP -\-M +\-M|| Detect moving lines in the file as well. When a commit moves a block of lines in a file (e.g. the original file has A and then B, and the commit changes it to B and then A), traditional \fIblame\fR algorithm typically blames the lines that were moved up (i.e. B) to the parent and assigns blame to the lines that were moved down (i.e. A) to the child commit. With this option, both groups of lines are blamed on the parent. +.sp +.nf + is optional but it is the lower bound on the number of +alphanumeric characters that git must detect as moving +within a file for it to associate those lines with the parent +commit. +.fi .TP -\-C +\-C|| In addition to \-M, detect lines copied from other files that were modified in the same commit. This is useful when you reorganize your program and move code around across files. When this option is given twice, the command looks for copies from all other files in the parent for the commit that creates the file in addition. +.sp +.nf + is optional but it is the lower bound on the number of +alphanumeric characters that git must detect as moving +between files for it to associate those lines with the parent +commit. +.fi .TP \-h, \-\-help Show help message. +.TP +\-c +Use the same output mode as \fBgit\-annotate\fR(1) (Default: off). +.TP +\-\-score\-debug +Include debugging information related to the movement of lines between files (see \-C) and lines moved within a file (see \-M). The first number listed is the score. This is the number of alphanumeric characters detected to be moved between or within files. This must be above a certain threshold for git\-blame to consider those lines of code to have been moved. +.TP +\-f, \-\-show\-name +Show filename in the original commit. By default filename is shown if there is any line that came from a file with different name, due to rename detection. +.TP +\-n, \-\-show\-number +Show line number in the original commit (Default: off). .SH "THE PORCELAIN FORMAT" In this format, each line is output after a header; the header at the minimum has the first line which has: .TP 3 diff --git a/man1/git-checkout.1 b/man1/git-checkout.1 index eff9d034a..b297da2be 100644 --- a/man1/git-checkout.1 +++ b/man1/git-checkout.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\-CHECKOUT" "1" "04/04/2007" "Git 1.5.1.31.ge421f" "Git Manual" +.TH "GIT\-CHECKOUT" "1" "04/17/2007" "Git 1.5.1.1.135.gf948" "Git Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -18,23 +18,23 @@ git\-checkout \- Checkout and switch to a branch .SH "DESCRIPTION" When are not given, this command switches branches by updating the index and working tree to reflect the specified branch, , and updating HEAD to be or, if specified, . Using \-b will cause to be created; in this case you can use the \-\-track or \-\-no\-track options, which will be passed to git branch. -When are given, this command does \fBnot\fR switch branches. It updates the named paths in the working tree from the index file (i.e. it runs git\-checkout\-index \-f \-u), or a named commit. In this case, \-f and \-b options are meaningless and giving either of them results in an error. argument can be used to specify a specific tree\-ish (i.e. commit, tag or tree) to update the index for the given paths before updating the working tree. +When are given, this command does \fBnot\fR switch branches. It updates the named paths in the working tree from the index file (i.e. it runs git\-checkout\-index \-f \-u), or from a named commit. In this case, the \-f and \-b options are meaningless and giving either of them results in an error. argument can be used to specify a specific tree\-ish (i.e. commit, tag or tree) to update the index for the given paths before updating the working tree. .SH "OPTIONS" .TP \-q Quiet, supress feedback messages. .TP \-f -Force a re\-read of everything. +Proceed even if the index or the working tree differs from HEAD. This is used to throw away local changes. .TP \-b Create a new branch named and start it at . The new branch name must pass all checks defined by \fBgit\-check\-ref\-format\fR(1). Some of these checks may restrict the characters allowed in a branch name. .TP \-\-track -When \-b is given and a branch is created off a remote branch, setup so that git\-pull will automatically retrieve data from the remote branch. +When \-b is given and a branch is created off a remote branch, set up configuration so that git\-pull will automatically retrieve data from the remote branch. Set the branch.autosetupmerge configuration variable to true if you want git\-checkout and git\-branch to always behave as if \fI\-\-track\fR were given. .TP \-\-no\-track -When \-b is given and a branch is created off a remote branch, force that git\-pull will automatically retrieve data from the remote branch independent of the configuration settings. +When \-b is given and a branch is created off a remote branch, set up configuration so that git\-pull will not retrieve data from the remote branch, ignoring the branch.autosetupmerge configuration variable. .TP \-l Create the new branch's ref log. This activates recording of all changes to made the branch ref, enabling use of date diff --git a/man1/git-lost-found.1 b/man1/git-lost-found.1 index db113159f..375cd8365 100644 --- a/man1/git-lost-found.1 +++ b/man1/git-lost-found.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\-LOST\-FOUND" "1" "04/04/2007" "Git 1.5.1.31.ge421f" "Git Manual" +.TH "GIT\-LOST\-FOUND" "1" "04/17/2007" "Git 1.5.1.1.135.gf948" "Git Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -12,23 +12,23 @@ git\-lost\-found \- Recover lost refs that luckily have not yet been pruned .SH "SYNOPSIS" \fIgit\-lost\-found\fR .SH "DESCRIPTION" -Finds dangling commits and tags from the object database, and creates refs to them in .git/lost\-found/ directory. Commits and tags that dereference to commits go to .git/lost\-found/commit and others are stored in .git/lost\-found/other directory. +Finds dangling commits and tags from the object database, and creates refs to them in the .git/lost\-found/ directory. Commits and tags that dereference to commits are stored in .git/lost\-found/commit, and other objects are stored in .git/lost\-found/other. .SH "OUTPUT" -One line description from the commit and tag found along with their object name are printed on the standard output. +Prints to standard output the object names and one\-line descriptions of any commits or tags found. .SH "EXAMPLE" -Suppose you run \fIgit tag \-f\fR and mistyped the tag to overwrite. The ref to your tag is overwritten, but until you run \fIgit prune\fR, it is still there. +Suppose you run \fIgit tag \-f\fR and mistype the tag to overwrite. The ref to your tag is overwritten, but until you run \fIgit prune\fR, the tag itself is still there. .sp .nf $ git lost\-found [1ef2b196d909eed523d4f3c9bf54b78cdd6843c6] GIT 0.99.9c ... .fi -Also you can use gitk to browse how they relate to each other and existing (probably old) tags. +Also you can use gitk to browse how any tags found relate to each other. .sp .nf $ gitk $(cd .git/lost\-found/commit && echo ??*) .fi -After making sure that it is the object you are looking for, you can reconnect it to your regular .git/refs hierarchy. +After making sure you know which the object is the tag you are looking for, you can reconnect it to your regular .git/refs hierarchy. .sp .nf $ git cat\-file \-t 1ef2b196 diff --git a/man1/git-rm.1 b/man1/git-rm.1 index 962ad96a9..275c39c23 100644 --- a/man1/git-rm.1 +++ b/man1/git-rm.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\-RM" "1" "04/04/2007" "Git 1.5.1.31.ge421f" "Git Manual" +.TH "GIT\-RM" "1" "04/17/2007" "Git 1.5.1.1.135.gf948" "Git Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -32,6 +32,9 @@ This option can be used to separate command\-line options from the list of files .TP \-\-cached This option can be used to tell the command to remove the paths only from the index, leaving working tree files. +.TP +\-\-quiet +git\-rm normally outputs one line (in the form of an "rm" command) for each file removed. This option suppresses that output. .SH "DISCUSSION" The list of given to the command can be exact pathnames, file glob patterns, or leading directory name. The command removes only the paths that is known to git. Giving the name of a file that you have not told git about does not remove that file. .SH "EXAMPLES" -- 2.26.2