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