Autogenerated man pages for v1.2.4-gf61c2
[git.git] / man1 / git-diff-stages.1
index ac54d04..059fc0f 100755 (executable)
 ..
 .TH "GIT-DIFF-STAGES" 1 "" "" ""
 .SH NAME
-git-diff-stages \- Compares content and mode of blobs between stages in an unmerged index file.
+git-diff-stages \- Compares content and mode of blobs between stages in an unmerged index file
 .SH "SYNOPSIS"
 
 
-git\-diff\-stages [<common diff options>] <stage1> <stage2> [<path>...]
+\fIgit\-diff\-stages\fR [<common diff options>] <stage1> <stage2> [<path>...]
 
 .SH "DESCRIPTION"
 
@@ -73,6 +73,10 @@ Detect 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\&.
+
+.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\&.
 
@@ -130,13 +134,15 @@ compares the index and the files on the filesystem\&.
 
 An output line is formatted this way:
 
-.IP
+.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
+.fi
+
 
 That is, from the left to the right:
 
@@ -172,19 +178,19 @@ a space\&.
 status, followed by optional "score" number\&.
 .TP
 11.
-a tab or a NUL when \-z 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 \-z 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\&.
 .TP
 15.
-an LF or a NUL when \-z option is used, to terminate the record\&.
+an LF or a NUL when \fI\-z\fR option is used, to terminate the record\&.
 .LP
 
 
@@ -193,22 +199,24 @@ an LF or a NUL when \-z option is used, to terminate the record\&.
 
 Example:
 
-.IP
+.nf
 :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 \-p option, they do not produce the output described above; instead they produce a patch file\&.
+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\&.
 
 .TP 3
 1.
-When the environment variable GIT_EXTERNAL_DIFF 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:
 
 
 .nf
@@ -216,16 +224,16 @@ 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 GIT_DIFF_OPTS\&. For example, if you prefer context diff:
+The "diff" formatting options can be customized via the environment variable \fIGIT_DIFF_OPTS\fR\&. For example, if you prefer context diff:
 
 .nf
 GIT_DIFF_OPTS=\-c git\-diff\-index \-p HEAD
 .fi
 .TP
 2.
-When the environment variable GIT_EXTERNAL_DIFF is set, the program named by it is called, instead of the diff invocation described above\&.
+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, GIT_EXTERNAL_DIFF is called with 7 parameters:
+For a path that is added, removed, or modified, \fIGIT_EXTERNAL_DIFF\fR is called with 7 parameters:
 
 
 .nf
@@ -234,16 +242,22 @@ path old\-file old\-hex old\-mode new\-file new\-hex new\-mode
 where:
 
 <old|new>\-file
+
 are files GIT_EXTERNAL_DIFF can use to read the contents of <old|new>,
+
 <old|new>\-hex
+
 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)\&. GIT_EXTERNAL_DIFF should not worry about unlinking the temporary file \-\-\- it is removed when GIT_EXTERNAL_DIFF exits\&.
+
+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, GIT_EXTERNAL_DIFF is called with 1 parameter, <path>\&.
+For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, <path>\&.
 
 .SH "GIT SPECIFIC EXTENSION TO DIFF FORMAT"
 
@@ -286,9 +300,9 @@ TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and
 .SH "COMBINED DIFF FORMAT"
 
 
-git\-diff\-tree and git\-diff\-files can take \-c or \-\-cc option to produce combined diff, which looks like this:
+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:
 
-.IP
+.nf
 diff \-\-combined describe\&.c
 @@@ +98,7 @@@
    return (a_date > b_date) ? \-1 : (a_date == b_date) ? 0 : 1;
@@ -300,8 +314,10 @@ diff \-\-combined describe\&.c
   {
  +     unsigned char sha1[20];
  +     struct commit *cmit;
+.fi
+
 
-Unlike the traditional unified 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\&.
+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\&.