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 \-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 <stage1>,<stage2>
 116 The stage number to be compared\&.
 117
 118 .SH "OUTPUT FORMAT"
 119
 120
 121 The output format from "git\-diff\-index", "git\-diff\-tree" and "git\-diff\-files" are very similar\&.
 122
 123
 124 These commands all compare two sets of things; what is compared differs:
 125
 126 .TP
 127 git\-diff\-index <tree\-ish>
 128 compares the <tree\-ish> and the files on the filesystem\&.
 129
 130 .TP
 131 git\-diff\-index \-\-cached <tree\-ish>
 132 compares the <tree\-ish> and the index\&.
 133
 134 .TP
 135 git\-diff\-tree [\-r] <tree\-ish\-1> <tree\-ish\-2> [<pattern>...]
 136 compares the trees named by the two arguments\&.
 137
 138 .TP
 139 git\-diff\-files [<pattern>...]
 140 compares the index and the files on the filesystem\&.
 141
 142
 143 An output line is formatted this way:
 144
 145 .nf
 146 in\-place edit  :100644 100644 bcd1234\&.\&.\&. 0123456\&.\&.\&. M file0
 147 copy\-edit      :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. C68 file1 file2
 148 rename\-edit    :100644 100644 abcd123\&.\&.\&. 1234567\&.\&.\&. R86 file1 file3
 149 create         :000000 100644 0000000\&.\&.\&. 1234567\&.\&.\&. A file4
 150 delete         :100644 000000 1234567\&.\&.\&. 0000000\&.\&.\&. D file5
 151 unmerged       :000000 000000 0000000\&.\&.\&. 0000000\&.\&.\&. U file6
 152 .fi
 153
 154
 155 That is, from the left to the right:
 156
 157 .TP 3
 158 1.
 159 a colon\&.
 160 .TP
 161 2.
 162 mode for "src"; 000000 if creation or unmerged\&.
 163 .TP
 164 3.
 165 a space\&.
 166 .TP
 167 4.
 168 mode for "dst"; 000000 if deletion or unmerged\&.
 169 .TP
 170 5.
 171 a space\&.
 172 .TP
 173 6.
 174 sha1 for "src"; 0{40} if creation or unmerged\&.
 175 .TP
 176 7.
 177 a space\&.
 178 .TP
 179 8.
 180 sha1 for "dst"; 0{40} if creation, unmerged or "look at work tree"\&.
 181 .TP
 182 9.
 183 a space\&.
 184 .TP
 185 10.
 186 status, followed by optional "score" number\&.
 187 .TP
 188 11.
 189 a tab or a NUL when \fI\-z\fR option is used\&.
 190 .TP
 191 12.
 192 path for "src"
 193 .TP
 194 13.
 195 a tab or a NUL when \fI\-z\fR option is used; only exists for C or R\&.
 196 .TP
 197 14.
 198 path for "dst"; only exists for C or R\&.
 199 .TP
 200 15.
 201 an LF or a NUL when \fI\-z\fR option is used, to terminate the record\&.
 202 .LP
 203
 204
 205 <sha1> is shown as all 0's if a file is new on the filesystem and it is out of sync with the index\&.
 206
 207
 208 Example:
 209
 210 .nf
 211 :100644 100644 5be4a4\&.\&.\&.\&.\&.\&. 000000\&.\&.\&.\&.\&.\&. M file\&.c
 212 .fi
 213
 214
 215 When \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
 216
 217 .SH "GENERATING PATCHES WITH -P"
 218
 219
 220 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\&.
 221
 222
 223 The patch generation can be customized at two levels\&.
 224
 225 .TP 3
 226 1.
 227 When the environment variable \fIGIT_EXTERNAL_DIFF\fR is not set, these commands internally invoke "diff" like this:
 228
 229
 230 .nf
 231 diff \-L a/<path> \-L b/<path> \-pu <old> <new>
 232 .fi
 233 For added files, /dev/null is used for <old>\&. For removed files, /dev/null is used for <new>
 234
 235 The "diff" formatting options can be customized via the environment variable \fIGIT_DIFF_OPTS\fR\&. For example, if you prefer context diff:
 236
 237 .nf
 238 GIT_DIFF_OPTS=\-c git\-diff\-index \-p HEAD
 239 .fi
 240 .TP
 241 2.
 242 When the environment variable \fIGIT_EXTERNAL_DIFF\fR is set, the program named by it is called, instead of the diff invocation described above\&.
 243
 244 For a path that is added, removed, or modified, \fIGIT_EXTERNAL_DIFF\fR is called with 7 parameters:
 245
 246
 247 .nf
 248 path old\-file old\-hex old\-mode new\-file new\-hex new\-mode
 249 .fi
 250 where:
 251
 252 <old|new>\-file
 253
 254 are files GIT_EXTERNAL_DIFF can use to read the contents of <old|new>,
 255
 256 <old|new>\-hex
 257
 258 are the 40\-hexdigit SHA1 hashes,
 259
 260 <old|new>\-mode
 261
 262 are the octal representation of the file modes\&.
 263
 264 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\&.
 265 .LP
 266
 267
 268 For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, <path>\&.
 269
 270 .SH "GIT SPECIFIC EXTENSION TO DIFF FORMAT"
 271
 272
 273 What \-p option produces is slightly different from the traditional diff format\&.
 274
 275 .TP 3
 276 1.
 277 It is preceded with a "git diff" header, that looks like this:
 278
 279
 280 .nf
 281 diff \-\-git a/file1 b/file2
 282 .fi
 283 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\&.
 284
 285 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\&.
 286 .TP
 287 2.
 288 It is followed by one or more extended header lines:
 289
 290 .nf
 291 old mode <mode>
 292 new mode <mode>
 293 deleted file mode <mode>
 294 new file mode <mode>
 295 copy from <path>
 296 copy to <path>
 297 rename from <path>
 298 rename to <path>
 299 similarity index <number>
 300 dissimilarity index <number>
 301 index <hash>\&.\&.<hash> <mode>
 302 .fi
 303 .TP
 304 3.
 305 TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
 306 .LP
 307
 308 .SH "COMBINED DIFF FORMAT"
 309
 310
 311 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:
 312
 313 .nf
 314 diff \-\-combined describe\&.c
 315 @@@ +98,7 @@@
 316    return (a_date > b_date) ? \-1 : (a_date == b_date) ? 0 : 1;
 317   }
 318
 319 \- static void describe(char *arg)
 320  \-static void describe(struct commit *cmit, int last_one)
 321 ++static void describe(char *arg, int last_one)
 322   {
 323  +     unsigned char sha1[20];
 324  +     struct commit *cmit;
 325 .fi
 326
 327
 328 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\&.
 329
 330
 331 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\&.
 332
 333
 334 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 +)\&.
 335
 336
 337 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")\&.
 338
 339 .SH "AUTHOR"
 340
 341
 342 Written by Junio C Hamano <junkio@cox\&.net>
 343
 344 .SH "DOCUMENTATION"
 345
 346
 347 Documentation by Junio C Hamano\&.
 348
 349 .SH "GIT"
 350
 351
 352 Part of the \fBgit\fR(7) suite
 353