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