]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/diff-options.txt
Merge branch 'ma/doc-markup-fix'
[thirdparty/git.git] / Documentation / diff-options.txt
CommitLineData
c1a95fa6
SO
1// Please don't remove this comment as asciidoc behaves badly when
2// the first non-empty line is ifdef/ifndef. The symptom is that
3// without this comment the <git-diff-core> attribute conditionally
4// defined below ends up being defined unconditionally.
5// Last checked with asciidoc 7.0.2.
6
7ifndef::git-format-patch[]
8ifndef::git-diff[]
272bd3cf 9ifndef::git-log[]
c1a95fa6 10:git-diff-core: 1
272bd3cf 11endif::git-log[]
c1a95fa6
SO
12endif::git-diff[]
13endif::git-format-patch[]
14
15ifdef::git-format-patch[]
16-p::
2cfa8330 17--no-stat::
02bc5b03 18 Generate plain patches without any diffstats.
c1a95fa6
SO
19endif::git-format-patch[]
20
21ifndef::git-format-patch[]
dda2d79a 22-p::
a9e67c8c 23-u::
1c9eecff 24--patch::
c1a95fa6 25 Generate patch (see section on generating patches).
d0258b93
JK
26ifdef::git-diff[]
27 This is the default.
28endif::git-diff[]
dda2d79a 29
7b02c834
MM
30-s::
31--no-patch::
32 Suppress diff output. Useful for commands like `git show` that
33 show the patch by default, or to cancel the effect of `--patch`.
b73a1bcc 34endif::git-format-patch[]
7b02c834 35
1d24509b
SO
36ifdef::git-log[]
37--diff-merges=(off|none|first-parent|1|separate|m|combined|c|dense-combined|cc)::
38--no-diff-merges::
39 Specify diff format to be used for merge commits. Default is
40 {diff-merges-default} unless `--first-parent` is in use, in which case
41 `first-parent` is the default.
42+
43--diff-merges=(off|none):::
44--no-diff-merges:::
45 Disable output of diffs for merge commits. Useful to override
46 implied value.
47+
48--diff-merges=first-parent:::
49--diff-merges=1:::
50 This option makes merge commits show the full diff with
51 respect to the first parent only.
52+
53--diff-merges=separate:::
54--diff-merges=m:::
55-m:::
56 This makes merge commits show the full diff with respect to
57 each of the parents. Separate log entry and diff is generated
58 for each parent. `-m` doesn't produce any output without `-p`.
59+
60--diff-merges=combined:::
61--diff-merges=c:::
62-c:::
63 With this option, diff output for a merge commit shows the
64 differences from each of the parents to the merge result
65 simultaneously instead of showing pairwise diff between a
66 parent and the result one at a time. Furthermore, it lists
67 only files which were modified from all parents. `-c` implies
68 `-p`.
69+
70--diff-merges=dense-combined:::
71--diff-merges=cc:::
72--cc:::
73 With this option the output produced by
74 `--diff-merges=combined` is further compressed by omitting
75 uninteresting hunks whose contents in the parents have only
76 two variants and the merge result picks one of them without
77 modification. `--cc` implies `-p`.
78
79--combined-all-paths::
80 This flag causes combined diffs (used for merge commits) to
81 list the name of the file from all parents. It thus only has
82 effect when `--diff-merges=[dense-]combined` is in use, and
83 is likely only useful if filename changes are detected (i.e.
84 when either rename or copy detection have been requested).
85endif::git-log[]
86
4eb99473 87-U<n>::
4eb99473
RR
88--unified=<n>::
89 Generate diffs with <n> lines of context instead of
714d491a 90 the usual three.
02bc5b03 91ifndef::git-format-patch[]
714d491a 92 Implies `--patch`.
02bc5b03 93endif::git-format-patch[]
4eb99473 94
af2f3680
NTND
95--output=<file>::
96 Output to a specific file instead of stdout.
97
98--output-indicator-new=<char>::
99--output-indicator-old=<char>::
100--output-indicator-context=<char>::
101 Specify the character used to indicate new, old or context
102 lines in the generated patch. Normally they are '+', '-' and
103 ' ' respectively.
104
d4cb003f 105ifndef::git-format-patch[]
b5376648 106--raw::
d89df367
MM
107ifndef::git-log[]
108 Generate the diff in raw format.
d0258b93
JK
109ifdef::git-diff-core[]
110 This is the default.
111endif::git-diff-core[]
d89df367
MM
112endif::git-log[]
113ifdef::git-log[]
114 For each commit, show a summary of changes using the raw diff
115 format. See the "RAW OUTPUT FORMAT" section of
116 linkgit:git-diff[1]. This is different from showing the log
117 itself in raw format, which you can achieve with
118 `--format=raw`.
119endif::git-log[]
d4cb003f 120endif::git-format-patch[]
b5376648 121
02bc5b03 122ifndef::git-format-patch[]
5c91da25 123--patch-with-raw::
dce5ef14 124 Synonym for `-p --raw`.
02bc5b03 125endif::git-format-patch[]
5c91da25 126
9a6d515f
JK
127ifdef::git-log[]
128-t::
129 Show the tree objects in the diff output.
130endif::git-log[]
131
bab76141 132--indent-heuristic::
7eedad15 133 Enable the heuristic that shifts diff hunk boundaries to make patches
bab76141
CMN
134 easier to read. This is the default.
135
136--no-indent-heuristic::
137 Disable the indent heuristic.
5580b271 138
81b568c8
JH
139--minimal::
140 Spend extra time to make sure the smallest possible
141 diff is produced.
142
ec74042d 143--patience::
34292bdd
JS
144 Generate a diff using the "patience diff" algorithm.
145
d909e076
TR
146--histogram::
147 Generate a diff using the "histogram diff" algorithm.
148
2477ab2e
JT
149--anchored=<text>::
150 Generate a diff using the "anchored diff" algorithm.
151+
152This option may be specified more than once.
153+
154If a line exists in both the source and destination, exists only once,
155and starts with this text, this algorithm attempts to prevent it from
156appearing as a deletion or addition in the output. It uses the "patience
157diff" algorithm internally.
158
07924d4d
MP
159--diff-algorithm={patience|minimal|histogram|myers}::
160 Choose a diff algorithm. The variants are as follows:
161+
162--
163`default`, `myers`;;
164 The basic greedy diff algorithm. Currently, this is the default.
165`minimal`;;
166 Spend extra time to make sure the smallest possible diff is
167 produced.
168`patience`;;
169 Use "patience diff" algorithm when generating patches.
170`histogram`;;
171 This algorithm extends the patience algorithm to "support
172 low-occurrence common elements".
173--
174+
7eedad15 175For instance, if you configured the `diff.algorithm` variable to a
07924d4d
MP
176non-default value and want to use the default one, then you
177have to use `--diff-algorithm=default` option.
178
808e1db2 179--stat[=<width>[,<name-width>[,<count>]]]::
1b058bc3 180 Generate a diffstat. By default, as much space as necessary
df44483a
ZJS
181 will be used for the filename part, and the rest for the graph
182 part. Maximum width defaults to terminal width, or 80 columns
8d8136c3 183 if not connected to a terminal, and can be overridden by
df44483a
ZJS
184 `<width>`. The width of the filename part can be limited by
185 giving another width `<name-width>` after a comma. The width
186 of the graph part can be limited by using
187 `--stat-graph-width=<width>` (affects all commands generating
188 a stat graph) or by setting `diff.statGraphWidth=<width>`
189 (does not affect `git format-patch`).
808e1db2 190 By giving a third parameter `<count>`, you can limit the
1b058bc3
ZJS
191 output to the first `<count>` lines, followed by `...` if
192 there are more.
86e1ce96
MG
193+
194These parameters can also be set individually with `--stat-width=<width>`,
195`--stat-name-width=<name-width>` and `--stat-count=<count>`.
d75f7952 196
ddf88fa6
NTND
197--compact-summary::
198 Output a condensed summary of extended header information such
199 as file creations or deletions ("new" or "gone", optionally "+l"
200 if it's a symlink) and mode changes ("+x" or "-x" for adding
201 or removing executable bit respectively) in diffstat. The
1f2abe68 202 information is put between the filename part and the graph
ddf88fa6
NTND
203 part. Implies `--stat`.
204
74e2abe5 205--numstat::
6cf378f0 206 Similar to `--stat`, but shows number of added and
74e2abe5 207 deleted lines in decimal notation and pathname without
2f89543e
JH
208 abbreviation, to make it more machine friendly. For
209 binary files, outputs two `-` instead of saying
210 `0 0`.
74e2abe5 211
ebd124c6 212--shortstat::
dce5ef14 213 Output only the last line of the `--stat` format containing total
ebd124c6
NP
214 number of modified files, as well as number of added and deleted
215 lines.
216
4ce7aab5 217-X[<param1,param2,...>]::
333f3fb0
JH
218--dirstat[=<param1,param2,...>]::
219 Output the distribution of relative amount of changes for each
220 sub-directory. The behavior of `--dirstat` can be customized by
221 passing it a comma separated list of parameters.
2d174951
JH
222 The defaults are controlled by the `diff.dirstat` configuration
223 variable (see linkgit:git-config[1]).
333f3fb0 224 The following parameters are available:
204f01a2 225+
333f3fb0
JH
226--
227`changes`;;
228 Compute the dirstat numbers by counting the lines that have been
229 removed from the source, or added to the destination. This ignores
230 the amount of pure code movements within a file. In other words,
231 rearranging lines in a file is not counted as much as other changes.
232 This is the default behavior when no parameter is given.
1c57a627
JH
233`lines`;;
234 Compute the dirstat numbers by doing the regular line-based diff
235 analysis, and summing the removed/added line counts. (For binary
236 files, count 64-byte chunks instead, since binary files have no
237 natural concept of lines). This is a more expensive `--dirstat`
238 behavior than the `changes` behavior, but it does count rearranged
239 lines within a file as much as other changes. The resulting output
240 is consistent with what you get from the other `--*stat` options.
333f3fb0
JH
241`files`;;
242 Compute the dirstat numbers by counting the number of files changed.
243 Each changed file counts equally in the dirstat analysis. This is
244 the computationally cheapest `--dirstat` behavior, since it does
245 not have to look at the file contents at all.
246`cumulative`;;
247 Count changes in a child directory for the parent directory as well.
248 Note that when using `cumulative`, the sum of the percentages
249 reported may exceed 100%. The default (non-cumulative) behavior can
250 be specified with the `noncumulative` parameter.
251<limit>;;
252 An integer parameter specifies a cut-off percent (3% by default).
253 Directories contributing less than this percentage of the changes
254 are not shown in the output.
255--
256+
257Example: The following will count changed files, while ignoring
258directories with less than 10% of the total amount of changed files,
259and accumulating child directory counts in the parent directories:
260`--dirstat=files,10,cumulative`.
fd33777b 261
4ce7aab5
NTND
262--cumulative::
263 Synonym for --dirstat=cumulative
264
265--dirstat-by-file[=<param1,param2>...]::
266 Synonym for --dirstat=files,param1,param2...
267
4bbd261b
SE
268--summary::
269 Output a condensed summary of extended header information
270 such as creations, renames and mode changes.
271
02bc5b03 272ifndef::git-format-patch[]
29353273 273--patch-with-stat::
dce5ef14 274 Synonym for `-p --stat`.
02bc5b03 275endif::git-format-patch[]
29353273 276
d4cb003f 277ifndef::git-format-patch[]
64485b4a 278
dda2d79a 279-z::
5c931c8d
BG
280ifdef::git-log[]
281 Separate the commits with NULs instead of with new newlines.
282+
283Also, when `--raw` or `--numstat` has been given, do not munge
284pathnames and use NULs as output field terminators.
285endif::git-log[]
64485b4a 286ifndef::git-log[]
03aa87ed
CB
287 When `--raw`, `--numstat`, `--name-only` or `--name-status` has been
288 given, do not munge pathnames and use NULs as output field terminators.
5c931c8d 289endif::git-log[]
64485b4a 290+
860cd699
AH
291Without this option, pathnames with "unusual" characters are quoted as
292explained for the configuration variable `core.quotePath` (see
293linkgit:git-config[1]).
dda2d79a
JH
294
295--name-only::
296 Show only names of changed files.
297
946f5f7c 298--name-status::
a6f47b2b
MV
299 Show only names and status of changed files. See the description
300 of the `--diff-filter` option on what the status letters mean.
dda2d79a 301
752c0c24 302--submodule[=<format>]::
fd47ae6a
JK
303 Specify how differences in submodules are shown. When specifying
304 `--submodule=short` the 'short' format is used. This format just
305 shows the names of the commits at the beginning and end of the range.
306 When `--submodule` or `--submodule=log` is specified, the 'log'
307 format is used. This format lists the commits in the range like
308 linkgit:git-submodule[1] `summary` does. When `--submodule=diff`
309 is specified, the 'diff' format is used. This format shows an
310 inline diff of the changes in the submodule contents between the
311 commit range. Defaults to `diff.submodule` or the 'short' format
312 if the config option is unset.
752c0c24 313
73e9da01 314--color[=<when>]::
b5376648 315 Show colored diff.
3d0e75f2
JH
316 `--color` (i.e. without '=<when>') is the same as `--color=always`.
317 '<when>' can be one of `always`, `never`, or `auto`.
6999c540
MG
318ifdef::git-diff[]
319 It can be changed by the `color.ui` and `color.diff`
320 configuration settings.
321endif::git-diff[]
b5376648
JH
322
323--no-color::
6999c540
MG
324 Turn off colored diff.
325ifdef::git-diff[]
326 This can be used to override configuration settings.
327endif::git-diff[]
328 It is the same as `--color=never`.
b5376648 329
61e89eaa
SB
330--color-moved[=<mode>]::
331 Moved lines of code are colored differently.
332ifdef::git-diff[]
333 It can be changed by the `diff.colorMoved` configuration setting.
334endif::git-diff[]
335 The <mode> defaults to 'no' if the option is not given
336 and to 'zebra' if the option with no mode is given.
337 The mode must be one of:
338+
339--
340no::
341 Moved lines are not highlighted.
342default::
343 Is a synonym for `zebra`. This may change to a more sensible mode
344 in the future.
345plain::
346 Any line that is added in one location and was removed
347 in another location will be colored with 'color.diff.newMoved'.
348 Similarly 'color.diff.oldMoved' will be used for removed lines
349 that are added somewhere else in the diff. This mode picks up any
350 moved line, but it is not very useful in a review to determine
351 if a block of code was moved without permutation.
51da15eb 352blocks::
f0b8fb6e
JT
353 Blocks of moved text of at least 20 alphanumeric characters
354 are detected greedily. The detected blocks are
51da15eb
SB
355 painted using either the 'color.diff.{old,new}Moved' color.
356 Adjacent blocks cannot be told apart.
357zebra::
358 Blocks of moved text are detected as in 'blocks' mode. The blocks
359 are painted using either the 'color.diff.{old,new}Moved' color or
61e89eaa 360 'color.diff.{old,new}MovedAlternative'. The change between
f0b8fb6e 361 the two colors indicates that a new block was detected.
e3f2f5f9 362dimmed-zebra::
61e89eaa
SB
363 Similar to 'zebra', but additional dimming of uninteresting parts
364 of moved code is performed. The bordering lines of two adjacent
365 blocks are considered interesting, the rest is uninteresting.
e3f2f5f9 366 `dimmed_zebra` is a deprecated synonym.
61e89eaa
SB
367--
368
fbafb7c6
PW
369--no-color-moved::
370 Turn off move detection. This can be used to override configuration
371 settings. It is the same as `--color-moved=no`.
372
b3095712 373--color-moved-ws=<modes>::
748aa1aa 374 This configures how whitespace is ignored when performing the
626c0b5d
SB
375 move detection for `--color-moved`.
376ifdef::git-diff[]
377 It can be set by the `diff.colorMovedWS` configuration setting.
378endif::git-diff[]
379 These modes can be given as a comma separated list:
b3095712
SB
380+
381--
b73bcbac
PW
382no::
383 Do not ignore whitespace when performing move detection.
b3095712
SB
384ignore-space-at-eol::
385 Ignore changes in whitespace at EOL.
386ignore-space-change::
387 Ignore changes in amount of whitespace. This ignores whitespace
388 at line end, and considers all other sequences of one or
389 more whitespace characters to be equivalent.
390ignore-all-space::
391 Ignore whitespace when comparing lines. This ignores differences
392 even if one line has whitespace where the other line has none.
ca1f4ae4 393allow-indentation-change::
748aa1aa 394 Initially ignore any whitespace in the move detection, then
ca1f4ae4
SB
395 group the moved code blocks only into a block if the change in
396 whitespace is the same per line. This is incompatible with the
397 other modes.
b3095712
SB
398--
399
b73bcbac
PW
400--no-color-moved-ws::
401 Do not ignore whitespace when performing move detection. This can be
402 used to override configuration settings. It is the same as
403 `--color-moved-ws=no`.
404
882749a0
TR
405--word-diff[=<mode>]::
406 Show a word diff, using the <mode> to delimit changed words.
407 By default, words are delimited by whitespace; see
408 `--word-diff-regex` below. The <mode> defaults to 'plain', and
409 must be one of:
410+
411--
412color::
413 Highlight changed words using only colors. Implies `--color`.
414plain::
415 Show words as `[-removed-]` and `{+added+}`. Makes no
416 attempts to escape the delimiters if they appear in the input,
417 so the output may be ambiguous.
418porcelain::
419 Use a special line-based format intended for script
420 consumption. Added/removed/unchanged runs are printed in the
421 usual unified diff format, starting with a `+`/`-`/` `
422 character at the beginning of the line and extending to the
423 end of the line. Newlines in the input are represented by a
424 tilde `~` on a line of its own.
425none::
426 Disable word diff again.
427--
428+
429Note that despite the name of the first mode, color is used to
430highlight the changed parts in all modes if enabled.
431
432--word-diff-regex=<regex>::
433 Use <regex> to decide what a word is, instead of considering
434 runs of non-whitespace to be a word. Also implies
435 `--word-diff` unless it was already enabled.
2b6a5417 436+
882749a0 437Every non-overlapping match of the
c4b252c3
TR
438<regex> is considered a word. Anything between these matches is
439considered whitespace and ignored(!) for the purposes of finding
440differences. You may want to append `|[^[:space:]]` to your regular
441expression to make sure that it matches all non-whitespace characters.
442A match that contains a newline is silently truncated(!) at the
443newline.
80c49c3d 444+
2c15c006
MG
445For example, `--word-diff-regex=.` will treat each character as a word
446and, correspondingly, show differences character by character.
447+
98a4d87b 448The regex can also be set via a diff driver or configuration option, see
1cca17df 449linkgit:gitattributes[5] or linkgit:git-config[1]. Giving it explicitly
98a4d87b
BSSJ
450overrides any diff driver or configuration setting. Diff drivers
451override configuration settings.
882749a0
TR
452
453--color-words[=<regex>]::
454 Equivalent to `--word-diff=color` plus (if a regex was
455 specified) `--word-diff-regex=<regex>`.
d4cb003f 456endif::git-format-patch[]
f59a59e2 457
b5376648
JH
458--no-renames::
459 Turn off rename detection, even when the configuration
460 file gives the default to do so.
461
cdc43eb0
NTND
462--[no-]rename-empty::
463 Whether to use empty blobs as rename source.
464
02bc5b03 465ifndef::git-format-patch[]
16507fcf 466--check::
30211fb6
OA
467 Warn if changes introduce conflict markers or whitespace errors.
468 What are considered whitespace errors is controlled by `core.whitespace`
4f830390 469 configuration. By default, trailing whitespaces (including
7eedad15 470 lines that consist solely of whitespaces) and a space character
4f830390
CK
471 that is immediately followed by a tab character inside the
472 initial indent of the line are considered whitespace errors.
473 Exits with non-zero status if problems are found. Not compatible
474 with --exit-code.
b8767f79
JH
475
476--ws-error-highlight=<kind>::
c0bb6d9c
AH
477 Highlight whitespace errors in the `context`, `old` or `new`
478 lines of the diff. Multiple values are separated by comma,
479 `none` resets previous values, `default` reset the list to
480 `new` and `all` is a shorthand for `old,new,context`. When
481 this option is not given, and the configuration variable
482 `diff.wsErrorHighlight` is not set, only whitespace errors in
483 `new` lines are highlighted. The whitespace errors are colored
7eedad15 484 with `color.diff.whitespace`.
b8767f79 485
02bc5b03 486endif::git-format-patch[]
16507fcf 487
80b1e511 488--full-index::
6457e58c
JM
489 Instead of the first handful of characters, show the full
490 pre- and post-image blob object names on the "index"
491 line when generating patch format output.
b5376648
JH
492
493--binary::
dce5ef14 494 In addition to `--full-index`, output a binary diff that
714d491a
SO
495 can be applied with `git-apply`.
496ifndef::git-format-patch[]
497 Implies `--patch`.
498endif::git-format-patch[]
80b1e511 499
913419fc 500--abbrev[=<n>]::
47dd0d59
JH
501 Instead of showing the full 40-byte hexadecimal object
502 name in diff-raw format output and diff-tree header
cda34e0d
JH
503 lines, show the shortest prefix that is at least '<n>'
504 hexdigits long that uniquely refers the object.
3046c7f6
ĐTCD
505 In diff-patch output format, `--full-index` takes higher
506 precedence, i.e. if `--full-index` is specified, full blob
507 names will be shown regardless of `--abbrev`.
508 Non default number of digits can be specified with `--abbrev=<n>`.
47dd0d59 509
cf958afd 510-B[<n>][/<m>]::
37ab5156 511--break-rewrites[=[<n>][/<m>]]::
cf958afd
MM
512 Break complete rewrite changes into pairs of delete and
513 create. This serves two purposes:
514+
515It affects the way a change that amounts to a total rewrite of a file
516not as a series of deletion and insertion mixed together with a very
517few lines that happen to match textually as the context, but as a
518single deletion of everything old followed by a single insertion of
519everything new, and the number `m` controls this aspect of the -B
520option (defaults to 60%). `-B/70%` specifies that less than 30% of the
2de9b711 521original should remain in the result for Git to consider it a total
cf958afd
MM
522rewrite (i.e. otherwise the resulting patch will be a series of
523deletion and insertion mixed together with context lines).
524+
525When used with -M, a totally-rewritten file is also considered as the
526source of a rename (usually -M only considers a file that disappeared
527as the source of a rename), and the number `n` controls this aspect of
528the -B option (defaults to 50%). `-B20%` specifies that a change with
529addition and deletion compared to 20% or more of the file's size are
530eligible for being picked up as a possible source of a rename to
531another file.
532
533-M[<n>]::
f611ddc7 534--find-renames[=<n>]::
7ffad250 535ifndef::git-log[]
dda2d79a 536 Detect renames.
7ffad250
JK
537endif::git-log[]
538ifdef::git-log[]
539 If generating diffs, detect and report renames for each commit.
540 For following files across renames while traversing history, see
541 `--follow`.
542endif::git-log[]
4c007ae8 543 If `n` is specified, it is a threshold on the similarity
cf958afd 544 index (i.e. amount of addition/deletions compared to the
2de9b711 545 file's size). For example, `-M90%` means Git should consider a
cf958afd 546 delete/add pair to be a rename if more than 90% of the file
31d66aa4
SC
547 hasn't changed. Without a `%` sign, the number is to be read as
548 a fraction, with a decimal point before it. I.e., `-M5` becomes
549 0.5, and is thus the same as `-M50%`. Similarly, `-M05` is
550 the same as `-M5%`. To limit detection to exact renames, use
8240943b 551 `-M100%`. The default similarity index is 50%.
dda2d79a 552
cf958afd 553-C[<n>]::
f611ddc7 554--find-copies[=<n>]::
ca6c0970 555 Detect copies as well as renames. See also `--find-copies-harder`.
cf958afd 556 If `n` is specified, it has the same meaning as for `-M<n>`.
dda2d79a
JH
557
558--find-copies-harder::
ca6c0970 559 For performance reasons, by default, `-C` option finds copies only
a6080a0a 560 if the original file of the copy was modified in the same
f73ae1fc 561 changeset. This flag makes the command
dda2d79a
JH
562 inspect unmodified files as candidates for the source of
563 copy. This is a very expensive operation for large
ca6c0970
JS
564 projects, so use it with caution. Giving more than one
565 `-C` option has the same effect.
dda2d79a 566
467ddc14
JH
567-D::
568--irreversible-delete::
569 Omit the preimage for deletes, i.e. print only the header but not
570 the diff between the preimage and `/dev/null`. The resulting patch
a58088ab 571 is not meant to be applied with `patch` or `git apply`; this is
467ddc14 572 solely for people who want to just concentrate on reviewing the
bc9b7e20 573 text after the change. In addition, the output obviously lacks
467ddc14
JH
574 enough information to apply such a patch in reverse, even manually,
575 hence the name of the option.
576+
577When used together with `-B`, omit also the preimage in the deletion part
578of a delete/create pair.
579
8082d8d3 580-l<num>::
dce5ef14 581 The `-M` and `-C` options require O(n^2) processing time where n
f73ae1fc 582 is the number of potential rename/copy targets. This
8082d8d3 583 option prevents rename/copy detection from running if
f73ae1fc 584 the number of rename/copy targets exceeds the specified
8082d8d3
JH
585 number.
586
d4cb003f 587ifndef::git-format-patch[]
f1037448
YD
588--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]::
589 Select only files that are Added (`A`), Copied (`C`),
590 Deleted (`D`), Modified (`M`), Renamed (`R`), have their
591 type (i.e. regular file, symlink, submodule, ...) changed (`T`),
592 are Unmerged (`U`), are
593 Unknown (`X`), or have had their pairing Broken (`B`).
594 Any combination of the filter characters (including none) can be used.
595 When `*` (All-or-none) is added to the combination, all
596 paths are selected if there is any file that matches
597 other criteria in the comparison; if there is no file
598 that matches other criteria, nothing is selected.
16726cfa
JH
599+
600Also, these upper-case letters can be downcased to exclude. E.g.
601`--diff-filter=ad` excludes added and deleted paths.
46af107b
JK
602+
603Note that not all diffs can feature all types. For instance, diffs
604from the index to the working tree can never have Added entries
605(because the set of paths included in the diff is limited by what is in
606the index). Similarly, copied and renamed entries cannot appear if
607detection for those types is disabled.
f1037448 608
dda2d79a 609-S<string>::
5bc3f0b5
RR
610 Look for differences that change the number of occurrences of
611 the specified string (i.e. addition/deletion) in a file.
612 Intended for the scripter's use.
613+
614It is useful when you're looking for an exact block of code (like a
615struct), and want to know the history of that block since it first
616came into being: use the feature iteratively to feed the interesting
617block in the preimage back into `-S`, and keep going until you get the
618very first version of the block.
e0e7cb80
TB
619+
620Binary files are searched as well.
dda2d79a 621
f506b8e8 622-G<regex>::
5bc3f0b5
RR
623 Look for differences whose patch text contains added/removed
624 lines that match <regex>.
625+
626To illustrate the difference between `-S<regex> --pickaxe-regex` and
627`-G<regex>`, consider a commit with the following diff in the same
628file:
629+
630----
9299f849 631+ return frotz(nitfol, two->ptr, 1, 0);
5bc3f0b5 632...
9299f849 633- hit = frotz(nitfol, mf2.ptr, 1, 0);
5bc3f0b5
RR
634----
635+
9299f849
636While `git log -G"frotz\(nitfol"` will show this commit, `git log
637-S"frotz\(nitfol" --pickaxe-regex` will not (because the number of
5bc3f0b5
RR
638occurrences of that string did not change).
639+
e0e7cb80
TB
640Unless `--text` is supplied patches of binary files without a textconv
641filter will be ignored.
642+
5bc3f0b5
RR
643See the 'pickaxe' entry in linkgit:gitdiffcore[7] for more
644information.
f506b8e8 645
15af58c1
SB
646--find-object=<object-id>::
647 Look for differences that change the number of occurrences of
648 the specified object. Similar to `-S`, just the argument is different
649 in that it doesn't search for a specific string but for a specific
650 object id.
651+
652The object can be a blob or a submodule commit. It implies the `-t` option in
653`git-log` to also find trees.
654
dda2d79a 655--pickaxe-all::
f506b8e8 656 When `-S` or `-G` finds a change, show all the changes in that
f73ae1fc 657 changeset, not just the files that contain the change
dda2d79a
JH
658 in <string>.
659
d01d8c67 660--pickaxe-regex::
5bc3f0b5
RR
661 Treat the <string> given to `-S` as an extended POSIX regular
662 expression to match.
15af58c1 663
d4cb003f 664endif::git-format-patch[]
d01d8c67 665
dda2d79a 666-O<orderfile>::
874444b7 667 Control the order in which files appear in the output.
da0005b8
NTND
668 This overrides the `diff.orderFile` configuration variable
669 (see linkgit:git-config[1]). To cancel `diff.orderFile`,
6d8940b5 670 use `-O/dev/null`.
874444b7
RH
671+
672The output order is determined by the order of glob patterns in
673<orderfile>.
674All files with pathnames that match the first pattern are output
675first, all files with pathnames that match the second pattern (but not
676the first) are output next, and so on.
677All files with pathnames that do not match any pattern are output
678last, as if there was an implicit match-all pattern at the end of the
679file.
680If multiple pathnames have the same rank (they match the same pattern
681but no earlier patterns), their output order relative to each other is
682the normal order.
683+
684<orderfile> is parsed as follows:
685+
686--
687 - Blank lines are ignored, so they can be used as separators for
688 readability.
689
690 - Lines starting with a hash ("`#`") are ignored, so they can be used
691 for comments. Add a backslash ("`\`") to the beginning of the
692 pattern if it starts with a hash.
693
694 - Each other line contains a single pattern.
695--
696+
697Patterns have the same syntax and semantics as patterns used for
c30d4f1b 698fnmatch(3) without the FNM_PATHNAME flag, except a pathname also
874444b7
RH
699matches a pattern if removing any number of the final pathname
700components matches the pattern. For example, the pattern "`foo*bar`"
701matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`".
dda2d79a 702
1eb4136a
JH
703--skip-to=<file>::
704--rotate-to=<file>::
705 Discard the files before the named <file> from the output
706 (i.e. 'skip to'), or move them to the end of the output
707 (i.e. 'rotate to'). These were invented primarily for use
708 of the `git difftool` command, and may not be very useful
709 otherwise.
710
d4cb003f 711ifndef::git-format-patch[]
dda2d79a 712-R::
5f3aa197 713 Swap two inputs; that is, show differences from index or
dda2d79a 714 on-disk file to tree contents.
c28ded83 715endif::git-format-patch[]
dda2d79a 716
c0cb4a06 717--relative[=<path>]::
c28ded83 718--no-relative::
cd676a51
JH
719 When run from a subdirectory of the project, it can be
720 told to exclude changes outside the directory and show
c0cb4a06
JH
721 pathnames relative to it with this option. When you are
722 not in a subdirectory (e.g. in a bare repository), you
723 can name which subdirectory to make the output relative
724 to by giving a <path> as an argument.
c28ded83
LA
725 `--no-relative` can be used to countermand both `diff.relative` config
726 option and previous `--relative`.
cd676a51 727
a9e67c8c 728-a::
d507bb15
SF
729--text::
730 Treat all files as text.
731
e9282f02 732--ignore-cr-at-eol::
c30d4f1b 733 Ignore carriage-return at the end of line when doing a comparison.
e9282f02 734
a44a0c99 735--ignore-space-at-eol::
0ac7903e 736 Ignore changes in whitespace at EOL.
a44a0c99 737
a9e67c8c 738-b::
8ebe185b 739--ignore-space-change::
0ac7903e
WC
740 Ignore changes in amount of whitespace. This ignores whitespace
741 at line end, and considers all other sequences of one or
742 more whitespace characters to be equivalent.
8ebe185b 743
a9e67c8c 744-w::
8ebe185b 745--ignore-all-space::
0ac7903e
WC
746 Ignore whitespace when comparing lines. This ignores
747 differences even if one line has whitespace where the other
8ebe185b
JN
748 line has none.
749
36617af7
AP
750--ignore-blank-lines::
751 Ignore changes whose lines are all blank.
752
296d4a94
MK
753-I<regex>::
754--ignore-matching-lines=<regex>::
755 Ignore changes whose all lines match <regex>. This option may
756 be specified more than once.
757
6d0e674a
RS
758--inter-hunk-context=<lines>::
759 Show the context between diff hunks, up to the specified number
760 of lines, thereby fusing hunks that are close to each other.
c4888677
VN
761 Defaults to `diff.interHunkContext` or 0 if the config option
762 is unset.
6d0e674a 763
14937c2c
RS
764-W::
765--function-context::
0cce88f1
PB
766 Show whole function as context lines for each change.
767 The function names are determined in the same way as
768 `git diff` works out patch hunk headers (see 'Defining a
769 custom hunk-header' in linkgit:gitattributes[5]).
14937c2c 770
d4cb003f 771ifndef::git-format-patch[]
939ca96b 772ifndef::git-log[]
41bbf9d5
AR
773--exit-code::
774 Make the program exit with codes similar to diff(1).
775 That is, it exits with 1 if there were differences and
776 0 means no differences.
777
2a18c266 778--quiet::
dce5ef14 779 Disable all output of the program. Implies `--exit-code`.
939ca96b 780endif::git-log[]
d4cb003f 781endif::git-format-patch[]
2a18c266 782
72909bef
JS
783--ext-diff::
784 Allow an external diff helper to be executed. If you set an
5162e697
DM
785 external diff driver with linkgit:gitattributes[5], you need
786 to use this option with linkgit:git-log[1] and friends.
72909bef
JS
787
788--no-ext-diff::
789 Disallow external diff drivers.
790
d28790dc
JK
791--textconv::
792--no-textconv::
793 Allow (or disallow) external text conversion filters to be run
794 when comparing binary files. See linkgit:gitattributes[5] for
795 details. Because textconv filters are typically a one-way
796 conversion, the resulting diff is suitable for human
797 consumption, but cannot be applied. For this reason, textconv
798 filters are enabled by default only for linkgit:git-diff[1] and
799 linkgit:git-log[1], but not for linkgit:git-format-patch[1] or
800 diff plumbing commands.
801
dd44d419
JL
802--ignore-submodules[=<when>]::
803 Ignore changes to submodules in the diff generation. <when> can be
b1d04bfc 804 either "none", "untracked", "dirty" or "all", which is the default.
aee9c7d6
JL
805 Using "none" will consider the submodule modified when it either contains
806 untracked or modified files or its HEAD differs from the commit recorded
807 in the superproject and can be used to override any settings of the
302ad7a9 808 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
dd44d419
JL
809 "untracked" is used submodules are not considered dirty when they only
810 contain untracked content (but they are still scanned for modified
811 content). Using "dirty" ignores all changes to the work tree of submodules,
812 only changes to the commits stored in the superproject are shown (this was
813 the behavior until 1.7.0). Using "all" hides all changes to submodules.
50fd9bd8 814
eab9a40b
JS
815--src-prefix=<prefix>::
816 Show the given source prefix instead of "a/".
817
818--dst-prefix=<prefix>::
819 Show the given destination prefix instead of "b/".
820
821--no-prefix::
822 Do not show any source or destination prefix.
823
660e113c
JK
824--line-prefix=<prefix>::
825 Prepend an additional prefix to every line of output.
826
b42b4519
NTND
827--ita-invisible-in-index::
828 By default entries added by "git add -N" appear as an existing
829 empty file in "git diff" and a new file in "git diff --cached".
830 This option makes the entry appear as a new file in "git diff"
831 and non-existent in "git diff --cached". This option could be
832 reverted with `--ita-visible-in-index`. Both options are
833 experimental and could be removed in future.
834
8db9307c 835For more detailed explanation on these common options, see also
6998e4db 836linkgit:gitdiffcore[7].