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