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