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