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[]
13 endif::git-format-patch[]
15 ifdef::git-format-patch[]
18 Generate plain patches without any diffstats.
19 endif::git-format-patch[]
21 ifndef::git-format-patch[]
25 Generate patch (see section on generating patches).
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[]
38 Generate diffs with <n> lines of context instead of
40 ifndef::git-format-patch[]
42 endif::git-format-patch[]
44 ifndef::git-format-patch[]
47 Generate the diff in raw format.
48 ifdef::git-diff-core[]
50 endif::git-diff-core[]
53 For each commit, show a summary of changes using the raw diff
54 format. See the "RAW OUTPUT FORMAT" section of
55 linkgit:git-diff[1]. This is different from showing the log
56 itself in raw format, which you can achieve with
59 endif::git-format-patch[]
61 ifndef::git-format-patch[]
63 Synonym for `-p --raw`.
64 endif::git-format-patch[]
67 Enable the heuristic that shifts diff hunk boundaries to make patches
68 easier to read. This is the default.
70 --no-indent-heuristic::
71 Disable the indent heuristic.
74 Spend extra time to make sure the smallest possible
78 Generate a diff using the "patience diff" algorithm.
81 Generate a diff using the "histogram diff" algorithm.
84 Generate a diff using the "anchored diff" algorithm.
86 This option may be specified more than once.
88 If a line exists in both the source and destination, exists only once,
89 and starts with this text, this algorithm attempts to prevent it from
90 appearing as a deletion or addition in the output. It uses the "patience
91 diff" algorithm internally.
93 --diff-algorithm={patience|minimal|histogram|myers}::
94 Choose a diff algorithm. The variants are as follows:
98 The basic greedy diff algorithm. Currently, this is the default.
100 Spend extra time to make sure the smallest possible diff is
103 Use "patience diff" algorithm when generating patches.
105 This algorithm extends the patience algorithm to "support
106 low-occurrence common elements".
109 For instance, if you configured the `diff.algorithm` variable to a
110 non-default value and want to use the default one, then you
111 have to use `--diff-algorithm=default` option.
113 --stat[=<width>[,<name-width>[,<count>]]]::
114 Generate a diffstat. By default, as much space as necessary
115 will be used for the filename part, and the rest for the graph
116 part. Maximum width defaults to terminal width, or 80 columns
117 if not connected to a terminal, and can be overridden by
118 `<width>`. The width of the filename part can be limited by
119 giving another width `<name-width>` after a comma. The width
120 of the graph part can be limited by using
121 `--stat-graph-width=<width>` (affects all commands generating
122 a stat graph) or by setting `diff.statGraphWidth=<width>`
123 (does not affect `git format-patch`).
124 By giving a third parameter `<count>`, you can limit the
125 output to the first `<count>` lines, followed by `...` if
128 These parameters can also be set individually with `--stat-width=<width>`,
129 `--stat-name-width=<name-width>` and `--stat-count=<count>`.
132 Output a condensed summary of extended header information such
133 as file creations or deletions ("new" or "gone", optionally "+l"
134 if it's a symlink) and mode changes ("+x" or "-x" for adding
135 or removing executable bit respectively) in diffstat. The
136 information is put between the filename part and the graph
137 part. Implies `--stat`.
140 Similar to `--stat`, but shows number of added and
141 deleted lines in decimal notation and pathname without
142 abbreviation, to make it more machine friendly. For
143 binary files, outputs two `-` instead of saying
147 Output only the last line of the `--stat` format containing total
148 number of modified files, as well as number of added and deleted
151 --dirstat[=<param1,param2,...>]::
152 Output the distribution of relative amount of changes for each
153 sub-directory. The behavior of `--dirstat` can be customized by
154 passing it a comma separated list of parameters.
155 The defaults are controlled by the `diff.dirstat` configuration
156 variable (see linkgit:git-config[1]).
157 The following parameters are available:
161 Compute the dirstat numbers by counting the lines that have been
162 removed from the source, or added to the destination. This ignores
163 the amount of pure code movements within a file. In other words,
164 rearranging lines in a file is not counted as much as other changes.
165 This is the default behavior when no parameter is given.
167 Compute the dirstat numbers by doing the regular line-based diff
168 analysis, and summing the removed/added line counts. (For binary
169 files, count 64-byte chunks instead, since binary files have no
170 natural concept of lines). This is a more expensive `--dirstat`
171 behavior than the `changes` behavior, but it does count rearranged
172 lines within a file as much as other changes. The resulting output
173 is consistent with what you get from the other `--*stat` options.
175 Compute the dirstat numbers by counting the number of files changed.
176 Each changed file counts equally in the dirstat analysis. This is
177 the computationally cheapest `--dirstat` behavior, since it does
178 not have to look at the file contents at all.
180 Count changes in a child directory for the parent directory as well.
181 Note that when using `cumulative`, the sum of the percentages
182 reported may exceed 100%. The default (non-cumulative) behavior can
183 be specified with the `noncumulative` parameter.
185 An integer parameter specifies a cut-off percent (3% by default).
186 Directories contributing less than this percentage of the changes
187 are not shown in the output.
190 Example: The following will count changed files, while ignoring
191 directories with less than 10% of the total amount of changed files,
192 and accumulating child directory counts in the parent directories:
193 `--dirstat=files,10,cumulative`.
196 Output a condensed summary of extended header information
197 such as creations, renames and mode changes.
199 ifndef::git-format-patch[]
201 Synonym for `-p --stat`.
202 endif::git-format-patch[]
204 ifndef::git-format-patch[]
208 Separate the commits with NULs instead of with new newlines.
210 Also, when `--raw` or `--numstat` has been given, do not munge
211 pathnames and use NULs as output field terminators.
214 When `--raw`, `--numstat`, `--name-only` or `--name-status` has been
215 given, do not munge pathnames and use NULs as output field terminators.
218 Without this option, pathnames with "unusual" characters are quoted as
219 explained for the configuration variable `core.quotePath` (see
220 linkgit:git-config[1]).
223 Show only names of changed files.
226 Show only names and status of changed files. See the description
227 of the `--diff-filter` option on what the status letters mean.
229 --submodule[=<format>]::
230 Specify how differences in submodules are shown. When specifying
231 `--submodule=short` the 'short' format is used. This format just
232 shows the names of the commits at the beginning and end of the range.
233 When `--submodule` or `--submodule=log` is specified, the 'log'
234 format is used. This format lists the commits in the range like
235 linkgit:git-submodule[1] `summary` does. When `--submodule=diff`
236 is specified, the 'diff' format is used. This format shows an
237 inline diff of the changes in the submodule contents between the
238 commit range. Defaults to `diff.submodule` or the 'short' format
239 if the config option is unset.
243 `--color` (i.e. without '=<when>') is the same as `--color=always`.
244 '<when>' can be one of `always`, `never`, or `auto`.
246 It can be changed by the `color.ui` and `color.diff`
247 configuration settings.
251 Turn off colored diff.
253 This can be used to override configuration settings.
255 It is the same as `--color=never`.
257 --color-moved[=<mode>]::
258 Moved lines of code are colored differently.
260 It can be changed by the `diff.colorMoved` configuration setting.
262 The <mode> defaults to 'no' if the option is not given
263 and to 'zebra' if the option with no mode is given.
264 The mode must be one of:
268 Moved lines are not highlighted.
270 Is a synonym for `zebra`. This may change to a more sensible mode
273 Any line that is added in one location and was removed
274 in another location will be colored with 'color.diff.newMoved'.
275 Similarly 'color.diff.oldMoved' will be used for removed lines
276 that are added somewhere else in the diff. This mode picks up any
277 moved line, but it is not very useful in a review to determine
278 if a block of code was moved without permutation.
280 Blocks of moved text of at least 20 alphanumeric characters
281 are detected greedily. The detected blocks are
282 painted using either the 'color.diff.{old,new}Moved' color.
283 Adjacent blocks cannot be told apart.
285 Blocks of moved text are detected as in 'blocks' mode. The blocks
286 are painted using either the 'color.diff.{old,new}Moved' color or
287 'color.diff.{old,new}MovedAlternative'. The change between
288 the two colors indicates that a new block was detected.
290 Similar to 'zebra', but additional dimming of uninteresting parts
291 of moved code is performed. The bordering lines of two adjacent
292 blocks are considered interesting, the rest is uninteresting.
293 `dimmed_zebra` is a deprecated synonym.
296 --color-moved-ws=<modes>::
297 This configures how white spaces are ignored when performing the
298 move detection for `--color-moved`.
300 It can be set by the `diff.colorMovedWS` configuration setting.
302 These modes can be given as a comma separated list:
305 ignore-space-at-eol::
306 Ignore changes in whitespace at EOL.
307 ignore-space-change::
308 Ignore changes in amount of whitespace. This ignores whitespace
309 at line end, and considers all other sequences of one or
310 more whitespace characters to be equivalent.
312 Ignore whitespace when comparing lines. This ignores differences
313 even if one line has whitespace where the other line has none.
314 allow-indentation-change::
315 Initially ignore any white spaces in the move detection, then
316 group the moved code blocks only into a block if the change in
317 whitespace is the same per line. This is incompatible with the
321 --word-diff[=<mode>]::
322 Show a word diff, using the <mode> to delimit changed words.
323 By default, words are delimited by whitespace; see
324 `--word-diff-regex` below. The <mode> defaults to 'plain', and
329 Highlight changed words using only colors. Implies `--color`.
331 Show words as `[-removed-]` and `{+added+}`. Makes no
332 attempts to escape the delimiters if they appear in the input,
333 so the output may be ambiguous.
335 Use a special line-based format intended for script
336 consumption. Added/removed/unchanged runs are printed in the
337 usual unified diff format, starting with a `+`/`-`/` `
338 character at the beginning of the line and extending to the
339 end of the line. Newlines in the input are represented by a
340 tilde `~` on a line of its own.
342 Disable word diff again.
345 Note that despite the name of the first mode, color is used to
346 highlight the changed parts in all modes if enabled.
348 --word-diff-regex=<regex>::
349 Use <regex> to decide what a word is, instead of considering
350 runs of non-whitespace to be a word. Also implies
351 `--word-diff` unless it was already enabled.
353 Every non-overlapping match of the
354 <regex> is considered a word. Anything between these matches is
355 considered whitespace and ignored(!) for the purposes of finding
356 differences. You may want to append `|[^[:space:]]` to your regular
357 expression to make sure that it matches all non-whitespace characters.
358 A match that contains a newline is silently truncated(!) at the
361 For example, `--word-diff-regex=.` will treat each character as a word
362 and, correspondingly, show differences character by character.
364 The regex can also be set via a diff driver or configuration option, see
365 linkgit:gitattributes[5] or linkgit:git-config[1]. Giving it explicitly
366 overrides any diff driver or configuration setting. Diff drivers
367 override configuration settings.
369 --color-words[=<regex>]::
370 Equivalent to `--word-diff=color` plus (if a regex was
371 specified) `--word-diff-regex=<regex>`.
372 endif::git-format-patch[]
375 Turn off rename detection, even when the configuration
376 file gives the default to do so.
378 ifndef::git-format-patch[]
380 Warn if changes introduce conflict markers or whitespace errors.
381 What are considered whitespace errors is controlled by `core.whitespace`
382 configuration. By default, trailing whitespaces (including
383 lines that consist solely of whitespaces) and a space character
384 that is immediately followed by a tab character inside the
385 initial indent of the line are considered whitespace errors.
386 Exits with non-zero status if problems are found. Not compatible
389 --ws-error-highlight=<kind>::
390 Highlight whitespace errors in the `context`, `old` or `new`
391 lines of the diff. Multiple values are separated by comma,
392 `none` resets previous values, `default` reset the list to
393 `new` and `all` is a shorthand for `old,new,context`. When
394 this option is not given, and the configuration variable
395 `diff.wsErrorHighlight` is not set, only whitespace errors in
396 `new` lines are highlighted. The whitespace errors are colored
397 with `color.diff.whitespace`.
399 endif::git-format-patch[]
402 Instead of the first handful of characters, show the full
403 pre- and post-image blob object names on the "index"
404 line when generating patch format output.
407 In addition to `--full-index`, output a binary diff that
408 can be applied with `git-apply`.
411 Instead of showing the full 40-byte hexadecimal object
412 name in diff-raw format output and diff-tree header
413 lines, show only a partial prefix. This is
414 independent of the `--full-index` option above, which controls
415 the diff-patch output format. Non default number of
416 digits can be specified with `--abbrev=<n>`.
419 --break-rewrites[=[<n>][/<m>]]::
420 Break complete rewrite changes into pairs of delete and
421 create. This serves two purposes:
423 It affects the way a change that amounts to a total rewrite of a file
424 not as a series of deletion and insertion mixed together with a very
425 few lines that happen to match textually as the context, but as a
426 single deletion of everything old followed by a single insertion of
427 everything new, and the number `m` controls this aspect of the -B
428 option (defaults to 60%). `-B/70%` specifies that less than 30% of the
429 original should remain in the result for Git to consider it a total
430 rewrite (i.e. otherwise the resulting patch will be a series of
431 deletion and insertion mixed together with context lines).
433 When used with -M, a totally-rewritten file is also considered as the
434 source of a rename (usually -M only considers a file that disappeared
435 as the source of a rename), and the number `n` controls this aspect of
436 the -B option (defaults to 50%). `-B20%` specifies that a change with
437 addition and deletion compared to 20% or more of the file's size are
438 eligible for being picked up as a possible source of a rename to
442 --find-renames[=<n>]::
447 If generating diffs, detect and report renames for each commit.
448 For following files across renames while traversing history, see
451 If `n` is specified, it is a threshold on the similarity
452 index (i.e. amount of addition/deletions compared to the
453 file's size). For example, `-M90%` means Git should consider a
454 delete/add pair to be a rename if more than 90% of the file
455 hasn't changed. Without a `%` sign, the number is to be read as
456 a fraction, with a decimal point before it. I.e., `-M5` becomes
457 0.5, and is thus the same as `-M50%`. Similarly, `-M05` is
458 the same as `-M5%`. To limit detection to exact renames, use
459 `-M100%`. The default similarity index is 50%.
462 --find-copies[=<n>]::
463 Detect copies as well as renames. See also `--find-copies-harder`.
464 If `n` is specified, it has the same meaning as for `-M<n>`.
466 --find-copies-harder::
467 For performance reasons, by default, `-C` option finds copies only
468 if the original file of the copy was modified in the same
469 changeset. This flag makes the command
470 inspect unmodified files as candidates for the source of
471 copy. This is a very expensive operation for large
472 projects, so use it with caution. Giving more than one
473 `-C` option has the same effect.
476 --irreversible-delete::
477 Omit the preimage for deletes, i.e. print only the header but not
478 the diff between the preimage and `/dev/null`. The resulting patch
479 is not meant to be applied with `patch` or `git apply`; this is
480 solely for people who want to just concentrate on reviewing the
481 text after the change. In addition, the output obviously lacks
482 enough information to apply such a patch in reverse, even manually,
483 hence the name of the option.
485 When used together with `-B`, omit also the preimage in the deletion part
486 of a delete/create pair.
489 The `-M` and `-C` options require O(n^2) processing time where n
490 is the number of potential rename/copy targets. This
491 option prevents rename/copy detection from running if
492 the number of rename/copy targets exceeds the specified
495 ifndef::git-format-patch[]
496 --diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]::
497 Select only files that are Added (`A`), Copied (`C`),
498 Deleted (`D`), Modified (`M`), Renamed (`R`), have their
499 type (i.e. regular file, symlink, submodule, ...) changed (`T`),
500 are Unmerged (`U`), are
501 Unknown (`X`), or have had their pairing Broken (`B`).
502 Any combination of the filter characters (including none) can be used.
503 When `*` (All-or-none) is added to the combination, all
504 paths are selected if there is any file that matches
505 other criteria in the comparison; if there is no file
506 that matches other criteria, nothing is selected.
508 Also, these upper-case letters can be downcased to exclude. E.g.
509 `--diff-filter=ad` excludes added and deleted paths.
511 Note that not all diffs can feature all types. For instance, diffs
512 from the index to the working tree can never have Added entries
513 (because the set of paths included in the diff is limited by what is in
514 the index). Similarly, copied and renamed entries cannot appear if
515 detection for those types is disabled.
518 Look for differences that change the number of occurrences of
519 the specified string (i.e. addition/deletion) in a file.
520 Intended for the scripter's use.
522 It is useful when you're looking for an exact block of code (like a
523 struct), and want to know the history of that block since it first
524 came into being: use the feature iteratively to feed the interesting
525 block in the preimage back into `-S`, and keep going until you get the
526 very first version of the block.
528 Binary files are searched as well.
531 Look for differences whose patch text contains added/removed
532 lines that match <regex>.
534 To illustrate the difference between `-S<regex> --pickaxe-regex` and
535 `-G<regex>`, consider a commit with the following diff in the same
539 + return !regexec(regexp, two->ptr, 1, ®match, 0);
541 - hit = !regexec(regexp, mf2.ptr, 1, ®match, 0);
544 While `git log -G"regexec\(regexp"` will show this commit, `git log
545 -S"regexec\(regexp" --pickaxe-regex` will not (because the number of
546 occurrences of that string did not change).
548 Unless `--text` is supplied patches of binary files without a textconv
549 filter will be ignored.
551 See the 'pickaxe' entry in linkgit:gitdiffcore[7] for more
554 --find-object=<object-id>::
555 Look for differences that change the number of occurrences of
556 the specified object. Similar to `-S`, just the argument is different
557 in that it doesn't search for a specific string but for a specific
560 The object can be a blob or a submodule commit. It implies the `-t` option in
561 `git-log` to also find trees.
564 When `-S` or `-G` finds a change, show all the changes in that
565 changeset, not just the files that contain the change
569 Treat the <string> given to `-S` as an extended POSIX regular
572 endif::git-format-patch[]
575 Control the order in which files appear in the output.
576 This overrides the `diff.orderFile` configuration variable
577 (see linkgit:git-config[1]). To cancel `diff.orderFile`,
580 The output order is determined by the order of glob patterns in
582 All files with pathnames that match the first pattern are output
583 first, all files with pathnames that match the second pattern (but not
584 the first) are output next, and so on.
585 All files with pathnames that do not match any pattern are output
586 last, as if there was an implicit match-all pattern at the end of the
588 If multiple pathnames have the same rank (they match the same pattern
589 but no earlier patterns), their output order relative to each other is
592 <orderfile> is parsed as follows:
595 - Blank lines are ignored, so they can be used as separators for
598 - Lines starting with a hash ("`#`") are ignored, so they can be used
599 for comments. Add a backslash ("`\`") to the beginning of the
600 pattern if it starts with a hash.
602 - Each other line contains a single pattern.
605 Patterns have the same syntax and semantics as patterns used for
606 fnmatch(3) without the FNM_PATHNAME flag, except a pathname also
607 matches a pattern if removing any number of the final pathname
608 components matches the pattern. For example, the pattern "`foo*bar`"
609 matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`".
611 ifndef::git-format-patch[]
613 Swap two inputs; that is, show differences from index or
614 on-disk file to tree contents.
616 --relative[=<path>]::
617 When run from a subdirectory of the project, it can be
618 told to exclude changes outside the directory and show
619 pathnames relative to it with this option. When you are
620 not in a subdirectory (e.g. in a bare repository), you
621 can name which subdirectory to make the output relative
622 to by giving a <path> as an argument.
623 endif::git-format-patch[]
627 Treat all files as text.
630 Ignore carriage-return at the end of line when doing a comparison.
632 --ignore-space-at-eol::
633 Ignore changes in whitespace at EOL.
636 --ignore-space-change::
637 Ignore changes in amount of whitespace. This ignores whitespace
638 at line end, and considers all other sequences of one or
639 more whitespace characters to be equivalent.
643 Ignore whitespace when comparing lines. This ignores
644 differences even if one line has whitespace where the other
647 --ignore-blank-lines::
648 Ignore changes whose lines are all blank.
650 --inter-hunk-context=<lines>::
651 Show the context between diff hunks, up to the specified number
652 of lines, thereby fusing hunks that are close to each other.
653 Defaults to `diff.interHunkContext` or 0 if the config option
658 Show whole surrounding functions of changes.
660 ifndef::git-format-patch[]
663 Make the program exit with codes similar to diff(1).
664 That is, it exits with 1 if there were differences and
665 0 means no differences.
668 Disable all output of the program. Implies `--exit-code`.
670 endif::git-format-patch[]
673 Allow an external diff helper to be executed. If you set an
674 external diff driver with linkgit:gitattributes[5], you need
675 to use this option with linkgit:git-log[1] and friends.
678 Disallow external diff drivers.
682 Allow (or disallow) external text conversion filters to be run
683 when comparing binary files. See linkgit:gitattributes[5] for
684 details. Because textconv filters are typically a one-way
685 conversion, the resulting diff is suitable for human
686 consumption, but cannot be applied. For this reason, textconv
687 filters are enabled by default only for linkgit:git-diff[1] and
688 linkgit:git-log[1], but not for linkgit:git-format-patch[1] or
689 diff plumbing commands.
691 --ignore-submodules[=<when>]::
692 Ignore changes to submodules in the diff generation. <when> can be
693 either "none", "untracked", "dirty" or "all", which is the default.
694 Using "none" will consider the submodule modified when it either contains
695 untracked or modified files or its HEAD differs from the commit recorded
696 in the superproject and can be used to override any settings of the
697 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
698 "untracked" is used submodules are not considered dirty when they only
699 contain untracked content (but they are still scanned for modified
700 content). Using "dirty" ignores all changes to the work tree of submodules,
701 only changes to the commits stored in the superproject are shown (this was
702 the behavior until 1.7.0). Using "all" hides all changes to submodules.
704 --src-prefix=<prefix>::
705 Show the given source prefix instead of "a/".
707 --dst-prefix=<prefix>::
708 Show the given destination prefix instead of "b/".
711 Do not show any source or destination prefix.
713 --line-prefix=<prefix>::
714 Prepend an additional prefix to every line of output.
716 --ita-invisible-in-index::
717 By default entries added by "git add -N" appear as an existing
718 empty file in "git diff" and a new file in "git diff --cached".
719 This option makes the entry appear as a new file in "git diff"
720 and non-existent in "git diff --cached". This option could be
721 reverted with `--ita-visible-in-index`. Both options are
722 experimental and could be removed in future.
724 For more detailed explanation on these common options, see also
725 linkgit:gitdiffcore[7].
projects / thirdparty / git.git / blob