man1/git-diff-tree.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "GIT-DIFF-TREE" 1 "" "" ""
  21 .SH NAME
  22 git-diff-tree \- Compares the content and mode of blobs found via two tree objects
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fIgit\-diff\-tree\fR [\-\-stdin] [\-m] [\-s] [\-v] [\-\-no\-commit\-id] [\-\-pretty]
  27               [\-t] [\-r] [\-c | \-\-cc] [\-\-root] [<common diff options>]
  28               <tree\-ish> [<tree\-ish>] [<path>...]
  29 .fi
  30
  31 .SH "DESCRIPTION"
  32
  33
  34 Compares the content and mode of the blobs found via two tree objects\&.
  35
  36
  37 If there is only one <tree\-ish> given, the commit is compared with its parents (see \-\-stdin below)\&.
  38
  39
  40 Note that "git\-diff\-tree" can use the tree encapsulated in a commit object\&.
  41
  42 .SH "OPTIONS"
  43
  44 .TP
  45 \-p
  46 Generate patch (see section on generating patches)
  47
  48 .TP
  49 \-u
  50 Synonym for "\-p"\&.
  51
  52 .TP
  53 \-z
  54 \\0 line termination on output
  55
  56 .TP
  57 \-\-name\-only
  58 Show only names of changed files\&.
  59
  60 .TP
  61 \-\-name\-status
  62 Show only names and status of changed files\&.
  63
  64 .TP
  65 \-\-full\-index
  66 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\&.
  67
  68 .TP
  69 \-\-abbrev[=<n>]
  70 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>\&.
  71
  72 .TP
  73 \-B
  74 Break complete rewrite changes into pairs of delete and create\&.
  75
  76 .TP
  77 \-M
  78 Detect renames\&.
  79
  80 .TP
  81 \-C
  82 Detect copies as well as renames\&.
  83
  84 .TP
  85 \-\-diff\-filter=[ACDMRTUXB*]
  86 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\&.
  87
  88 .TP
  89 \-\-find\-copies\-harder
  90 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\&.
  91
  92 .TP
  93 \-l<num>
  94 \-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\&.
  95
  96 .TP
  97 \-S<string>
  98 Look for differences that contain the change in <string>\&.
  99
 100 .TP
 101 \-\-pickaxe\-all
 102 When \-S finds a change, show all the changes in that changeset, not just the files that contain the change in <string>\&.
 103
 104 .TP
 105 \-\-pickaxe\-regex
 106 Make the <string> not a plain string but an extended POSIX regex to match\&.
 107
 108 .TP
 109 \-O<orderfile>
 110 Output the patch in the order specified in the <orderfile>, which has one shell glob pattern per line\&.
 111
 112 .TP
 113 \-R
 114 Swap two inputs; that is, show differences from index or on\-disk file to tree contents\&.
 115
 116
 117 For more detailed explanation on these common options, see also diffcore documentation: \fIdiffcore.html\fR\&.
 118
 119 .TP
 120 <tree\-ish>
 121 The id of a tree object\&.
 122
 123 .TP
 124 <path>...
 125 If provided, the results are limited to a subset of files matching one of these prefix strings\&. ie file matches /^<pattern1>|<pattern2>|.../ Note that this parameter does not provide any wildcard or regexp features\&.
 126
 127 .TP
 128 \-r
 129 recurse into sub\-trees
 130
 131 .TP
 132 \-t
 133 show tree entry itself as well as subtrees\&. Implies \-r\&.
 134
 135 .TP
 136 \-\-root
 137 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\&.
 138
 139 .TP
 140 \-\-stdin
 141 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\&.
 142
 143 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\&.
 144
 145 .TP
 146 \-m
 147 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\&.
 148
 149 .TP
 150 \-s
 151 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\&.
 152
 153 .TP
 154 \-v
 155 This flag causes "git\-diff\-tree \-\-stdin" to also show the commit message before the differences\&.
 156
 157 .TP
 158 \-\-pretty[=(raw|medium|short)]
 159 This is used to control "pretty printing" format of the commit message\&. Without "=<style>", it defaults to medium\&.
 160
 161 .TP
 162 \-\-no\-commit\-id
 163 git\-diff\-tree outputs a line with the commit ID when applicable\&. This flag suppressed the commit ID output\&.
 164
 165 .TP
 166 \-c
 167 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\&.
 168
 169 .TP
 170 \-cc
 171 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\&.
 172
 173 .TP
 174 \-\-always
 175 Show the commit itself and the commit log message even if the diff itself is empty\&.
 176
 177 .SH "LIMITING OUTPUT"
 178
 179
 180 If you're only interested in differences in a subset of files, for example some architecture\-specific files, you might do:
 181
 182 .nf
 183 git\-diff\-tree \-r <tree\-ish> <tree\-ish> arch/ia64 include/asm\-ia64
 184 .fi
 185
 186
 187 and it will only show you what changed in those two directories\&.
 188
 189
 190 Or if you are searching for what changed in just kernel/sched\&.c, just do
 191
 192 .nf
 193 git\-diff\-tree \-r <tree\-ish> <tree\-ish> kernel/sched\&.c
 194 .fi
 195
 196
 197 and it will ignore all differences to other files\&.
 198
 199
 200 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\&.
 201
 202
 203 An example of normal usage is:
 204
 205 .nf
 206 torvalds@ppc970:~/git> git\-diff\-tree 5319e4\&.\&.\&.\&.\&.\&.
 207 *100664\->100664 blob    ac348b\&.\&.\&.\&.\&.\&.\&.\->a01513\&.\&.\&.\&.\&.\&.\&.      git\-fsck\-objects\&.c
 208 .fi
 209
 210
 211 which tells you that the last commit changed just one file (it's from this one:
 212
 213 .nf
 214 commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8
 215 tree 5319e4d609cdd282069cc4dce33c1db559539b03
 216 parent b4e628ea30d5ab3606119d2ea5caeab141d38df7
 217 author Linus Torvalds <torvalds@ppc970\&.osdl\&.org> Sat Apr 9 12:02:30 2005
 218 committer Linus Torvalds <torvalds@ppc970\&.osdl\&.org> Sat Apr 9 12:02:30 2005
 219
 220 Make "git\-fsck\-objects" print out all the root commits it finds\&.
 221
 222 Once I do the reference tracking, I'll also make it print out all the
 223 HEAD commits it finds, which is even more interesting\&.
 224 .fi
 225
 226
 227 in case you care)\&.
 228
 229 .SH "OUTPUT FORMAT"
 230
 231
 232 The output format from "git\-diff\-index", "git\-diff\-tree" and "git\-diff\-files" are very similar\&.
 233
 234
 235 These commands all compare two sets of things; what is compared differs:
 236
 237 .TP
 238 git\-diff\-index <tree\-ish>
 239 compares the <tree\-ish> and the files on the filesystem\&.
 240
 241 .TP
 242 git\-diff\-index \-\-cached <tree\-ish>
 243 compares the <tree\-ish> and the index\&.
 244
 245 .TP
 246 git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>...]
 247 compares the trees named by the two arguments\&.
 248
 249 .TP
 250 git\-diff\-files [<pattern>...]
 251 compares the index and the files on the filesystem\&.
 252
 253
 254 An output line is formatted this way:
 255
 256 .nf
 257 in\-place edit  :100644 100644 bcd1234\&.\&.\&. 0123456\&.\&.\&. M file0
 258 copy\-edit      :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. C68 file1 file2
 259 rename\-edit    :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. R86 file1 file3
 260 create         :000000 100644 0000000\&.\&.\&. 1234567\&.\&.\&. A file4
 261 delete         :100644 000000 1234567\&.\&.\&. 0000000\&.\&.\&. D file5
 262 unmerged       :000000 000000 0000000\&.\&.\&. 0000000\&.\&.\&. U file6
 263 .fi
 264
 265
 266 That is, from the left to the right:
 267
 268 .TP 3
 269 1.
 270 a colon\&.
 271 .TP
 272 2.
 273 mode for "src"; 000000 if creation or unmerged\&.
 274 .TP
 275 3.
 276 a space\&.
 277 .TP
 278 4.
 279 mode for "dst"; 000000 if deletion or unmerged\&.
 280 .TP
 281 5.
 282 a space\&.
 283 .TP
 284 6.
 285 sha1 for "src"; 0{40} if creation or unmerged\&.
 286 .TP
 287 7.
 288 a space\&.
 289 .TP
 290 8.
 291 sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree"\&.
 292 .TP
 293 9.
 294 a space\&.
 295 .TP
 296 10.
 297 status, followed by optional "score" number\&.
 298 .TP
 299 11.
 300 a tab or a NUL when \fI\-z\fR option is used\&.
 301 .TP
 302 12.
 303 path for "src"
 304 .TP
 305 13.
 306 a tab or a NUL when \fI\-z\fR option is used; only exists for C or R\&.
 307 .TP
 308 14.
 309 path for "dst"; only exists for C or R\&.
 310 .TP
 311 15.
 312 an LF or a NUL when \fI\-z\fR option is used, to terminate the record\&.
 313 .LP
 314
 315
 316 <sha1> is shown as all 0's if a file is new on the filesystem and it is out of sync with the index\&.
 317
 318
 319 Example:
 320
 321 .nf
 322 :100644 100644 5be4a4\&.\&.\&.\&.\&.\&. 000000\&.\&.\&.\&.\&.\&. M file\&.c
 323 .fi
 324
 325
 326 When \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
 327
 328 .SH "GENERATING PATCHES WITH -P"
 329
 330
 331 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\&.
 332
 333
 334 The patch generation can be customized at two levels\&.
 335
 336 .TP 3
 337 1.
 338 When the environment variable \fIGIT_EXTERNAL_DIFF\fR is not set, these commands internally invoke "diff" like this:
 339
 340
 341 .nf
 342 diff \-L a/<path> \-L b/<path> \-pu <old> <new>
 343 .fi
 344 For added files, /dev/null is used for <old>\&. For removed files, /dev/null is used for <new>
 345
 346 The "diff" formatting options can be customized via the environment variable \fIGIT_DIFF_OPTS\fR\&. For example, if you prefer context diff:
 347
 348 .nf
 349 GIT_DIFF_OPTS=\-c git\-diff\-index \-p HEAD
 350 .fi
 351 .TP
 352 2.
 353 When the environment variable \fIGIT_EXTERNAL_DIFF\fR is set, the program named by it is called, instead of the diff invocation described above\&.
 354
 355 For a path that is added, removed, or modified, \fIGIT_EXTERNAL_DIFF\fR is called with 7 parameters:
 356
 357
 358 .nf
 359 path old\-file old\-hex old\-mode new\-file new\-hex new\-mode
 360 .fi
 361 where:
 362
 363 <old|new>\-file
 364
 365 are files GIT_EXTERNAL_DIFF can use to read the contents of <old|new>,
 366
 367 <old|new>\-hex
 368
 369 are the 40\-hexdigit SHA1 hashes,
 370
 371 <old|new>\-mode
 372
 373 are the octal representation of the file modes\&.
 374
 375 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\&.
 376 .LP
 377
 378
 379 For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, <path>\&.
 380
 381 .SH "GIT SPECIFIC EXTENSION TO DIFF FORMAT"
 382
 383
 384 What \-p option produces is slightly different from the traditional diff format\&.
 385
 386 .TP 3
 387 1.
 388 It is preceded with a "git diff" header, that looks like this:
 389
 390
 391 .nf
 392 diff \-\-git a/file1 b/file2
 393 .fi
 394 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\&.
 395
 396 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\&.
 397 .TP
 398 2.
 399 It is followed by one or more extended header lines:
 400
 401 .nf
 402 old mode <mode>
 403 new mode <mode>
 404 deleted file mode <mode>
 405 new file mode <mode>
 406 copy from <path>
 407 copy to <path>
 408 rename from <path>
 409 rename to <path>
 410 similarity index <number>
 411 dissimilarity index <number>
 412 index <hash>\&.\&.<hash> <mode>
 413 .fi
 414 .TP
 415 3.
 416 TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
 417 .LP
 418
 419 .SH "COMBINED DIFF FORMAT"
 420
 421
 422 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:
 423
 424 .nf
 425 diff \-\-combined describe\&.c
 426 @@@ +98,7 @@@
 427    return (a_date > b_date) ? \-1 : (a_date == b_date) ? 0 : 1;
 428   }
 429
 430 \- static void describe(char *arg)
 431  \-static void describe(struct commit *cmit, int last_one)
 432 ++static void describe(char *arg, int last_one)
 433   {
 434  +     unsigned char sha1[20];
 435  +     struct commit *cmit;
 436 .fi
 437
 438
 439 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\&.
 440
 441
 442 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\&.
 443
 444
 445 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 +)\&.
 446
 447
 448 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")\&.
 449
 450 .SH "AUTHOR"
 451
 452
 453 Written by Linus Torvalds <torvalds@osdl\&.org>
 454
 455 .SH "DOCUMENTATION"
 456
 457
 458 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
 459
 460 .SH "GIT"
 461
 462
 463 Part of the \fBgit\fR(7) suite
 464