Autogenerated man pages for v1.4.2.1-gdd0c36
authorJunio C Hamano <junio@hera.kernel.org>
Sun, 1 Oct 2006 05:40:43 +0000 (05:40 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Sun, 1 Oct 2006 05:40:43 +0000 (05:40 +0000)
man1/git-diff-files.1
man1/git-diff-index.1
man1/git-diff-stages.1
man1/git-diff-tree.1

index 27161732893728ea06048ef0e844ea91940ddb2f..33343668c962aa5956378a5e940d2afe3a7c72b9 100755 (executable)
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "GIT-DIFF-FILES" 1 "" "" ""
-.SH NAME
-git-diff-files \- Compares files in the working tree and the index
+.\" ** 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\-DIFF\-FILES" "1" "10/01/2006" "" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+git\-diff\-files \- Compares files in the working tree and the index
 .SH "SYNOPSIS"
-
-
-\fIgit\-diff\-files\fR [\-q] [\-0|\-1|\-2|\-3|\-c|\-\-cc] [<common diff options>] [<path>...]
-
+\fIgit\-diff\-files\fR [\-q] [\-0|\-1|\-2|\-3|\-c|\-\-cc] [<common diff options>] [<path>\&...]
+.sp
 .SH "DESCRIPTION"
-
-
-Compares the files in the working tree and the index\&. When paths are specified, compares only those named paths\&. Otherwise all entries in the index are compared\&. The output format is the same as "git\-diff\-index" and "git\-diff\-tree"\&.
-
+Compares the files in the working tree and the index. When paths are specified, compares only those named paths. Otherwise all entries in the index are compared. The output format is the same as "git\-diff\-index" and "git\-diff\-tree".
+.sp
 .SH "OPTIONS"
-
 .TP
 \-p
 Generate patch (see section on generating patches)
-
 .TP
 \-u
-Synonym for "\-p"\&.
-
+Synonym for "\-p".
 .TP
 \-\-raw
-Generate the raw format\&.
-
+Generate the raw format.
 .TP
 \-\-patch\-with\-raw
-Synonym for "\-p \-\-raw"\&.
-
+Synonym for "\-p \-\-raw".
 .TP
-\-\-stat
-Generate a diffstat\&.
-
+\-\-stat[=width[,name\-width]]
+Generate a diffstat. You can override the default output width for 80\-column terminal by "\-\-stat=width". The width of the filename part can be controlled by giving another width to it separated by a comma.
 .TP
 \-\-summary
-Output a condensed summary of extended header information such as creations, renames and mode changes\&.
-
+Output a condensed summary of extended header information such as creations, renames and mode changes.
 .TP
 \-\-patch\-with\-stat
-Synonym for "\-p \-\-stat"\&.
-
+Synonym for "\-p \-\-stat".
 .TP
 \-z
 \\0 line termination on output
-
 .TP
 \-\-name\-only
-Show only names of changed files\&.
-
+Show only names of changed files.
 .TP
 \-\-name\-status
-Show only names and status of changed files\&.
-
+Show only names and status of changed files.
 .TP
 \-\-color
-Show colored diff\&.
-
+Show colored diff.
 .TP
 \-\-no\-color
-Turn off colored diff, even when the configuration file gives the default to color output\&.
-
+Turn off colored diff, even when the configuration file gives the default to color output.
 .TP
 \-\-color\-words
-Show colored word diff, i\&.e\&. color words which have changed\&.
-
+Show colored word diff, i.e. color words which have changed.
 .TP
 \-\-no\-renames
-Turn off rename detection, even when the configuration file gives the default to do so\&.
-
+Turn off rename detection, even when the configuration file gives the default to do so.
 .TP
 \-\-full\-index
-Instead of the first handful characters, show full object name of pre\- and post\-image blob on the "index" line when generating a patch format output\&.
-
+Instead of the first handful characters, show full object name of pre\- and post\-image blob on the "index" line when generating a patch format output.
 .TP
 \-\-binary
-In addition to \-\-full\-index, output "binary diff" that can be applied with "git apply"\&.
-
+In addition to \-\-full\-index, output "binary diff" that can be applied with "git apply".
 .TP
 \-\-abbrev[=<n>]
-Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show only handful hexdigits prefix\&. This is independent of \-\-full\-index option above, which controls the diff\-patch output format\&. Non default number of digits can be specified with \-\-abbrev=<n>\&.
-
+Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show only handful hexdigits prefix. This is independent of \-\-full\-index option above, which controls the diff\-patch output format. Non default number of digits can be specified with \-\-abbrev=<n>.
 .TP
 \-B
-Break complete rewrite changes into pairs of delete and create\&.
-
+Break complete rewrite changes into pairs of delete and create.
 .TP
 \-M
-Detect renames\&.
-
+Detect renames.
 .TP
 \-C
-Detect copies as well as renames\&.
-
+Detect copies as well as renames.
 .TP
 \-\-diff\-filter=[ACDMRTUXB*]
-Select only files that are Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (mode) changed (T), are Unmerged (U), are Unknown (X), or have had their pairing Broken (B)\&. Any combination of the filter characters may be used\&. When * (All\-or\-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected\&.
-
+Select only files that are Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (mode) changed (T), are Unmerged (U), are Unknown (X), or have had their pairing Broken (B). Any combination of the filter characters may be used. When
+*
+(All\-or\-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected.
 .TP
 \-\-find\-copies\-harder
-For performance reasons, by default, \-C option finds copies only if the original file of the copy was modified in the same changeset\&. This flag makes the command inspect unmodified files as candidates for the source of copy\&. This is a very expensive operation for large projects, so use it with caution\&.
-
+For performance reasons, by default, \-C option finds copies only if the original file of the copy was modified in the same changeset. This flag makes the command inspect unmodified files as candidates for the source of copy. This is a very expensive operation for large projects, so use it with caution.
 .TP
 \-l<num>
-\-M and \-C options require O(n^2) processing time where n is the number of potential rename/copy targets\&. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified number\&.
-
+\-M and \-C options require O(n^2) processing time where n is the number of potential rename/copy targets. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified number.
 .TP
 \-S<string>
-Look for differences that contain the change in <string>\&.
-
+Look for differences that contain the change in <string>.
 .TP
 \-\-pickaxe\-all
-When \-S finds a change, show all the changes in that changeset, not just the files that contain the change in <string>\&.
-
+When \-S finds a change, show all the changes in that changeset, not just the files that contain the change in <string>.
 .TP
 \-\-pickaxe\-regex
-Make the <string> not a plain string but an extended POSIX regex to match\&.
-
+Make the <string> not a plain string but an extended POSIX regex to match.
 .TP
 \-O<orderfile>
-Output the patch in the order specified in the <orderfile>, which has one shell glob pattern per line\&.
-
+Output the patch in the order specified in the <orderfile>, which has one shell glob pattern per line.
 .TP
 \-R
-Swap two inputs; that is, show differences from index or on\-disk file to tree contents\&.
-
+Swap two inputs; that is, show differences from index or on\-disk file to tree contents.
 .TP
 \-\-text
-Treat all files as text\&.
-
+Treat all files as text.
 .TP
 \-a
-Shorthand for "\-\-text"\&.
-
-
-For more detailed explanation on these common options, see also diffcore documentation: \fIdiffcore.html\fR\&.
-
+Shorthand for "\-\-text".
+For more detailed explanation on these common options, see also [1]\&\fIdiffcore documentation\fR.
+.sp
 .TP
 \-1 \-2 \-3 or \-\-base \-\-ours \-\-theirs, and \-0
-Diff against the "base" version, "our branch" or "their branch" respectively\&. With these options, diffs for merged entries are not shown\&.
-
-The default is to diff against our branch (\-2) and the cleanly resolved paths\&. The option \-0 can be given to omit diff output for unmerged entries and just show "Unmerged"\&.
-
+Diff against the "base" version, "our branch" or "their branch" respectively. With these options, diffs for merged entries are not shown.
+.sp
+The default is to diff against our branch (\-2) and the cleanly resolved paths. The option \-0 can be given to omit diff output for unmerged entries and just show "Unmerged".
 .TP
 \-c,\-\-cc
-This compares stage 2 (our branch), stage 3 (their branch) and the working tree file and outputs a combined diff, similar to the way \fIdiff\-tree\fR shows a merge commit with these flags\&.
-
+This compares stage 2 (our branch), stage 3 (their branch) and the working tree file and outputs a combined diff, similar to the way
+\fIdiff\-tree\fR
+shows a merge commit with these flags.
 .TP
 \-q
 Remain silent even on nonexistent files
-
 .SH "OUTPUT FORMAT"
-
-
-The output format from "git\-diff\-index", "git\-diff\-tree" and "git\-diff\-files" are very similar\&.
-
-
+The output format from "git\-diff\-index", "git\-diff\-tree" and "git\-diff\-files" are very similar.
+.sp
 These commands all compare two sets of things; what is compared differs:
-
+.sp
 .TP
 git\-diff\-index <tree\-ish>
-compares the <tree\-ish> and the files on the filesystem\&.
-
+compares the <tree\-ish> and the files on the filesystem.
 .TP
 git\-diff\-index \-\-cached <tree\-ish>
-compares the <tree\-ish> and the index\&.
-
+compares the <tree\-ish> and the index.
 .TP
-git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>...]
-compares the trees named by the two arguments\&.
-
+git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>\&...]
+compares the trees named by the two arguments.
 .TP
-git\-diff\-files [<pattern>...]
-compares the index and the files on the filesystem\&.
-
-
+git\-diff\-files [<pattern>\&...]
+compares the index and the files on the filesystem.
 An output line is formatted this way:
-
+.sp
+.sp
 .nf
-in\-place edit  :100644 100644 bcd1234\&.\&.\&. 0123456\&.\&.\&. M file0
-copy\-edit      :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. C68 file1 file2
-rename\-edit    :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. R86 file1 file3
-create         :000000 100644 0000000\&.\&.\&. 1234567\&.\&.\&. A file4
-delete         :100644 000000 1234567\&.\&.\&. 0000000\&.\&.\&. D file5
-unmerged       :000000 000000 0000000\&.\&.\&. 0000000\&.\&.\&. U file6
+in\-place edit  :100644 100644 bcd1234... 0123456... M file0
+copy\-edit      :100644 100644 abcd123... 1234567... C68 file1 file2
+rename\-edit    :100644 100644 abcd123... 1234567... R86 file1 file3
+create         :000000 100644 0000000... 1234567... A file4
+delete         :100644 000000 1234567... 0000000... D file5
+unmerged       :000000 000000 0000000... 0000000... U file6
 .fi
-
-
 That is, from the left to the right:
-
+.sp
 .TP 3
 1.
-a colon\&.
+a colon.
 .TP
 2.
-mode for "src"; 000000 if creation or unmerged\&.
+mode for "src"; 000000 if creation or unmerged.
 .TP
 3.
-a space\&.
+a space.
 .TP
 4.
-mode for "dst"; 000000 if deletion or unmerged\&.
+mode for "dst"; 000000 if deletion or unmerged.
 .TP
 5.
-a space\&.
+a space.
 .TP
 6.
-sha1 for "src"; 0{40} if creation or unmerged\&.
+sha1 for "src"; 0{40} if creation or unmerged.
 .TP
 7.
-a space\&.
+a space.
 .TP
 8.
-sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree"\&.
+sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree".
 .TP
 9.
-a space\&.
+a space.
 .TP
 10.
-status, followed by optional "score" number\&.
+status, followed by optional "score" number.
 .TP
 11.
-a tab or a NUL when \fI\-z\fR option is used\&.
+a tab or a NUL when
+\fI\-z\fR
+option is used.
 .TP
 12.
 path for "src"
 .TP
 13.
-a tab or a NUL when \fI\-z\fR option is used; only exists for C or R\&.
+a tab or a NUL when
+\fI\-z\fR
+option is used; only exists for C or R.
 .TP
 14.
-path for "dst"; only exists for C or R\&.
+path for "dst"; only exists for C or R.
 .TP
 15.
-an LF or a NUL when \fI\-z\fR option is used, to terminate the record\&.
-.LP
-
-
-<sha1> is shown as all 0's if a file is new on the filesystem and it is out of sync with the index\&.
-
-
+an LF or a NUL when
+\fI\-z\fR
+option is used, to terminate the record.
+<sha1> is shown as all 0's if a file is new on the filesystem and it is out of sync with the index.
+.sp
 Example:
-
+.sp
+.sp
 .nf
-:100644 100644 5be4a4\&.\&.\&.\&.\&.\&. 000000\&.\&.\&.\&.\&.\&. M file\&.c
+:100644 100644 5be4a4...... 000000...... M file.c
 .fi
-
-
-When \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
-
-.SH "GENERATING PATCHES WITH -P"
-
-
-When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \fI\-p\fR option, they do not produce the output described above; instead they produce a patch file\&.
-
-
-The patch generation can be customized at two levels\&.
-
+When \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively.
+.sp
+.SH "GENERATING PATCHES WITH \-P"
+When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \fI\-p\fR option, they do not produce the output described above; instead they produce a patch file.
+.sp
+The patch generation can be customized at two levels.
+.sp
 .TP 3
 1.
-When the environment variable \fIGIT_EXTERNAL_DIFF\fR is not set, these commands internally invoke "diff" like this:
-
-
+When the environment variable
+\fIGIT_EXTERNAL_DIFF\fR
+is not set, these commands internally invoke "diff" like this:
+.sp
 .nf
 diff \-L a/<path> \-L b/<path> \-pu <old> <new>
 .fi
-For added files, /dev/null is used for <old>\&. For removed files, /dev/null is used for <new>
-
-The "diff" formatting options can be customized via the environment variable \fIGIT_DIFF_OPTS\fR\&. For example, if you prefer context diff:
-
+For added files,
+/dev/null
+is used for <old>. For removed files,
+/dev/null
+is used for <new>
+.sp
+The "diff" formatting options can be customized via the environment variable
+\fIGIT_DIFF_OPTS\fR. For example, if you prefer context diff:
+.sp
 .nf
 GIT_DIFF_OPTS=\-c git\-diff\-index \-p HEAD
 .fi
 .TP
 2.
-When the environment variable \fIGIT_EXTERNAL_DIFF\fR is set, the program named by it is called, instead of the diff invocation described above\&.
-
-For a path that is added, removed, or modified, \fIGIT_EXTERNAL_DIFF\fR is called with 7 parameters:
-
-
+When the environment variable
+\fIGIT_EXTERNAL_DIFF\fR
+is set, the program named by it is called, instead of the diff invocation described above.
+.sp
+For a path that is added, removed, or modified,
+\fIGIT_EXTERNAL_DIFF\fR
+is called with 7 parameters:
+.sp
 .nf
 path old\-file old\-hex old\-mode new\-file new\-hex new\-mode
 .fi
 where:
-
 <old|new>\-file
 
 are files GIT_EXTERNAL_DIFF can use to read the contents of <old|new>,
@@ -313,34 +264,54 @@ are the 40\-hexdigit SHA1 hashes,
 
 <old|new>\-mode
 
-are the octal representation of the file modes\&.
-
-The file parameters can point at the user's working file (e\&.g\&. new\-file in "git\-diff\-files"), /dev/null (e\&.g\&. old\-file when a new file is added), or a temporary file (e\&.g\&. old\-file in the index)\&. \fIGIT_EXTERNAL_DIFF\fR should not worry about unlinking the temporary file \-\-\- it is removed when \fIGIT_EXTERNAL_DIFF\fR exits\&.
-.LP
-
-
-For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, <path>\&.
-
+are the octal representation of the file modes.
+
+The file parameters can point at the user's working file (e.g.
+new\-file
+in "git\-diff\-files"),
+/dev/null
+(e.g.
+old\-file
+when a new file is added), or a temporary file (e.g.
+old\-file
+in the index).
+\fIGIT_EXTERNAL_DIFF\fR
+should not worry about unlinking the temporary file \-\-\- it is removed when
+\fIGIT_EXTERNAL_DIFF\fR
+exits.
+For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, <path>.
+.sp
 .SH "GIT SPECIFIC EXTENSION TO DIFF FORMAT"
