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