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