Autogenerated HTML docs for v2.47.0-288-g090d2
[git-htmldocs.git] / diff-options.txt
blobcd0b81adbb69d1586b0c45a0168aa3ac2ef15303
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.
7 ifndef::git-format-patch[]
8 ifndef::git-diff[]
9 ifndef::git-log[]
10 :git-diff-core: 1
11 endif::git-log[]
12 endif::git-diff[]
13 endif::git-format-patch[]
15 ifdef::git-format-patch[]
16 -p::
17 --no-stat::
18         Generate plain patches without any diffstats.
19 endif::git-format-patch[]
21 ifndef::git-format-patch[]
22 -p::
23 -u::
24 --patch::
25         Generate patch (see <<generate_patch_text_with_p>>).
26 ifdef::git-diff[]
27         This is the default.
28 endif::git-diff[]
30 -s::
31 --no-patch::
32         Suppress all output from the diff machinery.  Useful for
33         commands like `git show` that show the patch by default to
34         squelch their output, or to cancel the effect of options like
35         `--patch`, `--stat` earlier on the command line in an alias.
37 endif::git-format-patch[]
39 ifdef::git-log[]
40 -m::
41         Show diffs for merge commits in the default format. This is
42         similar to '--diff-merges=on', except `-m` will
43         produce no output unless `-p` is given as well.
45 -c::
46         Produce combined diff output for merge commits.
47         Shortcut for '--diff-merges=combined -p'.
49 --cc::
50         Produce dense combined diff output for merge commits.
51         Shortcut for '--diff-merges=dense-combined -p'.
53 --dd::
54         Produce diff with respect to first parent for both merge and
55         regular commits.
56         Shortcut for '--diff-merges=first-parent -p'.
58 --remerge-diff::
59         Produce remerge-diff output for merge commits.
60         Shortcut for '--diff-merges=remerge -p'.
62 --no-diff-merges::
63         Synonym for '--diff-merges=off'.
65 --diff-merges=<format>::
66         Specify diff format to be used for merge commits. Default is
67         {diff-merges-default} unless `--first-parent` is in use, in
68         which case `first-parent` is the default.
70 The following formats are supported:
73 off, none::
74         Disable output of diffs for merge commits. Useful to override
75         implied value.
77 on, m::
78         Make diff output for merge commits to be shown in the default
79         format. The default format can be changed using
80         `log.diffMerges` configuration variable, whose default value
81         is `separate`.
83 first-parent, 1::
84         Show full diff with respect to first parent. This is the same
85         format as `--patch` produces for non-merge commits.
87 separate::
88         Show full diff with respect to each of parents.
89         Separate log entry and diff is generated for each parent.
91 combined, c::
92         Show differences from each of the parents to the merge
93         result simultaneously instead of showing pairwise diff between
94         a parent and the result one at a time. Furthermore, it lists
95         only files which were modified from all parents.
97 dense-combined, cc::
98         Further compress output produced by `--diff-merges=combined`
99         by omitting uninteresting hunks whose contents in the parents
100         have only two variants and the merge result picks one of them
101         without modification.
103 remerge, r::
104         Remerge two-parent merge commits to create a temporary tree
105         object--potentially containing files with conflict markers
106         and such.  A diff is then shown between that temporary tree
107         and the actual merge commit.
109 The output emitted when this option is used is subject to change, and
110 so is its interaction with other options (unless explicitly
111 documented).
114 --combined-all-paths::
115         This flag causes combined diffs (used for merge commits) to
116         list the name of the file from all parents.  It thus only has
117         effect when `--diff-merges=[dense-]combined` is in use, and
118         is likely only useful if filename changes are detected (i.e.
119         when either rename or copy detection have been requested).
120 endif::git-log[]
122 -U<n>::
123 --unified=<n>::
124         Generate diffs with <n> lines of context instead of
125         the usual three.
126 ifndef::git-format-patch[]
127         Implies `--patch`.
128 endif::git-format-patch[]
130 --output=<file>::
131         Output to a specific file instead of stdout.
133 --output-indicator-new=<char>::
134 --output-indicator-old=<char>::
135 --output-indicator-context=<char>::
136         Specify the character used to indicate new, old or context
137         lines in the generated patch. Normally they are '+', '-' and
138         ' ' respectively.
140 ifndef::git-format-patch[]
141 --raw::
142 ifndef::git-log[]
143         Generate the diff in raw format.
144 ifdef::git-diff-core[]
145         This is the default.
146 endif::git-diff-core[]
147 endif::git-log[]
148 ifdef::git-log[]
149         For each commit, show a summary of changes using the raw diff
150         format. See the "RAW OUTPUT FORMAT" section of
151         linkgit:git-diff[1]. This is different from showing the log
152         itself in raw format, which you can achieve with
153         `--format=raw`.
154 endif::git-log[]
155 endif::git-format-patch[]
157 ifndef::git-format-patch[]
158 --patch-with-raw::
159         Synonym for `-p --raw`.
160 endif::git-format-patch[]
162 ifdef::git-log[]
163 -t::
164         Show the tree objects in the diff output.
165 endif::git-log[]
167 --indent-heuristic::
168         Enable the heuristic that shifts diff hunk boundaries to make patches
169         easier to read. This is the default.
171 --no-indent-heuristic::
172         Disable the indent heuristic.
174 --minimal::
175         Spend extra time to make sure the smallest possible
176         diff is produced.
178 --patience::
179         Generate a diff using the "patience diff" algorithm.
181 --histogram::
182         Generate a diff using the "histogram diff" algorithm.
184 --anchored=<text>::
185         Generate a diff using the "anchored diff" algorithm.
187 This option may be specified more than once.
189 If a line exists in both the source and destination, exists only once,
190 and starts with this text, this algorithm attempts to prevent it from
191 appearing as a deletion or addition in the output. It uses the "patience
192 diff" algorithm internally.
194 --diff-algorithm={patience|minimal|histogram|myers}::
195         Choose a diff algorithm. The variants are as follows:
198 `default`, `myers`;;
199         The basic greedy diff algorithm. Currently, this is the default.
200 `minimal`;;
201         Spend extra time to make sure the smallest possible diff is
202         produced.
203 `patience`;;
204         Use "patience diff" algorithm when generating patches.
205 `histogram`;;
206         This algorithm extends the patience algorithm to "support
207         low-occurrence common elements".
210 For instance, if you configured the `diff.algorithm` variable to a
211 non-default value and want to use the default one, then you
212 have to use `--diff-algorithm=default` option.
214 --stat[=<width>[,<name-width>[,<count>]]]::
215         Generate a diffstat. By default, as much space as necessary
216         will be used for the filename part, and the rest for the graph
217         part. Maximum width defaults to terminal width, or 80 columns
218         if not connected to a terminal, and can be overridden by
219         `<width>`. The width of the filename part can be limited by
220         giving another width `<name-width>` after a comma or by setting
221         `diff.statNameWidth=<width>`. The width of the graph part can be
222         limited by using `--stat-graph-width=<width>` or by setting
223         `diff.statGraphWidth=<width>`. Using `--stat` or
224         `--stat-graph-width` affects all commands generating a stat graph,
225         while setting `diff.statNameWidth` or `diff.statGraphWidth`
226         does not affect `git format-patch`.
227         By giving a third parameter `<count>`, you can limit the output to
228         the first `<count>` lines, followed by `...` if there are more.
230 These parameters can also be set individually with `--stat-width=<width>`,
231 `--stat-name-width=<name-width>` and `--stat-count=<count>`.
233 --compact-summary::
234         Output a condensed summary of extended header information such
235         as file creations or deletions ("new" or "gone", optionally "+l"
236         if it's a symlink) and mode changes ("+x" or "-x" for adding
237         or removing executable bit respectively) in diffstat. The
238         information is put between the filename part and the graph
239         part. Implies `--stat`.
241 --numstat::
242         Similar to `--stat`, but shows number of added and
243         deleted lines in decimal notation and pathname without
244         abbreviation, to make it more machine friendly.  For
245         binary files, outputs two `-` instead of saying
246         `0 0`.
248 --shortstat::
249         Output only the last line of the `--stat` format containing total
250         number of modified files, as well as number of added and deleted
251         lines.
253 -X[<param1,param2,...>]::
254 --dirstat[=<param1,param2,...>]::
255         Output the distribution of relative amount of changes for each
256         sub-directory. The behavior of `--dirstat` can be customized by
257         passing it a comma separated list of parameters.
258         The defaults are controlled by the `diff.dirstat` configuration
259         variable (see linkgit:git-config[1]).
260         The following parameters are available:
263 `changes`;;
264         Compute the dirstat numbers by counting the lines that have been
265         removed from the source, or added to the destination. This ignores
266         the amount of pure code movements within a file.  In other words,
267         rearranging lines in a file is not counted as much as other changes.
268         This is the default behavior when no parameter is given.
269 `lines`;;
270         Compute the dirstat numbers by doing the regular line-based diff
271         analysis, and summing the removed/added line counts. (For binary
272         files, count 64-byte chunks instead, since binary files have no
273         natural concept of lines). This is a more expensive `--dirstat`
274         behavior than the `changes` behavior, but it does count rearranged
275         lines within a file as much as other changes. The resulting output
276         is consistent with what you get from the other `--*stat` options.
277 `files`;;
278         Compute the dirstat numbers by counting the number of files changed.
279         Each changed file counts equally in the dirstat analysis. This is
280         the computationally cheapest `--dirstat` behavior, since it does
281         not have to look at the file contents at all.
282 `cumulative`;;
283         Count changes in a child directory for the parent directory as well.
284         Note that when using `cumulative`, the sum of the percentages
285         reported may exceed 100%. The default (non-cumulative) behavior can
286         be specified with the `noncumulative` parameter.
287 <limit>;;
288         An integer parameter specifies a cut-off percent (3% by default).
289         Directories contributing less than this percentage of the changes
290         are not shown in the output.
293 Example: The following will count changed files, while ignoring
294 directories with less than 10% of the total amount of changed files,
295 and accumulating child directory counts in the parent directories:
296 `--dirstat=files,10,cumulative`.
298 --cumulative::
299         Synonym for --dirstat=cumulative
301 --dirstat-by-file[=<param1,param2>...]::
302         Synonym for --dirstat=files,<param1>,<param2>...
304 --summary::
305         Output a condensed summary of extended header information
306         such as creations, renames and mode changes.
308 ifndef::git-format-patch[]
309 --patch-with-stat::
310         Synonym for `-p --stat`.
311 endif::git-format-patch[]
313 ifndef::git-format-patch[]
315 -z::
316 ifdef::git-log[]
317         Separate the commits with NULs instead of newlines.
319 Also, when `--raw` or `--numstat` has been given, do not munge
320 pathnames and use NULs as output field terminators.
321 endif::git-log[]
322 ifndef::git-log[]
323         When `--raw`, `--numstat`, `--name-only` or `--name-status` has been
324         given, do not munge pathnames and use NULs as output field terminators.
325 endif::git-log[]
327 Without this option, pathnames with "unusual" characters are quoted as
328 explained for the configuration variable `core.quotePath` (see
329 linkgit:git-config[1]).
331 --name-only::
332         Show only the name of each changed file in the post-image tree.
333         The file names are often encoded in UTF-8.
334         For more information see the discussion about encoding in the linkgit:git-log[1]
335         manual page.
337 --name-status::
338         Show only the name(s) and status of each changed file. See the description
339         of the `--diff-filter` option on what the status letters mean.
340         Just like `--name-only` the file names are often encoded in UTF-8.
342 --submodule[=<format>]::
343         Specify how differences in submodules are shown.  When specifying
344         `--submodule=short` the 'short' format is used.  This format just
345         shows the names of the commits at the beginning and end of the range.
346         When `--submodule` or `--submodule=log` is specified, the 'log'
347         format is used.  This format lists the commits in the range like
348         linkgit:git-submodule[1] `summary` does.  When `--submodule=diff`
349         is specified, the 'diff' format is used.  This format shows an
350         inline diff of the changes in the submodule contents between the
351         commit range.  Defaults to `diff.submodule` or the 'short' format
352         if the config option is unset.
354 --color[=<when>]::
355         Show colored diff.
356         `--color` (i.e. without '=<when>') is the same as `--color=always`.
357         '<when>' can be one of `always`, `never`, or `auto`.
358 ifdef::git-diff[]
359         It can be changed by the `color.ui` and `color.diff`
360         configuration settings.
361 endif::git-diff[]
363 --no-color::
364         Turn off colored diff.
365 ifdef::git-diff[]
366         This can be used to override configuration settings.
367 endif::git-diff[]
368         It is the same as `--color=never`.
370 --color-moved[=<mode>]::
371         Moved lines of code are colored differently.
372 ifdef::git-diff[]
373         It can be changed by the `diff.colorMoved` configuration setting.
374 endif::git-diff[]
375         The <mode> defaults to 'no' if the option is not given
376         and to 'zebra' if the option with no mode is given.
377         The mode must be one of:
380 no::
381         Moved lines are not highlighted.
382 default::
383         Is a synonym for `zebra`. This may change to a more sensible mode
384         in the future.
385 plain::
386         Any line that is added in one location and was removed
387         in another location will be colored with 'color.diff.newMoved'.
388         Similarly 'color.diff.oldMoved' will be used for removed lines
389         that are added somewhere else in the diff. This mode picks up any
390         moved line, but it is not very useful in a review to determine
391         if a block of code was moved without permutation.
392 blocks::
393         Blocks of moved text of at least 20 alphanumeric characters
394         are detected greedily. The detected blocks are
395         painted using either the 'color.diff.{old,new}Moved' color.
396         Adjacent blocks cannot be told apart.
397 zebra::
398         Blocks of moved text are detected as in 'blocks' mode. The blocks
399         are painted using either the 'color.diff.{old,new}Moved' color or
400         'color.diff.{old,new}MovedAlternative'. The change between
401         the two colors indicates that a new block was detected.
402 dimmed-zebra::
403         Similar to 'zebra', but additional dimming of uninteresting parts
404         of moved code is performed. The bordering lines of two adjacent
405         blocks are considered interesting, the rest is uninteresting.
406         `dimmed_zebra` is a deprecated synonym.
409 --no-color-moved::
410         Turn off move detection. This can be used to override configuration
411         settings. It is the same as `--color-moved=no`.
413 --color-moved-ws=<modes>::
414         This configures how whitespace is ignored when performing the
415         move detection for `--color-moved`.
416 ifdef::git-diff[]
417         It can be set by the `diff.colorMovedWS` configuration setting.
418 endif::git-diff[]
419         These modes can be given as a comma separated list:
422 no::
423         Do not ignore whitespace when performing move detection.
424 ignore-space-at-eol::
425         Ignore changes in whitespace at EOL.
426 ignore-space-change::
427         Ignore changes in amount of whitespace.  This ignores whitespace
428         at line end, and considers all other sequences of one or
429         more whitespace characters to be equivalent.
430 ignore-all-space::
431         Ignore whitespace when comparing lines. This ignores differences
432         even if one line has whitespace where the other line has none.
433 allow-indentation-change::
434         Initially ignore any whitespace in the move detection, then
435         group the moved code blocks only into a block if the change in
436         whitespace is the same per line. This is incompatible with the
437         other modes.
440 --no-color-moved-ws::
441         Do not ignore whitespace when performing move detection. This can be
442         used to override configuration settings. It is the same as
443         `--color-moved-ws=no`.
445 --word-diff[=<mode>]::
446         Show a word diff, using the <mode> to delimit changed words.
447         By default, words are delimited by whitespace; see
448         `--word-diff-regex` below.  The <mode> defaults to 'plain', and
449         must be one of:
452 color::
453         Highlight changed words using only colors.  Implies `--color`.
454 plain::
455         Show words as `[-removed-]` and `{+added+}`.  Makes no
456         attempts to escape the delimiters if they appear in the input,
457         so the output may be ambiguous.
458 porcelain::
459         Use a special line-based format intended for script
460         consumption.  Added/removed/unchanged runs are printed in the
461         usual unified diff format, starting with a `+`/`-`/` `
462         character at the beginning of the line and extending to the
463         end of the line.  Newlines in the input are represented by a
464         tilde `~` on a line of its own.
465 none::
466         Disable word diff again.
469 Note that despite the name of the first mode, color is used to
470 highlight the changed parts in all modes if enabled.
472 --word-diff-regex=<regex>::
473         Use <regex> to decide what a word is, instead of considering
474         runs of non-whitespace to be a word.  Also implies
475         `--word-diff` unless it was already enabled.
477 Every non-overlapping match of the
478 <regex> is considered a word.  Anything between these matches is
479 considered whitespace and ignored(!) for the purposes of finding
480 differences.  You may want to append `|[^[:space:]]` to your regular
481 expression to make sure that it matches all non-whitespace characters.
482 A match that contains a newline is silently truncated(!) at the
483 newline.
485 For example, `--word-diff-regex=.` will treat each character as a word
486 and, correspondingly, show differences character by character.
488 The regex can also be set via a diff driver or configuration option, see
489 linkgit:gitattributes[5] or linkgit:git-config[1].  Giving it explicitly
490 overrides any diff driver or configuration setting.  Diff drivers
491 override configuration settings.
493 --color-words[=<regex>]::
494         Equivalent to `--word-diff=color` plus (if a regex was
495         specified) `--word-diff-regex=<regex>`.
496 endif::git-format-patch[]
498 --no-renames::
499         Turn off rename detection, even when the configuration
500         file gives the default to do so.
502 --[no-]rename-empty::
503         Whether to use empty blobs as rename source.
505 ifndef::git-format-patch[]
506 --check::
507         Warn if changes introduce conflict markers or whitespace errors.
508         What are considered whitespace errors is controlled by `core.whitespace`
509         configuration.  By default, trailing whitespaces (including
510         lines that consist solely of whitespaces) and a space character
511         that is immediately followed by a tab character inside the
512         initial indent of the line are considered whitespace errors.
513         Exits with non-zero status if problems are found. Not compatible
514         with --exit-code.
516 --ws-error-highlight=<kind>::
517         Highlight whitespace errors in the `context`, `old` or `new`
518         lines of the diff.  Multiple values are separated by comma,
519         `none` resets previous values, `default` reset the list to
520         `new` and `all` is a shorthand for `old,new,context`.  When
521         this option is not given, and the configuration variable
522         `diff.wsErrorHighlight` is not set, only whitespace errors in
523         `new` lines are highlighted. The whitespace errors are colored
524         with `color.diff.whitespace`.
526 endif::git-format-patch[]
528 --full-index::
529         Instead of the first handful of characters, show the full
530         pre- and post-image blob object names on the "index"
531         line when generating patch format output.
533 --binary::
534         In addition to `--full-index`, output a binary diff that
535         can be applied with `git-apply`.
536 ifndef::git-format-patch[]
537         Implies `--patch`.
538 endif::git-format-patch[]
540 --abbrev[=<n>]::
541         Instead of showing the full 40-byte hexadecimal object
542         name in diff-raw format output and diff-tree header
543         lines, show the shortest prefix that is at least '<n>'
544         hexdigits long that uniquely refers the object.
545         In diff-patch output format, `--full-index` takes higher
546         precedence, i.e. if `--full-index` is specified, full blob
547         names will be shown regardless of `--abbrev`.
548         Non default number of digits can be specified with `--abbrev=<n>`.
550 -B[<n>][/<m>]::
551 --break-rewrites[=[<n>][/<m>]]::
552         Break complete rewrite changes into pairs of delete and
553         create. This serves two purposes:
555 It affects the way a change that amounts to a total rewrite of a file
556 not as a series of deletion and insertion mixed together with a very
557 few lines that happen to match textually as the context, but as a
558 single deletion of everything old followed by a single insertion of
559 everything new, and the number `m` controls this aspect of the -B
560 option (defaults to 60%). `-B/70%` specifies that less than 30% of the
561 original should remain in the result for Git to consider it a total
562 rewrite (i.e. otherwise the resulting patch will be a series of
563 deletion and insertion mixed together with context lines).
565 When used with -M, a totally-rewritten file is also considered as the
566 source of a rename (usually -M only considers a file that disappeared
567 as the source of a rename), and the number `n` controls this aspect of
568 the -B option (defaults to 50%). `-B20%` specifies that a change with
569 addition and deletion compared to 20% or more of the file's size are
570 eligible for being picked up as a possible source of a rename to
571 another file.
573 -M[<n>]::
574 --find-renames[=<n>]::
575 ifndef::git-log[]
576         Detect renames.
577 endif::git-log[]
578 ifdef::git-log[]
579         If generating diffs, detect and report renames for each commit.
580         For following files across renames while traversing history, see
581         `--follow`.
582 endif::git-log[]
583         If `n` is specified, it is a threshold on the similarity
584         index (i.e. amount of addition/deletions compared to the
585         file's size). For example, `-M90%` means Git should consider a
586         delete/add pair to be a rename if more than 90% of the file
587         hasn't changed.  Without a `%` sign, the number is to be read as
588         a fraction, with a decimal point before it.  I.e., `-M5` becomes
589         0.5, and is thus the same as `-M50%`.  Similarly, `-M05` is
590         the same as `-M5%`.  To limit detection to exact renames, use
591         `-M100%`.  The default similarity index is 50%.
593 -C[<n>]::
594 --find-copies[=<n>]::
595         Detect copies as well as renames.  See also `--find-copies-harder`.
596         If `n` is specified, it has the same meaning as for `-M<n>`.
598 --find-copies-harder::
599         For performance reasons, by default, `-C` option finds copies only
600         if the original file of the copy was modified in the same
601         changeset.  This flag makes the command
602         inspect unmodified files as candidates for the source of
603         copy.  This is a very expensive operation for large
604         projects, so use it with caution.  Giving more than one
605         `-C` option has the same effect.
607 -D::
608 --irreversible-delete::
609         Omit the preimage for deletes, i.e. print only the header but not
610         the diff between the preimage and `/dev/null`. The resulting patch
611         is not meant to be applied with `patch` or `git apply`; this is
612         solely for people who want to just concentrate on reviewing the
613         text after the change. In addition, the output obviously lacks
614         enough information to apply such a patch in reverse, even manually,
615         hence the name of the option.
617 When used together with `-B`, omit also the preimage in the deletion part
618 of a delete/create pair.
620 -l<num>::
621         The `-M` and `-C` options involve some preliminary steps that
622         can detect subsets of renames/copies cheaply, followed by an
623         exhaustive fallback portion that compares all remaining
624         unpaired destinations to all relevant sources.  (For renames,
625         only remaining unpaired sources are relevant; for copies, all
626         original sources are relevant.)  For N sources and
627         destinations, this exhaustive check is O(N^2).  This option
628         prevents the exhaustive portion of rename/copy detection from
629         running if the number of source/destination files involved
630         exceeds the specified number.  Defaults to diff.renameLimit.
631         Note that a value of 0 is treated as unlimited.
633 ifndef::git-format-patch[]
634 --diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]::
635         Select only files that are Added (`A`), Copied (`C`),
636         Deleted (`D`), Modified (`M`), Renamed (`R`), have their
637         type (i.e. regular file, symlink, submodule, ...) changed (`T`),
638         are Unmerged (`U`), are
639         Unknown (`X`), or have had their pairing Broken (`B`).
640         Any combination of the filter characters (including none) can be used.
641         When `*` (All-or-none) is added to the combination, all
642         paths are selected if there is any file that matches
643         other criteria in the comparison; if there is no file
644         that matches other criteria, nothing is selected.
646 Also, these upper-case letters can be downcased to exclude.  E.g.
647 `--diff-filter=ad` excludes added and deleted paths.
649 Note that not all diffs can feature all types. For instance, copied and
650 renamed entries cannot appear if detection for those types is disabled.
652 -S<string>::
653         Look for differences that change the number of occurrences of
654         the specified string (i.e. addition/deletion) in a file.
655         Intended for the scripter's use.
657 It is useful when you're looking for an exact block of code (like a
658 struct), and want to know the history of that block since it first
659 came into being: use the feature iteratively to feed the interesting
660 block in the preimage back into `-S`, and keep going until you get the
661 very first version of the block.
663 Binary files are searched as well.
665 -G<regex>::
666         Look for differences whose patch text contains added/removed
667         lines that match <regex>.
669 To illustrate the difference between `-S<regex> --pickaxe-regex` and
670 `-G<regex>`, consider a commit with the following diff in the same
671 file:
673 ----
674 +    return frotz(nitfol, two->ptr, 1, 0);
676 -    hit = frotz(nitfol, mf2.ptr, 1, 0);
677 ----
679 While `git log -G"frotz\(nitfol"` will show this commit, `git log
680 -S"frotz\(nitfol" --pickaxe-regex` will not (because the number of
681 occurrences of that string did not change).
683 Unless `--text` is supplied patches of binary files without a textconv
684 filter will be ignored.
686 See the 'pickaxe' entry in linkgit:gitdiffcore[7] for more
687 information.
689 --find-object=<object-id>::
690         Look for differences that change the number of occurrences of
691         the specified object. Similar to `-S`, just the argument is different
692         in that it doesn't search for a specific string but for a specific
693         object id.
695 The object can be a blob or a submodule commit. It implies the `-t` option in
696 `git-log` to also find trees.
698 --pickaxe-all::
699         When `-S` or `-G` finds a change, show all the changes in that
700         changeset, not just the files that contain the change
701         in <string>.
703 --pickaxe-regex::
704         Treat the <string> given to `-S` as an extended POSIX regular
705         expression to match.
707 endif::git-format-patch[]
709 -O<orderfile>::
710         Control the order in which files appear in the output.
711         This overrides the `diff.orderFile` configuration variable
712         (see linkgit:git-config[1]).  To cancel `diff.orderFile`,
713         use `-O/dev/null`.
715 The output order is determined by the order of glob patterns in
716 <orderfile>.
717 All files with pathnames that match the first pattern are output
718 first, all files with pathnames that match the second pattern (but not
719 the first) are output next, and so on.
720 All files with pathnames that do not match any pattern are output
721 last, as if there was an implicit match-all pattern at the end of the
722 file.
723 If multiple pathnames have the same rank (they match the same pattern
724 but no earlier patterns), their output order relative to each other is
725 the normal order.
727 <orderfile> is parsed as follows:
730  - Blank lines are ignored, so they can be used as separators for
731    readability.
733  - Lines starting with a hash ("`#`") are ignored, so they can be used
734    for comments.  Add a backslash ("`\`") to the beginning of the
735    pattern if it starts with a hash.
737  - Each other line contains a single pattern.
740 Patterns have the same syntax and semantics as patterns used for
741 fnmatch(3) without the FNM_PATHNAME flag, except a pathname also
742 matches a pattern if removing any number of the final pathname
743 components matches the pattern.  For example, the pattern "`foo*bar`"
744 matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`".
746 --skip-to=<file>::
747 --rotate-to=<file>::
748         Discard the files before the named <file> from the output
749         (i.e. 'skip to'), or move them to the end of the output
750         (i.e. 'rotate to').  These options were invented primarily for the use
751         of the `git difftool` command, and may not be very useful
752         otherwise.
754 ifndef::git-format-patch[]
755 -R::
756         Swap two inputs; that is, show differences from index or
757         on-disk file to tree contents.
758 endif::git-format-patch[]
760 --relative[=<path>]::
761 --no-relative::
762         When run from a subdirectory of the project, it can be
763         told to exclude changes outside the directory and show
764         pathnames relative to it with this option.  When you are
765         not in a subdirectory (e.g. in a bare repository), you
766         can name which subdirectory to make the output relative
767         to by giving a <path> as an argument.
768         `--no-relative` can be used to countermand both `diff.relative` config
769         option and previous `--relative`.
771 -a::
772 --text::
773         Treat all files as text.
775 --ignore-cr-at-eol::
776         Ignore carriage-return at the end of line when doing a comparison.
778 --ignore-space-at-eol::
779         Ignore changes in whitespace at EOL.
781 -b::
782 --ignore-space-change::
783         Ignore changes in amount of whitespace.  This ignores whitespace
784         at line end, and considers all other sequences of one or
785         more whitespace characters to be equivalent.
787 -w::
788 --ignore-all-space::
789         Ignore whitespace when comparing lines.  This ignores
790         differences even if one line has whitespace where the other
791         line has none.
793 --ignore-blank-lines::
794         Ignore changes whose lines are all blank.
796 -I<regex>::
797 --ignore-matching-lines=<regex>::
798         Ignore changes whose all lines match <regex>.  This option may
799         be specified more than once.
801 --inter-hunk-context=<lines>::
802         Show the context between diff hunks, up to the specified number
803         of lines, thereby fusing hunks that are close to each other.
804         Defaults to `diff.interHunkContext` or 0 if the config option
805         is unset.
807 -W::
808 --function-context::
809         Show whole function as context lines for each change.
810         The function names are determined in the same way as
811         `git diff` works out patch hunk headers (see 'Defining a
812         custom hunk-header' in linkgit:gitattributes[5]).
814 ifndef::git-format-patch[]
815 ifndef::git-log[]
816 --exit-code::
817         Make the program exit with codes similar to diff(1).
818         That is, it exits with 1 if there were differences and
819         0 means no differences.
821 --quiet::
822         Disable all output of the program. Implies `--exit-code`.
823         Disables execution of external diff helpers whose exit code
824         is not trusted, i.e. their respective configuration option
825         `diff.trustExitCode` or `diff.<driver>.trustExitCode` or
826         environment variable `GIT_EXTERNAL_DIFF_TRUST_EXIT_CODE` is
827         false.
828 endif::git-log[]
829 endif::git-format-patch[]
831 --ext-diff::
832         Allow an external diff helper to be executed. If you set an
833         external diff driver with linkgit:gitattributes[5], you need
834         to use this option with linkgit:git-log[1] and friends.
836 --no-ext-diff::
837         Disallow external diff drivers.
839 --textconv::
840 --no-textconv::
841         Allow (or disallow) external text conversion filters to be run
842         when comparing binary files. See linkgit:gitattributes[5] for
843         details. Because textconv filters are typically a one-way
844         conversion, the resulting diff is suitable for human
845         consumption, but cannot be applied. For this reason, textconv
846         filters are enabled by default only for linkgit:git-diff[1] and
847         linkgit:git-log[1], but not for linkgit:git-format-patch[1] or
848         diff plumbing commands.
850 --ignore-submodules[=<when>]::
851         Ignore changes to submodules in the diff generation. <when> can be
852         either "none", "untracked", "dirty" or "all", which is the default.
853         Using "none" will consider the submodule modified when it either contains
854         untracked or modified files or its HEAD differs from the commit recorded
855         in the superproject and can be used to override any settings of the
856         'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
857         "untracked" is used submodules are not considered dirty when they only
858         contain untracked content (but they are still scanned for modified
859         content). Using "dirty" ignores all changes to the work tree of submodules,
860         only changes to the commits stored in the superproject are shown (this was
861         the behavior until 1.7.0). Using "all" hides all changes to submodules.
863 --src-prefix=<prefix>::
864         Show the given source prefix instead of "a/".
866 --dst-prefix=<prefix>::
867         Show the given destination prefix instead of "b/".
869 --no-prefix::
870         Do not show any source or destination prefix.
872 --default-prefix::
873         Use the default source and destination prefixes ("a/" and "b/").
874         This overrides configuration variables such as `diff.noprefix`,
875         `diff.srcPrefix`, `diff.dstPrefix`, and `diff.mnemonicPrefix`
876         (see `git-config`(1)).
878 --line-prefix=<prefix>::
879         Prepend an additional prefix to every line of output.
881 --ita-invisible-in-index::
882         By default entries added by "git add -N" appear as an existing
883         empty file in "git diff" and a new file in "git diff --cached".
884         This option makes the entry appear as a new file in "git diff"
885         and non-existent in "git diff --cached". This option could be
886         reverted with `--ita-visible-in-index`. Both options are
887         experimental and could be removed in future.
889 For more detailed explanation on these common options, see also
890 linkgit:gitdiffcore[7].