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