-
-
-What \-p option produces is slightly different from the traditional diff format\&.
-
+What \-p option produces is slightly different from the traditional diff format.
+.sp
 .TP 3
 1.
 It is preceded with a "git diff" header, that looks like this:
-
-
+.sp
 .nf
 diff \-\-git a/file1 b/file2
 .fi
-The a/ and b/ filenames are the same unless rename/copy is involved\&. Especially, even for a creation or a deletion, /dev/null is _not_ used in place of a/ or b/ filenames\&.
-
-When rename/copy is involved, file1 and file2 show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively\&.
+The
+a/
+and
+b/
+filenames are the same unless rename/copy is involved. Especially, even for a creation or a deletion,
+/dev/null
+is _not_ used in place of
+a/
+or
+b/
+filenames.
+.sp
+When rename/copy is involved,
+file1
+and
+file2
+show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively.
 .TP
 2.
 It is followed by one or more extended header lines:
-
+.sp
 .nf
 old mode <mode>
 new mode <mode>
@@ -352,20 +323,20 @@ rename from <path>
 rename to <path>
 similarity index <number>
 dissimilarity index <number>
-index <hash>\&.\&.<hash> <mode>
+index <hash>..<hash> <mode>
 .fi
 .TP
 3.
-TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
-.LP
-
+TAB, LF, and backslash characters in pathnames are represented as
+\\t,
+\\n, and
+\\\\, respectively.
 .SH "COMBINED DIFF FORMAT"
-
-
 git\-diff\-tree and git\-diff\-files can take \fI\-c\fR or \fI\-\-cc\fR option to produce \fIcombined diff\fR, which looks like this:
-
+.sp
+.sp
 .nf
-diff \-\-combined describe\&.c
+diff \-\-combined describe.c
 @@@ +98,7 @@@
    return (a_date > b_date) ? \-1 : (a_date == b_date) ? 0 : 1;
   }
@@ -377,31 +348,24 @@ diff \-\-combined describe\&.c
  +     unsigned char sha1[20];
  +     struct commit *cmit;
 .fi
