man1/git-diff-files.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-FILES" 1 "" "" ""
  21 .SH NAME
  22 git-diff-files \- Compares files in the working tree and the index
  23 .SH "SYNOPSIS"
  24
  25
  26 \fIgit\-diff\-files\fR [\-q] [\-0|\-1|\-2|\-3|\-c|\-\-cc] [<common diff options>] [<path>...]
  27
  28 .SH "DESCRIPTION"
  29
  30
  31 Compares the files in the working tree and the index\&. When paths are specified, compares only those named paths\&. Otherwise all entries in the index are compared\&. The output format is the same as "git\-diff\-index" and "git\-diff\-tree"\&.
  32
  33 .SH "OPTIONS"
  34
  35 .TP
  36 \-p
  37 Generate patch (see section on generating patches)
  38
  39 .TP
  40 \-u
  41 Synonym for "\-p"\&.
  42
  43 .TP
  44 \-\-patch\-with\-raw
  45 Generate patch but keep also the default raw diff output\&.
  46
  47 .TP
  48 \-\-stat
  49 Generate a diffstat instead of a patch\&.
  50
  51 .TP
  52 \-\-summary
  53 Output a condensed summary of extended header information such as creations, renames and mode changes\&.
  54
  55 .TP
  56 \-\-patch\-with\-stat
  57 Generate patch and prepend its diffstat\&.
  58
  59 .TP
  60 \-z
  61 \\0 line termination on output
  62
  63 .TP
  64 \-\-name\-only
  65 Show only names of changed files\&.
  66
  67 .TP
  68 \-\-name\-status
  69 Show only names and status of changed files\&.
  70
  71 .TP
  72 \-\-full\-index
  73 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\&.
  74
  75 .TP
  76 \-\-abbrev[=<n>]
  77 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>\&.
  78
  79 .TP
  80 \-B
  81 Break complete rewrite changes into pairs of delete and create\&.
  82
  83 .TP
  84 \-M
  85 Detect renames\&.
  86
  87 .TP
  88 \-C
  89 Detect copies as well as renames\&.
  90
  91 .TP
  92 \-\-diff\-filter=[ACDMRTUXB*]
  93 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\&.
  94
  95 .TP
  96 \-\-find\-copies\-harder
  97 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\&.
  98
  99 .TP
 100 \-l<num>
 101 \-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\&.
 102
 103 .TP
 104 \-S<string>
 105 Look for differences that contain the change in <string>\&.
 106
 107 .TP
 108 \-\-pickaxe\-all
 109 When \-S finds a change, show all the changes in that changeset, not just the files that contain the change in <string>\&.
 110
 111 .TP
 112 \-\-pickaxe\-regex
 113 Make the <string> not a plain string but an extended POSIX regex to match\&.
 114
 115 .TP
 116 \-O<orderfile>
 117 Output the patch in the order specified in the <orderfile>, which has one shell glob pattern per line\&.
 118
 119 .TP
 120 \-R
 121 Swap two inputs; that is, show differences from index or on\-disk file to tree contents\&.
 122
 123
 124 For more detailed explanation on these common options, see also diffcore documentation: \fIdiffcore.html\fR\&.
 125
 126 .TP
 127 \-1 \-2 \-3 or \-\-base \-\-ours \-\-theirs, and \-0
 128 Diff against the "base" version, "our branch" or "their branch" respectively\&. With these options, diffs for merged entries are not shown\&.
 129
 130 The default is to diff against our branch (\-2) and the cleanly resolved paths\&. The option \-0 can be given to omit diff output for unmerged entries and just show "Unmerged"\&.
 131
 132 .TP
 133 \-c,\-\-cc
 134 This compares stage 2 (our branch), stage 3 (their branch) and the working tree file and outputs a combined diff, similar to the way \fIdiff\-tree\fR shows a merge commit with these flags\&.
 135
 136 .TP
 137 \-q
 138 Remain silent even on nonexisting files
 139
 140 .SH "OUTPUT FORMAT"
 141
 142
 143 The output format from "git\-diff\-index", "git\-diff\-tree" and "git\-diff\-files" are very similar\&.
 144
 145
 146 These commands all compare two sets of things; what is compared differs:
 147
 148 .TP
 149 git\-diff\-index <tree\-ish>
 150 compares the <tree\-ish> and the files on the filesystem\&.
 151
 152 .TP
 153 git\-diff\-index \-\-cached <tree\-ish>
 154 compares the <tree\-ish> and the index\&.
 155
 156 .TP
 157 git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>...]
 158 compares the trees named by the two arguments\&.
 159
 160 .TP
 161 git\-diff\-files [<pattern>...]
 162 compares the index and the files on the filesystem\&.
 163
 164
 165 An output line is formatted this way:
 166
 167 .nf
 168 in\-place edit  :100644 100644 bcd1234\&.\&.\&. 0123456\&.\&.\&. M file0
 169 copy\-edit      :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. C68 file1 file2
 170 rename\-edit    :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. R86 file1 file3
 171 create         :000000 100644 0000000\&.\&.\&. 1234567\&.\&.\&. A file4
 172 delete         :100644 000000 1234567\&.\&.\&. 0000000\&.\&.\&. D file5
 173 unmerged       :000000 000000 0000000\&.\&.\&. 0000000\&.\&.\&. U file6
 174 .fi
 175
 176
 177 That is, from the left to the right:
 178
 179 .TP 3
 180 1.
 181 a colon\&.
 182 .TP
 183 2.
 184 mode for "src"; 000000 if creation or unmerged\&.
 185 .TP
 186 3.
 187 a space\&.
 188 .TP
 189 4.
 190 mode for "dst"; 000000 if deletion or unmerged\&.
 191 .TP
 192 5.
 193 a space\&.
 194 .TP
 195 6.
 196 sha1 for "src"; 0{40} if creation or unmerged\&.
 197 .TP
 198 7.
 199 a space\&.
 200 .TP
 201 8.
 202 sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree"\&.
 203 .TP
 204 9.
 205 a space\&.
 206 .TP
 207 10.
 208 status, followed by optional "score" number\&.
 209 .TP
 210 11.
 211 a tab or a NUL when \fI\-z\fR option is used\&.
 212 .TP
 213 12.
 214 path for "src"
 215 .TP
 216 13.
 217 a tab or a NUL when \fI\-z\fR option is used; only exists for C or R\&.
 218 .TP
 219 14.
 220 path for "dst"; only exists for C or R\&.
 221 .TP
 222 15.
 223 an LF or a NUL when \fI\-z\fR option is used, to terminate the record\&.
 224 .LP
 225
 226
 227 <sha1> is shown as all 0's if a file is new on the filesystem and it is out of sync with the index\&.
 228
 229
 230 Example:
 231
 232 .nf
 233 :100644 100644 5be4a4\&.\&.\&.\&.\&.\&. 000000\&.\&.\&.\&.\&.\&. M file\&.c
 234 .fi
 235
 236
 237 When \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
 238
 239 .SH "GENERATING PATCHES WITH -P"
 240
 241
 242 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\&.
 243
 244
 245 The patch generation can be customized at two levels\&.
 246
 247 .TP 3
 248 1.
 249 When the environment variable \fIGIT_EXTERNAL_DIFF\fR is not set, these commands internally invoke "diff" like this:
 250
 251
 252 .nf
 253 diff \-L a/<path> \-L b/<path> \-pu <old> <new>
 254 .fi
 255 For added files, /dev/null is used for <old>\&. For removed files, /dev/null is used for <new>
 256
 257 The "diff" formatting options can be customized via the environment variable \fIGIT_DIFF_OPTS\fR\&. For example, if you prefer context diff:
 258
 259 .nf
 260 GIT_DIFF_OPTS=\-c git\-diff\-index \-p HEAD
 261 .fi
 262 .TP
 263 2.
 264 When the environment variable \fIGIT_EXTERNAL_DIFF\fR is set, the program named by it is called, instead of the diff invocation described above\&.
 265
 266 For a path that is added, removed, or modified, \fIGIT_EXTERNAL_DIFF\fR is called with 7 parameters:
 267
 268
 269 .nf
 270 path old\-file old\-hex old\-mode new\-file new\-hex new\-mode
 271 .fi
 272 where:
 273
 274 <old|new>\-file
 275
 276 are files GIT_EXTERNAL_DIFF can use to read the contents of <old|new>,
 277
 278 <old|new>\-hex
 279
 280 are the 40\-hexdigit SHA1 hashes,
 281
 282 <old|new>\-mode
 283
 284 are the octal representation of the file modes\&.
 285
 286 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\&.
 287 .LP
 288
 289
 290 For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, <path>\&.
 291
 292 .SH "GIT SPECIFIC EXTENSION TO DIFF FORMAT"
 293
 294
 295 What \-p option produces is slightly different from the traditional diff format\&.
 296
 297 .TP 3
 298 1.
 299 It is preceded with a "git diff" header, that looks like this:
 300
 301
 302 .nf
 303 diff \-\-git a/file1 b/file2
 304 .fi
 305 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\&.
 306
 307 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\&.
 308 .TP
 309 2.
 310 It is followed by one or more extended header lines:
 311
 312 .nf
 313 old mode <mode>
 314 new mode <mode>
 315 deleted file mode <mode>
 316 new file mode <mode>
 317 copy from <path>
 318 copy to <path>
 319 rename from <path>
 320 rename to <path>
 321 similarity index <number>
 322 dissimilarity index <number>
 323 index <hash>\&.\&.<hash> <mode>
 324 .fi
 325 .TP
 326 3.
 327 TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
 328 .LP
 329
 330 .SH "COMBINED DIFF FORMAT"
 331
 332
 333 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:
 334
 335 .nf
 336 diff \-\-combined describe\&.c
 337 @@@ +98,7 @@@
 338    return (a_date > b_date) ? \-1 : (a_date == b_date) ? 0 : 1;
 339   }
 340
 341 \- static void describe(char *arg)
 342  \-static void describe(struct commit *cmit, int last_one)
 343 ++static void describe(char *arg, int last_one)
 344   {
 345  +     unsigned char sha1[20];
 346  +     struct commit *cmit;
 347 .fi
 348
 349
 350 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\&.
 351
 352
 353 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\&.
 354
 355
 356 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 +)\&.
 357
 358
 359 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")\&.
 360
 361 .SH "AUTHOR"
 362
 363
 364 Written by Linus Torvalds <torvalds@osdl\&.org>
 365
 366 .SH "DOCUMENTATION"
 367
 368
 369 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
 370
 371 .SH "GIT"
 372
 373
 374 Part of the \fBgit\fR(7) suite
 375