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