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