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