Autogenerated man pages for v1.2.2-g709a
[git.git] / man1 / git-diff-tree.1
index 8473645..b93a059 100755 (executable)
 git-diff-tree \- Compares the content and mode of blobs found via two tree objects
 .SH "SYNOPSIS"
 
-
-git\-diff\-tree [\-\-stdin] [\-m] [\-s] [\-v] [\-\-no\-commit\-id] [\-\-pretty] [\-t] [\-r] [\-\-root] [<common diff options>] <tree\-ish> [<tree\-ish>] [<path>...]
+.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>...]
+.fi
 
 .SH "DESCRIPTION"
 
@@ -64,7 +67,7 @@ Instead of the first handful characters, show full object name of pre\- and post
 
 .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 dhexigits 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
@@ -79,6 +82,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\&.
 
@@ -123,11 +130,11 @@ show tree entry itself as well as subtrees\&. Implies \-r\&.
 
 .TP
 \-\-root
-When \-\-root 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 \-\-stdin 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 \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 behaviour\&. This does not apply to the case where two <tree\-ish> separated with a single space are given\&.
 
@@ -137,7 +144,7 @@ By default, "git\-diff\-tree \-\-stdin" does not show differences for merge comm
 
 .TP
 \-s
-By default, "git\-diff\-tree \-\-stdin" shows differences, either in machine\-readable form (without \-p) or in patch form (with \-p)\&. This output can be supressed\&. It is only useful with \-v 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
@@ -151,6 +158,14 @@ This is used to control "pretty printing" format of the commit message\&. Withou
 \-\-no\-commit\-id
 git\-diff\-tree outputs a line with the commit ID when applicable\&. This flag suppressed the commit ID output\&.
 
+.TP
+\-c,\-\-cc
+These flags change 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 \fI\-m\fR option output does\&. \fI\-\-cc\fR further compresses the output by omiting 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 any other "empty diff" cases\&.
+
+.TP
+\-\-always
+Show the commit itself and the commit log message even if the diff itself is empty\&.
+
 .SH "LIMITING OUTPUT"
 
 
@@ -270,19 +285,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
 
 
@@ -299,14 +314,14 @@ When \-z option is not used, TAB, LF, and backslash characters in pathnames are
 .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
@@ -314,16 +329,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
@@ -332,16 +347,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"
 
@@ -350,7 +371,7 @@ What \-p option produces is slightly different from the traditional diff format\
 
 .TP 3
 1.
-It is preceeded with a "git diff" header, that looks like this:
+It is preceded with a "git diff" header, that looks like this:
 
 
 .nf
@@ -381,6 +402,35 @@ index <hash>\&.\&.<hash> <mode>
 TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
 .LP
 
+.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:
+
+.IP
+diff \-\-combined describe\&.c
+@@@ +98,7 @@@
+   return (a_date > b_date) ? \-1 : (a_date == b_date) ? 0 : 1;
+  }
+
+\- static void describe(char *arg)
+ \-static void describe(struct commit *cmit, int last_one)
+++static void describe(char *arg, int last_one)
+  {
+ +     unsigned char sha1[20];
+ +     struct commit *cmit;
+
+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")\&.
+
 .SH "AUTHOR"