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