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