From 9312a8f4637948ed369b36761c0b9a628f5d0908 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 8 Nov 2006 01:34:05 +0000 Subject: [PATCH] Autogenerated man pages for v1.4.4-rc1 --- man1/git-fetch-pack.1 | 4 +- man1/git-index-pack.1 | 32 +++++++++- man1/git-pack-objects.1 | 8 ++- man1/git-pickaxe.1 | 137 ++++++++++++++++++++++++++++++++++++++++ man1/git-repo-config.1 | 7 +- man1/git-rev-parse.1 | 8 ++- man7/git.7 | 5 +- 7 files changed, 191 insertions(+), 10 deletions(-) create mode 100755 man1/git-pickaxe.1 diff --git a/man1/git-fetch-pack.1 b/man1/git-fetch-pack.1 index 3dd88247d..8c6ea8e82 100755 --- a/man1/git-fetch-pack.1 +++ b/man1/git-fetch-pack.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\-PACK" "1" "10/03/2006" "" "" +.TH "GIT\-FETCH\-PACK" "1" "11/08/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -28,7 +28,7 @@ flag to \-k Do not invoke \fIgit\-unpack\-objects\fR -on received data, but create a single packfile out of it instead, and store it in the object database. +on received data, but create a single packfile out of it instead, and store it in the object database. If provided twice then the pack is locked against repacking. .TP \-\-exec= Use this to specify the path to diff --git a/man1/git-index-pack.1 b/man1/git-index-pack.1 index 34c0375a5..ca9491f23 100755 --- a/man1/git-index-pack.1 +++ b/man1/git-index-pack.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\-INDEX\-PACK" "1" "10/03/2006" "" "" +.TH "GIT\-INDEX\-PACK" "1" "11/08/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -10,15 +10,43 @@ .SH "NAME" git\-index\-pack \- Build pack index file for an existing packed archive .SH "SYNOPSIS" -\fIgit\-index\-pack\fR [\-o ] +\fIgit\-index\-pack\fR [\-v] [\-o ] \fIgit\-index\-pack\fR \-\-stdin [\-\-fix\-thin] [\-\-keep] [\-v] [\-o ] [] .sp .SH "DESCRIPTION" Reads a packed archive (.pack) from the specified file, and builds a pack index file (.idx) for it. The packed archive together with the pack index can then be placed in the objects/pack/ directory of a git repository. .sp .SH "OPTIONS" .TP +\-v +Be verbose about what is going on, including progress status. +.TP \-o Write the generated pack index into the specified file. Without this option the name of pack index file is constructed from the name of packed archive file by replacing .pack with .idx (and the program fails if the name of packed archive does not end with .pack). +.TP +\-\-stdin +When this flag is provided, the pack is read from stdin instead and a copy is then written to . If is not specified, the pack is written to objects/pack/ directory of the current git repository with a default name determined from the pack content. If is not specified consider using \-\-keep to prevent a race condition between this process and +\fB:git\-repack\fR(1) +. +.TP +\-\-fix\-thin +It is possible for +\fBgit\-pack\-objects\fR(1) +to build "thin" pack, which records objects in deltified form based on objects not included in the pack to reduce network traffic. Those objects are expected to be present on the receiving end and they must be included in the pack for that pack to be self contained and indexable. Without this option any attempt to index a thin pack will fail. This option only makes sense in conjunction with \-\-stdin. +.TP +\-\-keep +Before moving the index into its final destination create an empty .keep file for the associated pack file. This option is usually necessary with \-\-stdin to prevent a simultaneous +\fBgit\-repack\fR(1) +process from deleting the newly constructed pack and index before refs can be updated to use objects contained in the pack. +.TP +\-\-keep=\fIwhy\fR +Like \-\-keep create a .keep file before moving the index into its final destination, but rather than creating an empty file place +\fIwhy\fR +followed by an LF into the .keep file. The +\fIwhy\fR +message can later be searched for within all .keep files to locate any which have outlived their usefulness. +.SH "NOTE" +Once the index has been created, the list of object names is sorted and the SHA1 hash of that list is printed to stdout. If \-\-stdin was also used then this is prefixed by either "pack\\t", or "keep\\t" if a new .keep file was successfully created. This is useful to remove a .keep file used as a lock to prevent the race with \fBgit\-repack\fR(1) mentioned above. +.sp .SH "AUTHOR" Written by Sergey Vlasov .sp diff --git a/man1/git-pack-objects.1 b/man1/git-pack-objects.1 index 5addcd768..bc23f9a9a 100755 --- a/man1/git-pack-objects.1 +++ b/man1/git-pack-objects.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\-PACK\-OBJECTS" "1" "11/05/2006" "" "" +.TH "GIT\-PACK\-OBJECTS" "1" "11/08/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -67,6 +67,12 @@ This flag is similar to \-\-non\-empty Only create a packed archive if it would contain at least one object. .TP +\-\-progress +Progress status is reported on the standard error stream by default when it is attached to a terminal, unless \-q is specified. This flag forces progress status even if the standard error stream is not directed to a terminal. +.TP +\-\-all\-progress +When \-\-stdout is specified then progress report is displayed during the object count and deltification phases but inhibited during the write\-out phase. The reason is that in some cases the output stream is directly linked to another command which may wish to display progress status of its own as it processes incoming pack data. This flag is like \-\-progress except that it forces progress report for the write\-out phase as well even if \-\-stdout is used. +.TP \-q This flag makes the command not to report its progress on the standard error stream. .TP diff --git a/man1/git-pickaxe.1 b/man1/git-pickaxe.1 new file mode 100755 index 000000000..226f545c5 --- /dev/null +++ b/man1/git-pickaxe.1 @@ -0,0 +1,137 @@ +.\" ** You probably do not want to edit this file directly ** +.\" 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\-PICKAXE" "1" "11/08/2006" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +git\-pickaxe \- Show what revision and author last modified each line of a file +.SH "SYNOPSIS" +.sp +.nf +\fIgit\-pickaxe\fR [\-c] [\-l] [\-t] [\-f] [\-n] [\-p] [\-L n,m] [\-S ] + [\-M] [\-C] [\-C] [\-\-since=] [] [\-\-] +.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. +.sp +Also it can limit the range of lines annotated. +.sp +This report doesn't tell you anything about lines which have been deleted or replaced; you need to use a tool such as \fBgit\-diff\fR(1) or the "pickaxe" interface briefly mentioned in the following paragraph. +.sp +Apart from supporting file annotation, git also supports searching the development history for when a code snippet occured in a change. This makes it possible to track when a code snippet was added to a file, moved or copied between files, and eventually deleted or replaced. It works by searching for a text string in the diff. A small example: +.sp +.sp +.nf +$ git log \-\-pretty=oneline \-S'blame_usage' +5040f17eba15504bad66b14a645bddd9b015ebb7 blame \-S +ea4c7f9bf69e781dd0cd88d2bccb2bf5cc15c9a7 git\-blame: Make the output +.fi +.SH "OPTIONS" +.TP +\-c, \-\-compatibility +Use the same output mode as +\fBgit\-annotate\fR(1) +(Default: off). +.TP +\-L n,m +Annotate only the specified line range (lines count from 1). +.TP +\-l, \-\-long +Show long rev (Default: off). +.TP +\-t, \-\-time +Show raw timestamp (Default: off). +.TP +\-S, \-\-rev\-file +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 +\-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. +.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. +.TP +\-h, \-\-help +Show help message. +.SH "THE PORCELAIN FORMAT" +In this format, each line is output after a header; the header at the minumum has the first line which has: +.sp +.TP 3 +\(bu +40\-byte SHA\-1 of the commit the line is attributed to; +.TP +\(bu +the line number of the line in the original file; +.TP +\(bu +the line number of the line in the final file; +.TP +\(bu +on a line that starts a group of line from a different commit than the previous one, the number of lines in this group. On subsequent lines this field is absent. +This header line is followed by the following information at least once for each commit: +.sp +.TP 3 +\(bu +author name ("author"), email ("author\-mail"), time ("author\-time"), and timezone ("author\-tz"); similarly for committer. +.TP +\(bu +filename in the commit the line is attributed to. +.TP +\(bu +the first line of the commit log message ("summary"). +The contents of the actual line is output after the above header, prefixed by a TAB. This is to allow adding more header elements later. +.sp +.SH "SPECIFIYING RANGES" +Unlike git\-blame and git\-annotate in older git, the extent of annotation can be limited to both line ranges and revision ranges. When you are interested in finding the origin for ll. 40\-60 for file foo, you can use \-L option like this: +.sp +.sp +.nf +git pickaxe \-L 40,60 foo +.fi +When you are not interested in changes older than the version v2.6.18, or changes older than 3 weeks, you can use revision range specifiers similar to git\-rev\-list: +.sp +.sp +.nf +git pickaxe v2.6.18.. \-\- foo +git pickaxe \-\-since=3.weeks \-\- foo +.fi +When revision range specifiers are used to limit the annotation, lines that have not changed since the range boundary (either the commit v2.6.18 or the most recent commit that is more than 3 weeks old in the above example) are blamed for that range boundary commit. +.sp +A particularly useful way is to see if an added file have lines created by copy\-and\-paste from existing files. Sometimes this indicates that the developer was being sloppy and did not refactor the code properly. You can first find the commit that introduced the file with: +.sp +.sp +.nf +git log \-\-diff\-filter=A \-\-pretty=short \-\- foo +.fi +and then annotate the change between the commit and its parents, using commit^! notation: +.sp +.sp +.nf +git pickaxe \-C \-C \-f $commit^! \-\- foo +.fi +.SH "SEE ALSO" +\fBgit\-blame\fR(1) +.sp +.SH "AUTHOR" +Written by Junio C Hamano +.sp +.SH "GIT" +Part of the \fBgit\fR(7) suite +.sp diff --git a/man1/git-repo-config.1 b/man1/git-repo-config.1 index daa116c5e..81798b51d 100755 --- a/man1/git-repo-config.1 +++ b/man1/git-repo-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\-REPO\-CONFIG" "1" "11/03/2006" "" "" +.TH "GIT\-REPO\-CONFIG" "1" "11/08/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -498,7 +498,10 @@ The configuration variables in the section are described in \fBgit\-imap\-send\fR(1). .TP -receive.denyNonFastforwads +receive.unpackLimit +If the number of objects received in a push is below this limit then the objects will be unpacked into loose object files. However if the number of received objects equals or exceeds this limit then the received pack will be stored as a pack, after adding any missing delta bases. Storing the pack from a push can make the push operation complete faster, especially on slow filesystems. +.TP +receive.denyNonFastForwards If set to true, git\-receive\-pack will deny a ref update which is not a fast forward. Use this to prevent such an update via a push, even if that push is forced. This configuration variable is set when initializing a shared repository. .SH "AUTHOR" Written by Johannes Schindelin diff --git a/man1/git-rev-parse.1 b/man1/git-rev-parse.1 index 9833a74c9..0c2249917 100755 --- a/man1/git-rev-parse.1 +++ b/man1/git-rev-parse.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\-PARSE" "1" "10/26/2006" "" "" +.TH "GIT\-REV\-PARSE" "1" "11/08/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -240,7 +240,9 @@ This set operation appears so often that there is a shorthand for it. "r1..r2" i .sp A similar notation "r1...r2" is called symmetric difference of r1 and r2 and is defined as "r1 r2 \-\-not $(git\-merge\-base \-\-all r1 r2)". It it the set of commits that are reachable from either one of r1 or r2 but not from both. .sp -Here are a few examples: +Two other shorthands for naming a set that is formed by a commit and its parent commits exists. r1^@ notation means all parents of r1. r1^! includes commit r1 but excludes its all parents. +.sp +Here are a handful examples: .sp .sp .nf @@ -250,6 +252,8 @@ D F A B C D F ^A F B C F G...I C D F G I ^B G I C D F G I +F^@ A B C +F^! H D F H .fi .SH "AUTHOR" Written by Linus Torvalds and Junio C Hamano diff --git a/man7/git.7 b/man7/git.7 index c3e61b61c..e3cd7a426 100755 --- 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" "11/07/2006" "" "" +.TH "GIT" "7" "11/08/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -239,6 +239,9 @@ Annotate file lines with commit info. \fBgit\-blame\fR(1) Blame file lines on commits. .TP +\fBgit\-pickaxe\fR(1) +Find out where each line in a file came from. +.TP \fBgit\-check\-ref\-format\fR(1) Make sure ref name is well formed. .TP -- 2.26.2