-
-
-Unlike the traditional \fIunified\fR diff format, which shows two files A and B with a single column that has \- (minus -- appears in A but removed in B), + (plus -- missing in A but added to B), or (space -- unchanged) prefix, this format compares two or more files file1, file2,... with one file X, and shows how X differs from each of fileN\&. One column for each of fileN is prepended to the output line to note how X's line is different from it\&.
-
-
-A \- character in the column N means that the line appears in fileN but it does not appear in the last file\&. A + character in the column N means that the line appears in the last file, and fileN does not have that line\&.
-
-
-In the above example output, the function signature was changed from both files (hence two \- removals from both file1 and file2, plus ++ to mean one line that was added does not appear in either file1 nor file2)\&. Also two other lines are the same from file1 but do not appear in file2 (hence prefixed with +)\&.
-
-
-When shown by git diff\-tree \-c, it compares the parents of a merge commit with the merge result (i\&.e\&. file1\&.\&.fileN are the parents)\&. When shown by git diff\-files \-c, it compares the two unresolved merge parents with the working tree file (i\&.e\&. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version")\&.
-
+Unlike the traditional \fIunified\fR diff format, which shows two files A and B with a single column that has \- (minus \(em appears in A but removed in B), + (plus \(em missing in A but added to B), or (space \(em unchanged) prefix, this format compares two or more files file1, file2,\&... with one file X, and shows how X differs from each of fileN. One column for each of fileN is prepended to the output line to note how X's line is different from it.
+.sp
+A \- character in the column N means that the line appears in fileN but it does not appear in the last file. A + character in the column N means that the line appears in the last file, and fileN does not have that line.
+.sp
+In the above example output, the function signature was changed from both files (hence two \- removals from both file1 and file2, plus ++ to mean one line that was added does not appear in either file1 nor file2). Also two other lines are the same from file1 but do not appear in file2 (hence prefixed with +).
+.sp
+When shown by git diff\-tree \-c, it compares the parents of a merge commit with the merge result (i.e. file1..fileN are the parents). When shown by git diff\-files \-c, it compares the two unresolved merge parents with the working tree file (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version").
+.sp
 .SH "AUTHOR"
-
-
-Written by Linus Torvalds <torvalds@osdl\&.org>
-
+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>\&.
-
+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
+.SH "REFERENCES"
+.TP 3
+1.\ diffcore documentation
+\%diffcore.html
index 61e96d7842b282a20828629c99b1f220a80e978c..0624cd87beac321ee6b7cbcd3ea915707c2abba8 100755 (executable)
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "GIT-DIFF-INDEX" 1 "" "" ""
-.SH NAME
-git-diff-index \- Compares content and mode of blobs between the index and repository
+.\" ** 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\-DIFF\-INDEX" "1" "10/01/2006" "" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+git\-diff\-index \- Compares content and mode of blobs between the index and repository
 .SH "SYNOPSIS"
-
-
-\fIgit\-diff\-index\fR [\-m] [\-\-cached] [<common diff options>] <tree\-ish> [<path>...]
-
+\fIgit\-diff\-index\fR [\-m] [\-\-cached] [<common diff options>] <tree\-ish> [<path>\&...]
+.sp
 .SH "DESCRIPTION"
-
-
-Compares the content and mode of the blobs found via a tree object with the content of the current index and, optionally ignoring the stat state of the file on disk\&. When paths are specified, compares only those named paths\&. Otherwise all entries in the index are compared\&.
-
+Compares the content and mode of the blobs found via a tree object with the content of the current index and, optionally ignoring the stat state of the file on disk. When paths are specified, compares only those named paths. Otherwise all entries in the index are compared.
+.sp
 .SH "OPTIONS"
-
 .TP
 \-p
 Generate patch (see section on generating patches)
-
 .TP
 \-u
-Synonym for "\-p"\&.
-
+Synonym for "\-p".
 .TP
 \-\-raw
-Generate the raw format\&.
-
+Generate the raw format.
 .TP
 \-\-patch\-with\-raw
-Synonym for "\-p \-\-raw"\&.
-
+Synonym for "\-p \-\-raw".
 .TP
-\-\-stat
-Generate a diffstat\&.
-
+\-\-stat[=width[,name\-width]]
+Generate a diffstat. You can override the default output width for 80\-column terminal by "\-\-stat=width". The width of the filename part can be controlled by giving another width to it separated by a comma.
 .TP
 \-\-summary
-Output a condensed summary of extended header information such as creations, renames and mode changes\&.
-
+Output a condensed summary of extended header information such as creations, renames and mode changes.
 .TP
 \-\-patch\-with\-stat
-Synonym for "\-p \-\-stat"\&.
-
+Synonym for "\-p \-\-stat".
 .TP
 \-z
 \\0 line termination on output
-
 .TP
 \-\-name\-only
-Show only names of changed files\&.
-
+Show only names of changed files.
 .TP
 \-\-name\-status
-Show only names and status of changed files\&.
-
+Show only names and status of changed files.
 .TP
 \-\-color
-Show colored diff\&.
-
+Show colored diff.
 .TP
 \-\-no\-color
-Turn off colored diff, even when the configuration file gives the default to color output\&.
-
+Turn off colored diff, even when the configuration file gives the default to color output.
 .TP
 \-\-color\-words
-Show colored word diff, i\&.e\&. color words which have changed\&.
-
+Show colored word diff, i.e. color words which have changed.
 .TP
 \-\-no\-renames
-Turn off rename detection, even when the configuration file gives the default to do so\&.
-
+Turn off rename detection, even when the configuration file gives the default to do so.
 .TP
 \-\-full\-index
-Instead of the first handful characters, show full object name of pre\- and post\-image blob on the "index" line when generating a patch format output\&.
-
+Instead of the first handful characters, show full object name of pre\- and post\-image blob on the "index" line when generating a patch format output.
 .TP
 \-\-binary
-In addition to \-\-full\-index, output "binary diff" that can be applied with "git apply"\&.
-
+In addition to \-\-full\-index, output "binary diff" that can be applied with "git apply".
 .TP
 \-\-abbrev[=<n>]
-Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show only handful hexdigits prefix\&. This is independent of \-\-full\-index option above, which controls the diff\-patch output format\&. Non default number of digits can be specified with \-\-abbrev=<n>\&.
-
+Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show only handful hexdigits prefix. This is independent of \-\-full\-index option above, which controls the diff\-patch output format. Non default number of digits can be specified with \-\-abbrev=<n>.
 .TP
 \-B
-Break complete rewrite changes into pairs of delete and create\&.
-
+Break complete rewrite changes into pairs of delete and create.
 .TP
 \-M
-Detect renames\&.
-
+Detect renames.
 .TP
 \-C
-Detect copies as well as renames\&.
-
+Detect copies as well as renames.
 .TP
 \-\-diff\-filter=[ACDMRTUXB*]
-Select only files that are Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (mode) changed (T), are Unmerged (U), are Unknown (X), or have had their pairing Broken (B)\&. Any combination of the filter characters may be used\&. When * (All\-or\-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected\&.
-
+Select only files that are Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (mode) changed (T), are Unmerged (U), are Unknown (X), or have had their pairing Broken (B). Any combination of the filter characters may be used. When
+*
+(All\-or\-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected.
 .TP
 \-\-find\-copies\-harder
-For performance reasons, by default, \-C option finds copies only if the original file of the copy was modified in the same changeset\&. This flag makes the command inspect unmodified files as candidates for the source of copy\&. This is a very expensive operation for large projects, so use it with caution\&.
-
+For performance reasons, by default, \-C option finds copies only if the original file of the copy was modified in the same changeset. This flag makes the command inspect unmodified files as candidates for the source of copy. This is a very expensive operation for large projects, so use it with caution.
 .TP
 \-l<num>
-\-M and \-C options require O(n^2) processing time where n is the number of potential rename/copy targets\&. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified number\&.
-
+\-M and \-C options require O(n^2) processing time where n is the number of potential rename/copy targets. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified number.
 .TP
 \-S<string>
-Look for differences that contain the change in <string>\&.
-
+Look for differences that contain the change in <string>.
 .TP
 \-\-pickaxe\-all
-When \-S finds a change, show all the changes in that changeset, not just the files that contain the change in <string>\&.
-
+When \-S finds a change, show all the changes in that changeset, not just the files that contain the change in <string>.
 .TP
 \-\-pickaxe\-regex
-Make the <string> not a plain string but an extended POSIX regex to match\&.
-
+Make the <string> not a plain string but an extended POSIX regex to match.
 .TP
 \-O<orderfile>
-Output the patch in the order specified in the <orderfile>, which has one shell glob pattern per line\&.
-
+Output the patch in the order specified in the <orderfile>, which has one shell glob pattern per line.
 .TP
 \-R
-Swap two inputs; that is, show differences from index or on\-disk file to tree contents\&.
-
+Swap two inputs; that is, show differences from index or on\-disk file to tree contents.
 .TP
 \-\-text
-Treat all files as text\&.
-
+Treat all files as text.
 .TP
 \-a
-Shorthand for "\-\-text"\&.
-
-
-For more detailed explanation on these common options, see also diffcore documentation: \fIdiffcore.html\fR\&.
-
+Shorthand for "\-\-text".
+For more detailed explanation on these common options, see also [1]\&\fIdiffcore documentation\fR.
+.sp
 .TP
 <tree\-ish>
-The id of a tree object to diff against\&.
-
+The id of a tree object to diff against.
 .TP
 \-\-cached
 do not consider the on\-disk file at all
-
 .TP
 \-m
-By default, files recorded in the index but not checked out are reported as deleted\&. This flag makes "git\-diff\-index" say that all non\-checked\-out files are up to date\&.
-
+By default, files recorded in the index but not checked out are reported as deleted. This flag makes "git\-diff\-index" say that all non\-checked\-out files are up to date.
 .SH "OUTPUT FORMAT"
-
-
-The output format from "git\-diff\-index", "git\-diff\-tree" and "git\-diff\-files" are very similar\&.
-
-
+The output format from "git\-diff\-index", "git\-diff\-tree" and "git\-diff\-files" are very similar.
+.sp
 These commands all compare two sets of things; what is compared differs:
-
+.sp
 .TP
 git\-diff\-index <tree\-ish>
-compares the <tree\-ish> and the files on the filesystem\&.
-
+compares the <tree\-ish> and the files on the filesystem.
 .TP
 git\-diff\-index \-\-cached <tree\-ish>
-compares the <tree\-ish> and the index\&.
-
+compares the <tree\-ish> and the index.
 .TP
-git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>...]
-compares the trees named by the two arguments\&.
-
+git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>\&...]
+compares the trees named by the two arguments.
 .TP
-git\-diff\-files [<pattern>...]
-compares the index and the files on the filesystem\&.
-
-
+git\-diff\-files [<pattern>\&...]
+compares the index and the files on the filesystem.
 An output line is formatted this way:
-
+.sp
+.sp
 .nf
-in\-place edit  :100644 100644 bcd1234\&.\&.\&. 0123456\&.\&.\&. M file0
-copy\-edit      :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. C68 file1 file2
-rename\-edit    :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. R86 file1 file3
-create         :000000 100644 0000000\&.\&.\&. 1234567\&.\&.\&. A file4
-delete         :100644 000000 1234567\&.\&.\&. 0000000\&.\&.\&. D file5
-unmerged       :000000 000000 0000000\&.\&.\&. 0000000\&.\&.\&. U file6
+in\-place edit  :100644 100644 bcd1234... 0123456... M file0
+copy\-edit      :100644 100644 abcd123... 1234567... C68 file1 file2
+rename\-edit    :100644 100644 abcd123... 1234567... R86 file1 file3
+create         :000000 100644 0000000... 1234567... A file4
+delete         :100644 000000 1234567... 0000000... D file5
+unmerged       :000000 000000 0000000... 0000000... U file6
 .fi
-
-
 That is, from the left to the right:
-
+.sp
 .TP 3
 1.
-a colon\&.
+a colon.
 .TP
 2.
-mode for "src"; 000000 if creation or unmerged\&.
+mode for "src"; 000000 if creation or unmerged.
 .TP
 3.
-a space\&.
+a space.
 .TP
 4.
-mode for "dst"; 000000 if deletion or unmerged\&.
+mode for "dst"; 000000 if deletion or unmerged.
 .TP
 5.
-a space\&.
+a space.
 .TP
 6.
-sha1 for "src"; 0{40} if creation or unmerged\&.
+sha1 for "src"; 0{40} if creation or unmerged.
 .TP
 7.
-a space\&.
+a space.
 .TP
 8.
-sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree"\&.
+sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree".
 .TP
 9.
-a space\&.
+a space.
 .TP
 10.
-status, followed by optional "score" number\&.
+status, followed by optional "score" number.
 .TP
 11.
-a tab or a NUL when \fI\-z\fR option is used\&.
+a tab or a NUL when
+\fI\-z\fR
+option is used.
 .TP
 12.
 path for "src"
 .TP
 13.
-a tab or a NUL when \fI\-z\fR option is used; only exists for C or R\&.
+a tab or a NUL when
+\fI\-z\fR
+option is used; only exists for C or R.
 .TP
 14.
-path for "dst"; only exists for C or R\&.
+path for "dst"; only exists for C or R.
 .TP
 15.
-an LF or a NUL when \fI\-z\fR option is used, to terminate the record\&.
-.LP
-
-
-<sha1> is shown as all 0's if a file is new on the filesystem and it is out of sync with the index\&.
-
-
+an LF or a NUL when
+\fI\-z\fR
+option is used, to terminate the record.
+<sha1> is shown as all 0's if a file is new on the filesystem and it is out of sync with the index.
+.sp
 Example:
-
+.sp
+.sp
 .nf
-:100644 100644 5be4a4\&.\&.\&.\&.\&.\&. 000000\&.\&.\&.\&.\&.\&. M file\&.c
+:100644 100644 5be4a4...... 000000...... M file.c
 .fi
-
-
-When \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
-
-.SH "GENERATING PATCHES WITH -P"
-
-
-When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \fI\-p\fR option, they do not produce the output described above; instead they produce a patch file\&.
-
-
-The patch generation can be customized at two levels\&.
-
+When \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively.
+.sp
+.SH "GENERATING PATCHES WITH \-P"
+When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \fI\-p\fR option, they do not produce the output described above; instead they produce a patch file.
+.sp
+The patch generation can be customized at two levels.
+.sp
 .TP 3
 1.
-When the environment variable \fIGIT_EXTERNAL_DIFF\fR is not set, these commands internally invoke "diff" like this:
-
-
+When the environment variable
+\fIGIT_EXTERNAL_DIFF\fR
+is not set, these commands internally invoke "diff" like this:
+.sp
 .nf
 diff \-L a/<path> \-L b/<path> \-pu <old> <new>
 .fi
-For added files, /dev/null is used for <old>\&. For removed files, /dev/null is used for <new>
-
-The "diff" formatting options can be customized via the environment variable \fIGIT_DIFF_OPTS\fR\&. For example, if you prefer context diff:
-
+For added files,
+/dev/null
+is used for <old>. For removed files,
+/dev/null
+is used for <new>
+.sp
+The "diff" formatting options can be customized via the environment variable
+\fIGIT_DIFF_OPTS\fR. For example, if you prefer context diff:
+.sp
 .nf
 GIT_DIFF_OPTS=\-c git\-diff\-index \-p HEAD
 .fi
 .TP
 2.
-When the environment variable \fIGIT_EXTERNAL_DIFF\fR is set, the program named by it is called, instead of the diff invocation described above\&.
-
-For a path that is added, removed, or modified, \fIGIT_EXTERNAL_DIFF\fR is called with 7 parameters:
-
-
+When the environment variable
+\fIGIT_EXTERNAL_DIFF\fR
+is set, the program named by it is called, instead of the diff invocation described above.
+.sp
+For a path that is added, removed, or modified,
+\fIGIT_EXTERNAL_DIFF\fR
+is called with 7 parameters:
+.sp
 .nf
 path old\-file old\-hex old\-mode new\-file new\-hex new\-mode
 .fi
 where:
-
 <old|new>\-file
 
 are files GIT_EXTERNAL_DIFF can use to read the contents of <old|new>,
@@ -311,34 +260,54 @@ are the 40\-hexdigit SHA1 hashes,
 
 <old|new>\-mode
 
-are the octal representation of the file modes\&.
-
-The file parameters can point at the user's working file (e\&.g\&. new\-file in "git\-diff\-files"), /dev/null (e\&.g\&. old\-file when a new file is added), or a temporary file (e\&.g\&. old\-file in the index)\&. \fIGIT_EXTERNAL_DIFF\fR should not worry about unlinking the temporary file \-\-\- it is removed when \fIGIT_EXTERNAL_DIFF\fR exits\&.
-.LP
-
-
-For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, <path>\&.
-
+are the octal representation of the file modes.
+
+The file parameters can point at the user's working file (e.g.
+new\-file
+in "git\-diff\-files"),
+/dev/null
+(e.g.
+old\-file
+when a new file is added), or a temporary file (e.g.
+old\-file
+in the index).
+\fIGIT_EXTERNAL_DIFF\fR
+should not worry about unlinking the temporary file \-\-\- it is removed when
+\fIGIT_EXTERNAL_DIFF\fR
+exits.
+For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, <path>.
+.sp
 .SH "GIT SPECIFIC EXTENSION TO DIFF FORMAT"
-
-
-What \-p option produces is slightly different from the traditional diff format\&.
-
+What \-p option produces is slightly different from the traditional diff format.
+.sp
 .TP 3
 1.
 It is preceded with a "git diff" header, that looks like this:
-
-
+.sp
 .nf
 diff \-\-git a/file1 b/file2
 .fi
-The a/ and b/ filenames are the same unless rename/copy is involved\&. Especially, even for a creation or a deletion, /dev/null is _not_ used in place of a/ or b/ filenames\&.
-
-When rename/copy is involved, file1 and file2 show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively\&.
+The
+a/
+and
+b/
+filenames are the same unless rename/copy is involved. Especially, even for a creation or a deletion,
+/dev/null
+is _not_ used in place of
+a/
+or
+b/
+filenames.
+.sp
+When rename/copy is involved,
+file1
+and
+file2
+show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively.
 .TP
 2.
 It is followed by one or more extended header lines:
-
+.sp
 .nf
 old mode <mode>
 new mode <mode>
@@ -350,20 +319,20 @@ rename from <path>
 rename to <path>
 similarity index <number>
 dissimilarity index <number>
-index <hash>\&.\&.<hash> <mode>
+index <hash>..<hash> <mode>
 .fi
 .TP
 3.
-TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
-.LP
-
+TAB, LF, and backslash characters in pathnames are represented as
+\\t,
+\\n, and
+\\\\, respectively.
 .SH "COMBINED DIFF FORMAT"
-
-
 git\-diff\-tree and git\-diff\-files can take \fI\-c\fR or \fI\-\-cc\fR option to produce \fIcombined diff\fR, which looks like this:
-
+.sp
+.sp
 .nf
-diff \-\-combined describe\&.c
+diff \-\-combined describe.c
 @@@ +98,7 @@@
    return (a_date > b_date) ? \-1 : (a_date == b_date) ? 0 : 1;
   }
@@ -375,111 +344,90 @@ diff \-\-combined describe\&.c
  +     unsigned char sha1[20];
  +     struct commit *cmit;
 .fi
-
-
-Unlike the traditional \fIunified\fR diff format, which shows two files A and B with a single column that has \- (minus -- appears in A but removed in B), + (plus -- missing in A but added to B), or (space -- unchanged) prefix, this format compares two or more files file1, file2,... with one file X, and shows how X differs from each of fileN\&. One column for each of fileN is prepended to the output line to note how X's line is different from it\&.
-
-
-A \- character in the column N means that the line appears in fileN but it does not appear in the last file\&. A + character in the column N means that the line appears in the last file, and fileN does not have that line\&.
-
-
-In the above example output, the function signature was changed from both files (hence two \- removals from both file1 and file2, plus ++ to mean one line that was added does not appear in either file1 nor file2)\&. Also two other lines are the same from file1 but do not appear in file2 (hence prefixed with +)\&.
-
-
-When shown by git diff\-tree \-c, it compares the parents of a merge commit with the merge result (i\&.e\&. file1\&.\&.fileN are the parents)\&. When shown by git diff\-files \-c, it compares the two unresolved merge parents with the working tree file (i\&.e\&. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version")\&.
-
+Unlike the traditional \fIunified\fR diff format, which shows two files A and B with a single column that has \- (minus \(em appears in A but removed in B), + (plus \(em missing in A but added to B), or (space \(em unchanged) prefix, this format compares two or more files file1, file2,\&... with one file X, and shows how X differs from each of fileN. One column for each of fileN is prepended to the output line to note how X's line is different from it.
+.sp
+A \- character in the column N means that the line appears in fileN but it does not appear in the last file. A + character in the column N means that the line appears in the last file, and fileN does not have that line.
+.sp
+In the above example output, the function signature was changed from both files (hence two \- removals from both file1 and file2, plus ++ to mean one line that was added does not appear in either file1 nor file2). Also two other lines are the same from file1 but do not appear in file2 (hence prefixed with +).
+.sp
+When shown by git diff\-tree \-c, it compares the parents of a merge commit with the merge result (i.e. file1..fileN are the parents). When shown by git diff\-files \-c, it compares the two unresolved merge parents with the working tree file (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version").
+.sp
 .SH "OPERATING MODES"
-
-
-You can choose whether you want to trust the index file entirely (using the \fI\-\-cached\fR flag) or ask the diff logic to show any files that don't match the stat state as being "tentatively changed"\&. Both of these operations are very useful indeed\&.
-
+You can choose whether you want to trust the index file entirely (using the \fI\-\-cached\fR flag) or ask the diff logic to show any files that don't match the stat state as being "tentatively changed". Both of these operations are very useful indeed.
+.sp
 .SH "CACHED MODE"
-
-
 If \fI\-\-cached\fR is specified, it allows you to ask:
-
+.sp
+.sp
 .nf
 show me the differences between HEAD and the current index
 contents (the ones I'd write with a "git\-write\-tree")
 .fi
-
-
-For example, let's say that you have worked on your working directory, updated some files in the index and are ready to commit\&. You want to see exactly \fIwhat\fR you are going to commit is without having to write a new tree object and compare it that way, and to do that, you just do
-
+For example, let's say that you have worked on your working directory, updated some files in the index and are ready to commit. You want to see exactly \fBwhat\fR you are going to commit is without having to write a new tree object and compare it that way, and to do that, you just do
+.sp
+.sp
 .nf
 git\-diff\-index \-\-cached HEAD
 .fi
-
-
-Example: let's say I had renamed commit\&.c to git\-commit\&.c, and I had done an "git\-update\-index" to make that effective in the index file\&. "git\-diff\-files" wouldn't show anything at all, since the index file matches my working directory\&. But doing a "git\-diff\-index" does:
-
+Example: let's say I had renamed commit.c to git\-commit.c, and I had done an "git\-update\-index" to make that effective in the index file. "git\-diff\-files" wouldn't show anything at all, since the index file matches my working directory. But doing a "git\-diff\-index" does:
+.sp
+.sp
 .nf
 torvalds@ppc970:~/git> git\-diff\-index \-\-cached HEAD
-\-100644 blob    4161aecc6700a2eb579e842af0b7f22b98443f74        commit\&.c
-+100644 blob    4161aecc6700a2eb579e842af0b7f22b98443f74        git\-commit\&.c
+\-100644 blob    4161aecc6700a2eb579e842af0b7f22b98443f74        commit.c
++100644 blob    4161aecc6700a2eb579e842af0b7f22b98443f74        git\-commit.c
 .fi
-
-
-You can trivially see that the above is a rename\&.
-
-
-In fact, "git\-diff\-index \-\-cached" \fIshould\fR always be entirely equivalent to actually doing a "git\-write\-tree" and comparing that\&. Except this one is much nicer for the case where you just want to check where you are\&.
-
-
-So doing a "git\-diff\-index \-\-cached" is basically very useful when you are asking yourself "what have I already marked for being committed, and what's the difference to a previous tree"\&.
-
-.SH "NON-CACHED MODE"
-
-
-The "non\-cached" mode takes a different approach, and is potentially the more useful of the two in that what it does can't be emulated with a "git\-write\-tree" + "git\-diff\-tree"\&. Thus that's the default mode\&. The non\-cached version asks the question:
-
+You can trivially see that the above is a rename.
+.sp
+In fact, "git\-diff\-index \-\-cached" \fBshould\fR always be entirely equivalent to actually doing a "git\-write\-tree" and comparing that. Except this one is much nicer for the case where you just want to check where you are.
+.sp
+So doing a "git\-diff\-index \-\-cached" is basically very useful when you are asking yourself "what have I already marked for being committed, and what's the difference to a previous tree".
+.sp
+.SH "NON\-CACHED MODE"
+The "non\-cached" mode takes a different approach, and is potentially the more useful of the two in that what it does can't be emulated with a "git\-write\-tree" + "git\-diff\-tree". Thus that's the default mode. The non\-cached version asks the question:
+.sp
+.sp
 .nf
 show me the differences between HEAD and the currently checked out
 tree \- index contents _and_ files that aren't up\-to\-date
 .fi
-
-
-which is obviously a very useful question too, since that tells you what you \fIcould\fR commit\&. Again, the output matches the "git\-diff\-tree \-r" output to a tee, but with a twist\&.
-
-
-The twist is that if some file doesn't match the index, we don't have a backing store thing for it, and we use the magic "all\-zero" sha1 to show that\&. So let's say that you have edited kernel/sched\&.c, but have not actually done a "git\-update\-index" on it yet \- there is no "object" associated with the new state, and you get:
-
+which is obviously a very useful question too, since that tells you what you \fBcould\fR commit. Again, the output matches the "git\-diff\-tree \-r" output to a tee, but with a twist.
+.sp
+The twist is that if some file doesn't match the index, we don't have a backing store thing for it, and we use the magic "all\-zero" sha1 to show that. So let's say that you have edited kernel/sched.c, but have not actually done a "git\-update\-index" on it yet \- there is no "object" associated with the new state, and you get:
+.sp
+.sp
 .nf
-torvalds@ppc970:~/v2\&.6/linux> git\-diff\-index HEAD
-*100644\->100664 blob    7476bb\&.\&.\&.\&.\&.\&.\->000000\&.\&.\&.\&.\&.\&.      kernel/sched\&.c
+torvalds@ppc970:~/v2.6/linux> git\-diff\-index HEAD
+*100644\->100664 blob    7476bb......\->000000......      kernel/sched.c
 .fi
-
-
-i\&.e\&., it shows that the tree has changed, and that kernel/sched\&.c has is not up\-to\-date and may contain new stuff\&. The all\-zero sha1 means that to get the real diff, you need to look at the object in the working directory directly rather than do an object\-to\-object diff\&.
-
-.RS
-.Sh "Note"
-
-
-As with other commands of this type, "git\-diff\-index" does not actually look at the contents of the file at all\&. So maybe kernel/sched\&.c hasn't actually changed, and it's just that you touched it\&. In either case, it's a note that you need to "git\-update\-index" it to make the index be in sync\&.
-
-.RE
-
-.RS
-.Sh "Note"
-
-
-You can have a mixture of files show up as "has been updated" and "is still dirty in the working directory" together\&. You can always tell which file is in which state, since the "has been updated" ones show a valid sha1, and the "not in sync with the index" ones will always have the special all\-zero sha1\&.
-
-.RE
-
+i.e., it shows that the tree has changed, and that kernel/sched.c has is not up\-to\-date and may contain new stuff. The all\-zero sha1 means that to get the real diff, you need to look at the object in the working directory directly rather than do an object\-to\-object diff.
+.sp
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+\fBNote\fR
+As with other commands of this type, "git\-diff\-index" does not actually look at the contents of the file at all. So maybe kernel/sched.c hasn't actually changed, and it's just that you touched it. In either case, it's a note that you need to "git\-update\-index" it to make the index be in sync.
+.sp
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+\fBNote\fR
+You can have a mixture of files show up as "has been updated" and "is still dirty in the working directory" together. You can always tell which file is in which state, since the "has been updated" ones show a valid sha1, and the "not in sync with the index" ones will always have the special all\-zero sha1.
+.sp
 .SH "AUTHOR"
-
-
-Written by Linus Torvalds <torvalds@osdl\&.org>
-
+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>\&.
-
+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
+.SH "REFERENCES"
+.TP 3
+1.\ diffcore documentation
+\%diffcore.html
index 22d46b8a0df7a7009750c918544fddad2c52a54f..7e66c7bd1cc9e31e77c765fe84df331d653f171b 100755 (executable)
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "GIT-DIFF-STAGES" 1 "" "" ""
-.SH NAME
-git-diff-stages \- Compares content and mode of blobs between stages in an unmerged index file
+.\" ** 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\-DIFF\-STAGES" "1" "10/01/2006" "" ""
+.\" 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
 .SH "SYNOPSIS"
-
-
-\fIgit\-diff\-stages\fR [<common diff options>] <stage1> <stage2> [<path>...]
-
+\fIgit\-diff\-stages\fR [<common diff options>] <stage1> <stage2> [<path>\&...]
+.sp
 .SH "DESCRIPTION"
-
-
-Compares the content and mode of the blobs in two stages in an unmerged index file\&.
-
+Compares the content and mode of the blobs in two stages in an unmerged index file.
+.sp
 .SH "OPTIONS"
-
 .TP
 \-p
 Generate patch (see section on generating patches)
-
 .TP
 \-u
-Synonym for "\-p"\&.
-
+Synonym for "\-p".
 .TP
 \-\-raw
-Generate the raw format\&.
-
+Generate the raw format.
 .TP
 \-\-patch\-with\-raw
-Synonym for "\-p \-\-raw"\&.
-
+Synonym for "\-p \-\-raw".
 .TP
-\-\-stat
-Generate a diffstat\&.
-
+\-\-stat[=width[,name\-width]]
+Generate a diffstat. You can override the default output width for 80\-column terminal by "\-\-stat=width". The width of the filename part can be controlled by giving another width to it separated by a comma.
 .TP
 \-\-summary
-Output a condensed summary of extended header information such as creations, renames and mode changes\&.
-
+Output a condensed summary of extended header information such as creations, renames and mode changes.
 .TP
 \-\-patch\-with\-stat
-Synonym for "\-p \-\-stat"\&.
-
+Synonym for "\-p \-\-stat".
 .TP
 \-z
 \\0 line termination on output
-
 .TP
 \-\-name\-only
-Show only names of changed files\&.
-
+Show only names of changed files.
 .TP
 \-\-name\-status
-Show only names and status of changed files\&.
-
+Show only names and status of changed files.
 .TP
 \-\-color
-Show colored diff\&.
-
+Show colored diff.
 .TP
 \-\-no\-color
-Turn off colored diff, even when the configuration file gives the default to color output\&.
-
+Turn off colored diff, even when the configuration file gives the default to color output.
 .TP
 \-\-color\-words
-Show colored word diff, i\&.e\&. color words which have changed\&.
-
+Show colored word diff, i.e. color words which have changed.
 .TP
 \-\-no\-renames
-Turn off rename detection, even when the configuration file gives the default to do so\&.
-
+Turn off rename detection, even when the configuration file gives the default to do so.
 .TP
 \-\-full\-index
-Instead of the first handful characters, show full object name of pre\- and post\-image blob on the "index" line when generating a patch format output\&.
-
+Instead of the first handful characters, show full object name of pre\- and post\-image blob on the "index" line when generating a patch format output.
 .TP
 \-\-binary
-In addition to \-\-full\-index, output "binary diff" that can be applied with "git apply"\&.
-
+In addition to \-\-full\-index, output "binary diff" that can be applied with "git apply".
 .TP
 \-\-abbrev[=<n>]
-Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show only handful hexdigits prefix\&. This is independent of \-\-full\-index option above, which controls the diff\-patch output format\&. Non default number of digits can be specified with \-\-abbrev=<n>\&.
-
+Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show only handful hexdigits prefix. This is independent of \-\-full\-index option above, which controls the diff\-patch output format. Non default number of digits can be specified with \-\-abbrev=<n>.
 .TP
 \-B
-Break complete rewrite changes into pairs of delete and create\&.
-
+Break complete rewrite changes into pairs of delete and create.
 .TP
 \-M
-Detect renames\&.
-
+Detect renames.
 .TP
 \-C
-Detect copies as well as renames\&.
-
+Detect copies as well as renames.
 .TP
 \-\-diff\-filter=[ACDMRTUXB*]
-Select only files that are Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (mode) changed (T), are Unmerged (U), are Unknown (X), or have had their pairing Broken (B)\&. Any combination of the filter characters may be used\&. When * (All\-or\-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected\&.
-
+Select only files that are Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (mode) changed (T), are Unmerged (U), are Unknown (X), or have had their pairing Broken (B). Any combination of the filter characters may be used. When
+*
+(All\-or\-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected.
 .TP
 \-\-find\-copies\-harder
-For performance reasons, by default, \-C option finds copies only if the original file of the copy was modified in the same changeset\&. This flag makes the command inspect unmodified files as candidates for the source of copy\&. This is a very expensive operation for large projects, so use it with caution\&.
-
+For performance reasons, by default, \-C option finds copies only if the original file of the copy was modified in the same changeset. This flag makes the command inspect unmodified files as candidates for the source of copy. This is a very expensive operation for large projects, so use it with caution.
 .TP
 \-l<num>
-\-M and \-C options require O(n^2) processing time where n is the number of potential rename/copy targets\&. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified number\&.
-
+\-M and \-C options require O(n^2) processing time where n is the number of potential rename/copy targets. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified number.
 .TP
 \-S<string>
-Look for differences that contain the change in <string>\&.
-
+Look for differences that contain the change in <string>.
 .TP
 \-\-pickaxe\-all
-When \-S finds a change, show all the changes in that changeset, not just the files that contain the change in <string>\&.
-
+When \-S finds a change, show all the changes in that changeset, not just the files that contain the change in <string>.
 .TP
 \-\-pickaxe\-regex
-Make the <string> not a plain string but an extended POSIX regex to match\&.
-
+Make the <string> not a plain string but an extended POSIX regex to match.
 .TP
 \-O<orderfile>
-Output the patch in the order specified in the <orderfile>, which has one shell glob pattern per line\&.
-
+Output the patch in the order specified in the <orderfile>, which has one shell glob pattern per line.
 .TP
 \-R
-Swap two inputs; that is, show differences from index or on\-disk file to tree contents\&.
-
+Swap two inputs; that is, show differences from index or on\-disk file to tree contents.
 .TP
 \-\-text
-Treat all files as text\&.
-
+Treat all files as text.
 .TP
 \-a
-Shorthand for "\-\-text"\&.
-
-
-For more detailed explanation on these common options, see also diffcore documentation: \fIdiffcore.html\fR\&.
-
+Shorthand for "\-\-text".
+For more detailed explanation on these common options, see also [1]\&\fIdiffcore documentation\fR.
+.sp
 .TP
 <stage1>,<stage2>
-The stage number to be compared\&.
-
+The stage number to be compared.
 .SH "OUTPUT FORMAT"
-
-
-The output format from "git\-diff\-index", "git\-diff\-tree" and "git\-diff\-files" are very similar\&.
-
-
+The output format from "git\-diff\-index", "git\-diff\-tree" and "git\-diff\-files" are very similar.
+.sp
 These commands all compare two sets of things; what is compared differs:
-
+.sp
 .TP
 git\-diff\-index <tree\-ish>
-compares the <tree\-ish> and the files on the filesystem\&.
-
+compares the <tree\-ish> and the files on the filesystem.
 .TP
 git\-diff\-index \-\-cached <tree\-ish>
-compares the <tree\-ish> and the index\&.
-
+compares the <tree\-ish> and the index.
 .TP
-git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>...]
-compares the trees named by the two arguments\&.
-
+git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>\&...]
+compares the trees named by the two arguments.
 .TP
-git\-diff\-files [<pattern>...]
-compares the index and the files on the filesystem\&.
-
-
+git\-diff\-files [<pattern>\&...]
+compares the index and the files on the filesystem.
 An output line is formatted this way:
-
+.sp
+.sp
 .nf
-in\-place edit  :100644 100644 bcd1234\&.\&.\&. 0123456\&.\&.\&. M file0
-copy\-edit      :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. C68 file1 file2
-rename\-edit    :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. R86 file1 file3
-create         :000000 100644 0000000\&.\&.\&. 1234567\&.\&.\&. A file4
-delete         :100644 000000 1234567\&.\&.\&. 0000000\&.\&.\&. D file5
-unmerged       :000000 000000 0000000\&.\&.\&. 0000000\&.\&.\&. U file6
+in\-place edit  :100644 100644 bcd1234... 0123456... M file0
+copy\-edit      :100644 100644 abcd123... 1234567... C68 file1 file2
+rename\-edit    :100644 100644 abcd123... 1234567... R86 file1 file3
+create         :000000 100644 0000000... 1234567... A file4
+delete         :100644 000000 1234567... 0000000... D file5
+unmerged       :000000 000000 0000000... 0000000... U file6
 .fi
-
-
 That is, from the left to the right:
-
+.sp
 .TP 3
 1.
-a colon\&.
+a colon.
 .TP
 2.
-mode for "src"; 000000 if creation or unmerged\&.
+mode for "src"; 000000 if creation or unmerged.
 .TP
 3.
-a space\&.
+a space.
 .TP
 4.
-mode for "dst"; 000000 if deletion or unmerged\&.
+mode for "dst"; 000000 if deletion or unmerged.
 .TP
 5.
-a space\&.
+a space.
 .TP
 6.
-sha1 for "src"; 0{40} if creation or unmerged\&.
+sha1 for "src"; 0{40} if creation or unmerged.
 .TP
 7.
-a space\&.
+a space.
 .TP
 8.
-sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree"\&.
+sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree".
 .TP
 9.
-a space\&.
+a space.
 .TP
 10.
-status, followed by optional "score" number\&.
+status, followed by optional "score" number.
 .TP
 11.
-a tab or a NUL when \fI\-z\fR option is used\&.
+a tab or a NUL when
+\fI\-z\fR
+option is used.
 .TP
 12.
 path for "src"
 .TP
 13.
-a tab or a NUL when \fI\-z\fR option is used; only exists for C or R\&.
+a tab or a NUL when
+\fI\-z\fR
+option is used; only exists for C or R.
 .TP
 14.
-path for "dst"; only exists for C or R\&.
+path for "dst"; only exists for C or R.
 .TP
 15.
-an LF or a NUL when \fI\-z\fR option is used, to terminate the record\&.
-.LP
-
-
-<sha1> is shown as all 0's if a file is new on the filesystem and it is out of sync with the index\&.
-
-
+an LF or a NUL when
+\fI\-z\fR
+option is used, to terminate the record.
+<sha1> is shown as all 0's if a file is new on the filesystem and it is out of sync with the index.
+.sp
 Example:
-
+.sp
+.sp
 .nf
-:100644 100644 5be4a4\&.\&.\&.\&.\&.\&. 000000\&.\&.\&.\&.\&.\&. M file\&.c
+:100644 100644 5be4a4...... 000000...... M file.c
 .fi
-
-
-When \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
-
-.SH "GENERATING PATCHES WITH -P"
-
-
-When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \fI\-p\fR option, they do not produce the output described above; instead they produce a patch file\&.
-
-
-The patch generation can be customized at two levels\&.
-
+When \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively.
+.sp
+.SH "GENERATING PATCHES WITH \-P"
+When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \fI\-p\fR option, they do not produce the output described above; instead they produce a patch file.
+.sp
+The patch generation can be customized at two levels.
+.sp
 .TP 3
 1.
-When the environment variable \fIGIT_EXTERNAL_DIFF\fR is not set, these commands internally invoke "diff" like this:
-
-
+When the environment variable
+\fIGIT_EXTERNAL_DIFF\fR
+is not set, these commands internally invoke "diff" like this:
+.sp
 .nf
 diff \-L a/<path> \-L b/<path> \-pu <old> <new>
 .fi
-For added files, /dev/null is used for <old>\&. For removed files, /dev/null is used for <new>
-
-The "diff" formatting options can be customized via the environment variable \fIGIT_DIFF_OPTS\fR\&. For example, if you prefer context diff:
-
+For added files,
+/dev/null
+is used for <old>. For removed files,
+/dev/null
+is used for <new>
+.sp
+The "diff" formatting options can be customized via the environment variable
+\fIGIT_DIFF_OPTS\fR. For example, if you prefer context diff:
+.sp
 .nf
 GIT_DIFF_OPTS=\-c git\-diff\-index \-p HEAD
 .fi
 .TP
 2.
-When the environment variable \fIGIT_EXTERNAL_DIFF\fR is set, the program named by it is called, instead of the diff invocation described above\&.
-
-For a path that is added, removed, or modified, \fIGIT_EXTERNAL_DIFF\fR is called with 7 parameters:
-
-
+When the environment variable
+\fIGIT_EXTERNAL_DIFF\fR
+is set, the program named by it is called, instead of the diff invocation described above.
+.sp
+For a path that is added, removed, or modified,
+\fIGIT_EXTERNAL_DIFF\fR
+is called with 7 parameters:
+.sp
 .nf
 path old\-file old\-hex old\-mode new\-file new\-hex new\-mode
 .fi
 where:
-
 <old|new>\-file
 
 are files GIT_EXTERNAL_DIFF can use to read the contents of <old|new>,
@@ -303,34 +254,54 @@ are the 40\-hexdigit SHA1 hashes,
 
 <old|new>\-mode
 
-are the octal representation of the file modes\&.
-
-The file parameters can point at the user's working file (e\&.g\&. new\-file in "git\-diff\-files"), /dev/null (e\&.g\&. old\-file when a new file is added), or a temporary file (e\&.g\&. old\-file in the index)\&. \fIGIT_EXTERNAL_DIFF\fR should not worry about unlinking the temporary file \-\-\- it is removed when \fIGIT_EXTERNAL_DIFF\fR exits\&.
-.LP
-
-
-For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, <path>\&.
-
+are the octal representation of the file modes.
+
+The file parameters can point at the user's working file (e.g.
+new\-file
+in "git\-diff\-files"),
+/dev/null
+(e.g.
+old\-file
+when a new file is added), or a temporary file (e.g.
+old\-file
+in the index).
+\fIGIT_EXTERNAL_DIFF\fR
+should not worry about unlinking the temporary file \-\-\- it is removed when
+\fIGIT_EXTERNAL_DIFF\fR
+exits.
+For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, <path>.
+.sp
 .SH "GIT SPECIFIC EXTENSION TO DIFF FORMAT"
-
-
-What \-p option produces is slightly different from the traditional diff format\&.
-
+What \-p option produces is slightly different from the traditional diff format.
+.sp
 .TP 3
 1.
 It is preceded with a "git diff" header, that looks like this:
-
-
+.sp
 .nf
 diff \-\-git a/file1 b/file2
 .fi
-The a/ and b/ filenames are the same unless rename/copy is involved\&. Especially, even for a creation or a deletion, /dev/null is _not_ used in place of a/ or b/ filenames\&.
-
-When rename/copy is involved, file1 and file2 show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively\&.
+The
+a/
+and
+b/
+filenames are the same unless rename/copy is involved. Especially, even for a creation or a deletion,
+/dev/null
+is _not_ used in place of
+a/
+or
+b/
+filenames.
+.sp
+When rename/copy is involved,
+file1
+and
+file2
+show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively.
 .TP
 2.
 It is followed by one or more extended header lines:
-
+.sp
 .nf
 old mode <mode>
 new mode <mode>
@@ -342,20 +313,20 @@ rename from <path>
 rename to <path>
 similarity index <number>
 dissimilarity index <number>
-index <hash>\&.\&.<hash> <mode>
+index <hash>..<hash> <mode>
 .fi
 .TP
 3.
-TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
-.LP
-
+TAB, LF, and backslash characters in pathnames are represented as
+\\t,
+\\n, and
+\\\\, respectively.
 .SH "COMBINED DIFF FORMAT"
-
-
 git\-diff\-tree and git\-diff\-files can take \fI\-c\fR or \fI\-\-cc\fR option to produce \fIcombined diff\fR, which looks like this:
-
+.sp
+.sp
 .nf
-diff \-\-combined describe\&.c
+diff \-\-combined describe.c
 @@@ +98,7 @@@
    return (a_date > b_date) ? \-1 : (a_date == b_date) ? 0 : 1;
   }
@@ -367,31 +338,24 @@ diff \-\-combined describe\&.c
  +     unsigned char sha1[20];
  +     struct commit *cmit;
 .fi
-
-
-Unlike the traditional \fIunified\fR diff format, which shows two files A and B with a single column that has \- (minus -- appears in A but removed in B), + (plus -- missing in A but added to B), or (space -- unchanged) prefix, this format compares two or more files file1, file2,... with one file X, and shows how X differs from each of fileN\&. One column for each of fileN is prepended to the output line to note how X's line is different from it\&.
-
-
-A \- character in the column N means that the line appears in fileN but it does not appear in the last file\&. A + character in the column N means that the line appears in the last file, and fileN does not have that line\&.
-
-
-In the above example output, the function signature was changed from both files (hence two \- removals from both file1 and file2, plus ++ to mean one line that was added does not appear in either file1 nor file2)\&. Also two other lines are the same from file1 but do not appear in file2 (hence prefixed with +)\&.
-
-
-When shown by git diff\-tree \-c, it compares the parents of a merge commit with the merge result (i\&.e\&. file1\&.\&.fileN are the parents)\&. When shown by git diff\-files \-c, it compares the two unresolved merge parents with the working tree file (i\&.e\&. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version")\&.
-
+Unlike the traditional \fIunified\fR diff format, which shows two files A and B with a single column that has \- (minus \(em appears in A but removed in B), + (plus \(em missing in A but added to B), or (space \(em unchanged) prefix, this format compares two or more files file1, file2,\&... with one file X, and shows how X differs from each of fileN. One column for each of fileN is prepended to the output line to note how X's line is different from it.
+.sp
+A \- character in the column N means that the line appears in fileN but it does not appear in the last file. A + character in the column N means that the line appears in the last file, and fileN does not have that line.
+.sp
+In the above example output, the function signature was changed from both files (hence two \- removals from both file1 and file2, plus ++ to mean one line that was added does not appear in either file1 nor file2). Also two other lines are the same from file1 but do not appear in file2 (hence prefixed with +).
+.sp
+When shown by git diff\-tree \-c, it compares the parents of a merge commit with the merge result (i.e. file1..fileN are the parents). When shown by git diff\-files \-c, it compares the two unresolved merge parents with the working tree file (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version").
+.sp
 .SH "AUTHOR"
-
-
-Written by Junio C Hamano <junkio@cox\&.net>
-
+Written by Junio C Hamano <junkio@cox.net>
+.sp
 .SH "DOCUMENTATION"
-
-
-Documentation by Junio C Hamano\&.
-
+Documentation by Junio C Hamano.
+.sp
 .SH "GIT"
-
-
 Part of the \fBgit\fR(7) suite
-
+.sp
+.SH "REFERENCES"
+.TP 3
+1.\ diffcore documentation
+\%diffcore.html
index fe06053cc9092ba77167f885cf3ca593b853645a..6411e64b171099b4134c178beffcbe6a7473a063 100755 (executable)
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "GIT-DIFF-TREE" 1 "" "" ""
-.SH NAME
-git-diff-tree \- Compares the content and mode of blobs found via two tree objects
+.\" ** 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\-DIFF\-TREE" "1" "10/01/2006" "" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+git\-diff\-tree \- Compares the content and mode of blobs found via two tree objects
 .SH "SYNOPSIS"
-
+.sp
 .nf
 \fIgit\-diff\-tree\fR [\-\-stdin] [\-m] [\-s] [\-v] [\-\-no\-commit\-id] [\-\-pretty]
               [\-t] [\-r] [\-c | \-\-cc] [\-\-root] [<common diff options>]
-              <tree\-ish> [<tree\-ish>] [<path>...]
+              <tree\-ish> [<tree\-ish>] [<path>\&...]
 .fi
-
 .SH "DESCRIPTION"
-
-
-Compares the content and mode of the blobs found via two tree objects\&.
-
-
-If there is only one <tree\-ish> given, the commit is compared with its parents (see \-\-stdin below)\&.
-
-
-Note that "git\-diff\-tree" can use the tree encapsulated in a commit object\&.
-
+Compares the content and mode of the blobs found via two tree objects.
+.sp
+If there is only one <tree\-ish> given, the commit is compared with its parents (see \-\-stdin below).
+.sp
+Note that "git\-diff\-tree" can use the tree encapsulated in a commit object.
+.sp
 .SH "OPTIONS"
-
 .TP
 \-p
 Generate patch (see section on generating patches)
-
 .TP
 \-u
-Synonym for "\-p"\&.
-
+Synonym for "\-p".
 .TP
 \-\-raw
-Generate the raw format\&.
-
+Generate the raw format.
 .TP
 \-\-patch\-with\-raw
-Synonym for "\-p \-\-raw"\&.
-
+Synonym for "\-p \-\-raw".
 .TP
-\-\-stat
-Generate a diffstat\&.
-
+\-\-stat[=width[,name\-width]]
+Generate a diffstat. You can override the default output width for 80\-column terminal by "\-\-stat=width". The width of the filename part can be controlled by giving another width to it separated by a comma.
 .TP
 \-\-summary
-Output a condensed summary of extended header information such as creations, renames and mode changes\&.
-
+Output a condensed summary of extended header information such as creations, renames and mode changes.
 .TP
 \-\-patch\-with\-stat
-Synonym for "\-p \-\-stat"\&.
-
+Synonym for "\-p \-\-stat".
 .TP
 \-z
 \\0 line termination on output
-
 .TP
 \-\-name\-only
-Show only names of changed files\&.
-
+Show only names of changed files.
 .TP
 \-\-name\-status
-Show only names and status of changed files\&.
-
+Show only names and status of changed files.
 .TP
 \-\-color
-Show colored diff\&.
-
+Show colored diff.
 .TP
 \-\-no\-color
-Turn off colored diff, even when the configuration file gives the default to color output\&.
-
+Turn off colored diff, even when the configuration file gives the default to color output.
 .TP
 \-\-color\-words
-Show colored word diff, i\&.e\&. color words which have changed\&.
-
+Show colored word diff, i.e. color words which have changed.
 .TP
 \-\-no\-renames
-Turn off rename detection, even when the configuration file gives the default to do so\&.
-
+Turn off rename detection, even when the configuration file gives the default to do so.
 .TP
 \-\-full\-index
-Instead of the first handful characters, show full object name of pre\- and post\-image blob on the "index" line when generating a patch format output\&.
-
+Instead of the first handful characters, show full object name of pre\- and post\-image blob on the "index" line when generating a patch format output.
 .TP
 \-\-binary
-In addition to \-\-full\-index, output "binary diff" that can be applied with "git apply"\&.
-
+In addition to \-\-full\-index, output "binary diff" that can be applied with "git apply".
 .TP
 \-\-abbrev[=<n>]
-Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show only handful hexdigits prefix\&. This is independent of \-\-full\-index option above, which controls the diff\-patch output format\&. Non default number of digits can be specified with \-\-abbrev=<n>\&.
-
+Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show only handful hexdigits prefix. This is independent of \-\-full\-index option above, which controls the diff\-patch output format. Non default number of digits can be specified with \-\-abbrev=<n>.
 .TP
 \-B
-Break complete rewrite changes into pairs of delete and create\&.
-
+Break complete rewrite changes into pairs of delete and create.
 .TP
 \-M
-Detect renames\&.
-
+Detect renames.
 .TP
 \-C
-Detect copies as well as renames\&.
-
+Detect copies as well as renames.
 .TP
 \-\-diff\-filter=[ACDMRTUXB*]
-Select only files that are Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (mode) changed (T), are Unmerged (U), are Unknown (X), or have had their pairing Broken (B)\&. Any combination of the filter characters may be used\&. When * (All\-or\-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected\&.
-
+Select only files that are Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (mode) changed (T), are Unmerged (U), are Unknown (X), or have had their pairing Broken (B). Any combination of the filter characters may be used. When
+*
+(All\-or\-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected.
 .TP
 \-\-find\-copies\-harder
-For performance reasons, by default, \-C option finds copies only if the original file of the copy was modified in the same changeset\&. This flag makes the command inspect unmodified files as candidates for the source of copy\&. This is a very expensive operation for large projects, so use it with caution\&.
-
+For performance reasons, by default, \-C option finds copies only if the original file of the copy was modified in the same changeset. This flag makes the command inspect unmodified files as candidates for the source of copy. This is a very expensive operation for large projects, so use it with caution.
 .TP
 \-l<num>
-\-M and \-C options require O(n^2) processing time where n is the number of potential rename/copy targets\&. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified number\&.
-
+\-M and \-C options require O(n^2) processing time where n is the number of potential rename/copy targets. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified number.
 .TP
 \-S<string>
-Look for differences that contain the change in <string>\&.
-
+Look for differences that contain the change in <string>.
 .TP
 \-\-pickaxe\-all
-When \-S finds a change, show all the changes in that changeset, not just the files that contain the change in <string>\&.
-
+When \-S finds a change, show all the changes in that changeset, not just the files that contain the change in <string>.
 .TP
 \-\-pickaxe\-regex
-Make the <string> not a plain string but an extended POSIX regex to match\&.
-
+Make the <string> not a plain string but an extended POSIX regex to match.
 .TP
 \-O<orderfile>
-Output the patch in the order specified in the <orderfile>, which has one shell glob pattern per line\&.
-
+Output the patch in the order specified in the <orderfile>, which has one shell glob pattern per line.
 .TP
 \-R
-Swap two inputs; that is, show differences from index or on\-disk file to tree contents\&.
-
+Swap two inputs; that is, show differences from index or on\-disk file to tree contents.
 .TP
 \-\-text
-Treat all files as text\&.
-
+Treat all files as text.
 .TP
 \-a
-Shorthand for "\-\-text"\&.
-
-
-For more detailed explanation on these common options, see also diffcore documentation: \fIdiffcore.html\fR\&.
-
+Shorthand for "\-\-text".
+For more detailed explanation on these common options, see also [1]\&\fIdiffcore documentation\fR.
+.sp
 .TP
 <tree\-ish>
-The id of a tree object\&.
-
+The id of a tree object.
 .TP
-<path>...
-If provided, the results are limited to a subset of files matching one of these prefix strings\&. i\&.e\&., file matches /^<pattern1>|<pattern2>|.../ Note that this parameter does not provide any wildcard or regexp features\&.
-
+<path>\&...
+If provided, the results are limited to a subset of files matching one of these prefix strings. i.e., file matches
+/^<pattern1>|<pattern2>|\&.../
+Note that this parameter does not provide any wildcard or regexp features.
 .TP
 \-r
 recurse into sub\-trees
-
 .TP
 \-t
-show tree entry itself as well as subtrees\&. Implies \-r\&.
-
+show tree entry itself as well as subtrees. Implies \-r.
 .TP
 \-\-root
-When \fI\-\-root\fR is specified the initial commit will be showed as a big creation event\&. This is equivalent to a diff against the NULL tree\&.
-
+When
+\fI\-\-root\fR
+is specified the initial commit will be showed as a big creation event. This is equivalent to a diff against the NULL tree.
 .TP
 \-\-stdin
-When \fI\-\-stdin\fR is specified, the command does not take <tree\-ish> arguments from the command line\&. Instead, it reads either one <commit> or a pair of <tree\-ish> separated with a single space from its standard input\&.
-
-When a single commit is given on one line of such input, it compares the commit with its parents\&. The following flags further affects its behavior\&. This does not apply to the case where two <tree\-ish> separated with a single space are given\&.
-
+When
+\fI\-\-stdin\fR
+is specified, the command does not take <tree\-ish> arguments from the command line. Instead, it reads either one <commit> or a pair of <tree\-ish> separated with a single space from its standard input.
+.sp
+When a single commit is given on one line of such input, it compares the commit with its parents. The following flags further affects its behavior. This does not apply to the case where two <tree\-ish> separated with a single space are given.
 .TP
 \-m
-By default, "git\-diff\-tree \-\-stdin" does not show differences for merge commits\&. With this flag, it shows differences to that commit from all of its parents\&. See also \fI\-c\fR\&.
-
+By default, "git\-diff\-tree \-\-stdin" does not show differences for merge commits. With this flag, it shows differences to that commit from all of its parents. See also
+\fI\-c\fR.
 .TP
 \-s
-By default, "git\-diff\-tree \-\-stdin" shows differences, either in machine\-readable form (without \fI\-p\fR) or in patch form (with \fI\-p\fR)\&. This output can be suppressed\&. It is only useful with \fI\-v\fR flag\&.
-
+By default, "git\-diff\-tree \-\-stdin" shows differences, either in machine\-readable form (without
+\fI\-p\fR) or in patch form (with
+\fI\-p\fR). This output can be suppressed. It is only useful with
+\fI\-v\fR
+flag.
 .TP
 \-v
-This flag causes "git\-diff\-tree \-\-stdin" to also show the commit message before the differences\&.
-
+This flag causes "git\-diff\-tree \-\-stdin" to also show the commit message before the differences.
 .TP
 \-\-pretty[=(raw|medium|short)]
-This is used to control "pretty printing" format of the commit message\&. Without "=<style>", it defaults to medium\&.
-
+This is used to control "pretty printing" format of the commit message. Without "=<style>", it defaults to medium.
 .TP
 \-\-no\-commit\-id
-git\-diff\-tree outputs a line with the commit ID when applicable\&. This flag suppressed the commit ID output\&.
-
+git\-diff\-tree outputs a line with the commit ID when applicable. This flag suppressed the commit ID output.
 .TP
 \-c
-This flag changes the way a merge commit is displayed (which means it is useful only when the command is given one <tree\-ish>, or \fI\-\-stdin\fR)\&. It shows the differences from each of the parents to the merge result simultaneously instead of showing pairwise diff between a parent and the result one at a time (which is what the \fI\-m\fR option does)\&. Furthermore, it lists only files which were modified from all parents\&.
-
+This flag changes the way a merge commit is displayed (which means it is useful only when the command is given one <tree\-ish>, or
+\fI\-\-stdin\fR). It shows the differences from each of the parents to the merge result simultaneously instead of showing pairwise diff between a parent and the result one at a time (which is what the
+\fI\-m\fR
+option does). Furthermore, it lists only files which were modified from all parents.
 .TP
 \-\-cc
-This flag changes the way a merge commit patch is displayed, in a similar way to the \fI\-c\fR option\&. It implies the \fI\-c\fR and \fI\-p\fR options and further compresses the patch output by omitting hunks that show differences from only one parent, or show the same change from all but one parent for an Octopus merge\&. When this optimization makes all hunks disappear, the commit itself and the commit log message is not shown, just like in any other "empty diff" case\&.
-
+This flag changes the way a merge commit patch is displayed, in a similar way to the
+\fI\-c\fR
+option. It implies the
+\fI\-c\fR
+and
+\fI\-p\fR
+options and further compresses the patch output by omitting hunks that show differences from only one parent, or show the same change from all but one parent for an Octopus merge. When this optimization makes all hunks disappear, the commit itself and the commit log message is not shown, just like in any other "empty diff" case.
 .TP
 \-\-always
-Show the commit itself and the commit log message even if the diff itself is empty\&.
-
+Show the commit itself and the commit log message even if the diff itself is empty.
 .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
+.sp
 .nf
 git\-diff\-tree \-r <tree\-ish> <tree\-ish> arch/ia64 include/asm\-ia64
 .fi
-
-
-and it will only show you what changed in those two directories\&.
-
-
-Or if you are searching for what changed in just kernel/sched\&.c, just do
-
+and it will only show you what changed in those two directories.
+.sp
+Or if you are searching for what changed in just kernel/sched.c, just do
+.sp
+.sp
 .nf
-git\-diff\-tree \-r <tree\-ish> <tree\-ish> kernel/sched\&.c
+git\-diff\-tree \-r <tree\-ish> <tree\-ish> kernel/sched.c
 .fi
-
-
-and it will ignore all differences to other files\&.
-
-
-The pattern is always the prefix, and is matched exactly\&. There are no wildcards\&. Even stricter, it has to match a complete path component\&. I\&.e\&. "foo" does not pick up foobar\&.h\&. "foo" does match foo/bar\&.h so it can be used to name subdirectories\&.
-
-
+and it will ignore all differences to other files.
+.sp
+The pattern is always the prefix, and is matched exactly. There are no wildcards. Even stricter, it has to match a complete path component. I.e. "foo" does not pick up foobar.h. "foo" does match foo/bar.h so it can be used to name subdirectories.
+.sp
 An example of normal usage is:
-
+.sp
+.sp
 .nf
-torvalds@ppc970:~/git> git\-diff\-tree 5319e4\&.\&.\&.\&.\&.\&.
-*100664\->100664 blob    ac348b\&.\&.\&.\&.\&.\&.\&.\->a01513\&.\&.\&.\&.\&.\&.\&.      git\-fsck\-objects\&.c
+torvalds@ppc970:~/git> git\-diff\-tree 5319e4......
+*100664\->100664 blob    ac348b.......\->a01513.......      git\-fsck\-objects.c
 .fi
-
-
 which tells you that the last commit changed just one file (it's from this one:
-
+.sp
+.sp
 .nf
 commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8
 tree 5319e4d609cdd282069cc4dce33c1db559539b03
 parent b4e628ea30d5ab3606119d2ea5caeab141d38df7
-author Linus Torvalds <torvalds@ppc970\&.osdl\&.org> Sat Apr 9 12:02:30 2005
-committer Linus Torvalds <torvalds@ppc970\&.osdl\&.org> Sat Apr 9 12:02:30 2005
+author Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
+committer Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
 
-Make "git\-fsck\-objects" print out all the root commits it finds\&.
+Make "git\-fsck\-objects" print out all the root commits it finds.
 
 Once I do the reference tracking, I'll also make it print out all the
-HEAD commits it finds, which is even more interesting\&.
+HEAD commits it finds, which is even more interesting.
 .fi
-
-
-in case you care)\&.
-
+in case you care).
+.sp
 .SH "OUTPUT FORMAT"
-
-
-The output format from "git\-diff\-index", "git\-diff\-tree" and "git\-diff\-files" are very similar\&.
-
-
+The output format from "git\-diff\-index", "git\-diff\-tree" and "git\-diff\-files" are very similar.
+.sp
 These commands all compare two sets of things; what is compared differs:
-
+.sp
 .TP
 git\-diff\-index <tree\-ish>
-compares the <tree\-ish> and the files on the filesystem\&.
-
+compares the <tree\-ish> and the files on the filesystem.
 .TP
 git\-diff\-index \-\-cached <tree\-ish>
-compares the <tree\-ish> and the index\&.
-
+compares the <tree\-ish> and the index.
 .TP
-git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>...]
-compares the trees named by the two arguments\&.
-
+git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>\&...]
+compares the trees named by the two arguments.
 .TP
-git\-diff\-files [<pattern>...]
-compares the index and the files on the filesystem\&.
-
-
+git\-diff\-files [<pattern>\&...]
+compares the index and the files on the filesystem.
 An output line is formatted this way:
-
+.sp
+.sp
 .nf
-in\-place edit  :100644 100644 bcd1234\&.\&.\&. 0123456\&.\&.\&. M file0
-copy\-edit      :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. C68 file1 file2
-rename\-edit    :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. R86 file1 file3
-create         :000000 100644 0000000\&.\&.\&. 1234567\&.\&.\&. A file4
-delete         :100644 000000 1234567\&.\&.\&. 0000000\&.\&.\&. D file5
-unmerged       :000000 000000 0000000\&.\&.\&. 0000000\&.\&.\&. U file6
+in\-place edit  :100644 100644 bcd1234... 0123456... M file0
+copy\-edit      :100644 100644 abcd123... 1234567... C68 file1 file2
+rename\-edit    :100644 100644 abcd123... 1234567... R86 file1 file3
+create         :000000 100644 0000000... 1234567... A file4
+delete         :100644 000000 1234567... 0000000... D file5
+unmerged       :000000 000000 0000000... 0000000... U file6
 .fi
-
-
 That is, from the left to the right:
-
+.sp
 .TP 3
 1.
-a colon\&.
+a colon.
 .TP
 2.
-mode for "src"; 000000 if creation or unmerged\&.
+mode for "src"; 000000 if creation or unmerged.
 .TP
 3.
-a space\&.
+a space.
 .TP
 4.
-mode for "dst"; 000000 if deletion or unmerged\&.
+mode for "dst"; 000000 if deletion or unmerged.
 .TP
 5.
-a space\&.
+a space.
 .TP
 6.
-sha1 for "src"; 0{40} if creation or unmerged\&.
+sha1 for "src"; 0{40} if creation or unmerged.
 .TP
 7.
-a space\&.
+a space.
 .TP
 8.
-sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree"\&.
+sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree".
 .TP
 9.
-a space\&.
+a space.
 .TP
 10.
-status, followed by optional "score" number\&.
+status, followed by optional "score" number.
 .TP
 11.
-a tab or a NUL when \fI\-z\fR option is used\&.
+a tab or a NUL when
+\fI\-z\fR
+option is used.
 .TP
 12.
 path for "src"
 .TP
 13.
-a tab or a NUL when \fI\-z\fR option is used; only exists for C or R\&.
+a tab or a NUL when
+\fI\-z\fR
+option is used; only exists for C or R.
 .TP
 14.
-path for "dst"; only exists for C or R\&.
+path for "dst"; only exists for C or R.
 .TP
 15.
-an LF or a NUL when \fI\-z\fR option is used, to terminate the record\&.
-.LP
-
-
-<sha1> is shown as all 0's if a file is new on the filesystem and it is out of sync with the index\&.
-
-
+an LF or a NUL when
+\fI\-z\fR
+option is used, to terminate the record.
+<sha1> is shown as all 0's if a file is new on the filesystem and it is out of sync with the index.
+.sp
 Example:
-
+.sp
+.sp
 .nf
-:100644 100644 5be4a4\&.\&.\&.\&.\&.\&. 000000\&.\&.\&.\&.\&.\&. M file\&.c
+:100644 100644 5be4a4...... 000000...... M file.c
 .fi
-
-
-When \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
-
-.SH "GENERATING PATCHES WITH -P"
-
-
-When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \fI\-p\fR option, they do not produce the output described above; instead they produce a patch file\&.
-
-
-The patch generation can be customized at two levels\&.
-
+When \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively.
+.sp
+.SH "GENERATING PATCHES WITH \-P"
+When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \fI\-p\fR option, they do not produce the output described above; instead they produce a patch file.
+.sp
+The patch generation can be customized at two levels.
+.sp
 .TP 3
 1.
-When the environment variable \fIGIT_EXTERNAL_DIFF\fR is not set, these commands internally invoke "diff" like this:
-
-
+When the environment variable
+\fIGIT_EXTERNAL_DIFF\fR
+is not set, these commands internally invoke "diff" like this:
+.sp
 .nf
 diff \-L a/<path> \-L b/<path> \-pu <old> <new>
 .fi
-For added files, /dev/null is used for <old>\&. For removed files, /dev/null is used for <new>
-
-The "diff" formatting options can be customized via the environment variable \fIGIT_DIFF_OPTS\fR\&. For example, if you prefer context diff:
-
+For added files,
+/dev/null
+is used for <old>. For removed files,
+/dev/null
+is used for <new>
+.sp
+The "diff" formatting options can be customized via the environment variable
+\fIGIT_DIFF_OPTS\fR. For example, if you prefer context diff:
+.sp
 .nf
 GIT_DIFF_OPTS=\-c git\-diff\-index \-p HEAD
 .fi
 .TP
 2.
-When the environment variable \fIGIT_EXTERNAL_DIFF\fR is set, the program named by it is called, instead of the diff invocation described above\&.
-
-For a path that is added, removed, or modified, \fIGIT_EXTERNAL_DIFF\fR is called with 7 parameters:
-
-
+When the environment variable
+\fIGIT_EXTERNAL_DIFF\fR
+is set, the program named by it is called, instead of the diff invocation described above.
+.sp
+For a path that is added, removed, or modified,
+\fIGIT_EXTERNAL_DIFF\fR
+is called with 7 parameters:
+.sp
 .nf
 path old\-file old\-hex old\-mode new\-file new\-hex new\-mode
 .fi
 where:
-
 <old|new>\-file
 
 are files GIT_EXTERNAL_DIFF can use to read the contents of <old|new>,
@@ -418,34 +366,54 @@ are the 40\-hexdigit SHA1 hashes,
 
 <old|new>\-mode
 
-are the octal representation of the file modes\&.
-
-The file parameters can point at the user's working file (e\&.g\&. new\-file in "git\-diff\-files"), /dev/null (e\&.g\&. old\-file when a new file is added), or a temporary file (e\&.g\&. old\-file in the index)\&. \fIGIT_EXTERNAL_DIFF\fR should not worry about unlinking the temporary file \-\-\- it is removed when \fIGIT_EXTERNAL_DIFF\fR exits\&.
-.LP
-
-
-For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, <path>\&.
-
+are the octal representation of the file modes.
+
+The file parameters can point at the user's working file (e.g.
+new\-file
+in "git\-diff\-files"),
+/dev/null
+(e.g.
+old\-file
+when a new file is added), or a temporary file (e.g.
+old\-file
+in the index).
+\fIGIT_EXTERNAL_DIFF\fR
+should not worry about unlinking the temporary file \-\-\- it is removed when
+\fIGIT_EXTERNAL_DIFF\fR
+exits.
+For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, <path>.
+.sp
 .SH "GIT SPECIFIC EXTENSION TO DIFF FORMAT"
-
-
-What \-p option produces is slightly different from the traditional diff format\&.
-
+What \-p option produces is slightly different from the traditional diff format.
+.sp
 .TP 3
 1.
 It is preceded with a "git diff" header, that looks like this:
-
-
+.sp
 .nf
 diff \-\-git a/file1 b/file2
 .fi
-The a/ and b/ filenames are the same unless rename/copy is involved\&. Especially, even for a creation or a deletion, /dev/null is _not_ used in place of a/ or b/ filenames\&.
-
-When rename/copy is involved, file1 and file2 show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively\&.
+The
+a/
+and
+b/
+filenames are the same unless rename/copy is involved. Especially, even for a creation or a deletion,
+/dev/null
+is _not_ used in place of
+a/
+or
+b/
+filenames.
+.sp
+When rename/copy is involved,
+file1
+and
+file2
+show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively.
 .TP
 2.
 It is followed by one or more extended header lines:
-
+.sp
 .nf
 old mode <mode>
 new mode <mode>
@@ -457,20 +425,20 @@ rename from <path>
 rename to <path>
 similarity index <number>
 dissimilarity index <number>
-index <hash>\&.\&.<hash> <mode>
+index <hash>..<hash> <mode>
 .fi
 .TP
 3.
-TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
-.LP
-
+TAB, LF, and backslash characters in pathnames are represented as
+\\t,
+\\n, and
+\\\\, respectively.
 .SH "COMBINED DIFF FORMAT"
-
-
 git\-diff\-tree and git\-diff\-files can take \fI\-c\fR or \fI\-\-cc\fR option to produce \fIcombined diff\fR, which looks like this:
-
+.sp
+.sp
 .nf
-diff \-\-combined describe\&.c
+diff \-\-combined describe.c
 @@@ +98,7 @@@
    return (a_date > b_date) ? \-1 : (a_date == b_date) ? 0 : 1;
   }
@@ -482,31 +450,24 @@ diff \-\-combined describe\&.c
  +     unsigned char sha1[20];
  +     struct commit *cmit;
 .fi
-
-
-Unlike the traditional \fIunified\fR diff format, which shows two files A and B with a single column that has \- (minus -- appears in A but removed in B), + (plus -- missing in A but added to B), or (space -- unchanged) prefix, this format compares two or more files file1, file2,... with one file X, and shows how X differs from each of fileN\&. One column for each of fileN is prepended to the output line to note how X's line is different from it\&.
-
-
-A \- character in the column N means that the line appears in fileN but it does not appear in the last file\&. A + character in the column N means that the line appears in the last file, and fileN does not have that line\&.
-
-
-In the above example output, the function signature was changed from both files (hence two \- removals from both file1 and file2, plus ++ to mean one line that was added does not appear in either file1 nor file2)\&. Also two other lines are the same from file1 but do not appear in file2 (hence prefixed with +)\&.
-
-
-When shown by git diff\-tree \-c, it compares the parents of a merge commit with the merge result (i\&.e\&. file1\&.\&.fileN are the parents)\&. When shown by git diff\-files \-c, it compares the two unresolved merge parents with the working tree file (i\&.e\&. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version")\&.
-
+Unlike the traditional \fIunified\fR diff format, which shows two files A and B with a single column that has \- (minus \(em appears in A but removed in B), + (plus \(em missing in A but added to B), or (space \(em unchanged) prefix, this format compares two or more files file1, file2,\&... with one file X, and shows how X differs from each of fileN. One column for each of fileN is prepended to the output line to note how X's line is different from it.
+.sp
+A \- character in the column N means that the line appears in fileN but it does not appear in the last file. A + character in the column N means that the line appears in the last file, and fileN does not have that line.
+.sp
+In the above example output, the function signature was changed from both files (hence two \- removals from both file1 and file2, plus ++ to mean one line that was added does not appear in either file1 nor file2). Also two other lines are the same from file1 but do not appear in file2 (hence prefixed with +).
+.sp
+When shown by git diff\-tree \-c, it compares the parents of a merge commit with the merge result (i.e. file1..fileN are the parents). When shown by git diff\-files \-c, it compares the two unresolved merge parents with the working tree file (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version").
+.sp
 .SH "AUTHOR"
-
-
-Written by Linus Torvalds <torvalds@osdl\&.org>
-
+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>\&.
-
+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
+.SH "REFERENCES"
+.TP 3
+1.\ diffcore documentation
+\%diffcore.html