diff-options: document default similarity index
[git/git.git] / Documentation / diff-options.txt
CommitLineData
c1a95fa6
SO
1// Please don't remove this comment as asciidoc behaves badly when
2// the first non-empty line is ifdef/ifndef. The symptom is that
3// without this comment the <git-diff-core> attribute conditionally
4// defined below ends up being defined unconditionally.
5// Last checked with asciidoc 7.0.2.
6
7ifndef::git-format-patch[]
8ifndef::git-diff[]
272bd3cf 9ifndef::git-log[]
c1a95fa6 10:git-diff-core: 1
272bd3cf 11endif::git-log[]
c1a95fa6
SO
12endif::git-diff[]
13endif::git-format-patch[]
14
15ifdef::git-format-patch[]
16-p::
2cfa8330 17--no-stat::
02bc5b03 18 Generate plain patches without any diffstats.
c1a95fa6
SO
19endif::git-format-patch[]
20
21ifndef::git-format-patch[]
dda2d79a 22-p::
a9e67c8c 23-u::
1c9eecff 24--patch::
c1a95fa6
SO
25 Generate patch (see section on generating patches).
26 {git-diff? This is the default.}
27endif::git-format-patch[]
dda2d79a 28
4eb99473 29-U<n>::
4eb99473
RR
30--unified=<n>::
31 Generate diffs with <n> lines of context instead of
02bc5b03
BG
32 the usual three.
33ifndef::git-format-patch[]
dce5ef14 34 Implies `-p`.
02bc5b03 35endif::git-format-patch[]
4eb99473 36
d4cb003f 37ifndef::git-format-patch[]
b5376648
JH
38--raw::
39 Generate the raw format.
c1a95fa6 40 {git-diff-core? This is the default.}
d4cb003f 41endif::git-format-patch[]
b5376648 42
02bc5b03 43ifndef::git-format-patch[]
5c91da25 44--patch-with-raw::
dce5ef14 45 Synonym for `-p --raw`.
02bc5b03 46endif::git-format-patch[]
5c91da25 47
81b568c8
JH
48--minimal::
49 Spend extra time to make sure the smallest possible
50 diff is produced.
51
ec74042d 52--patience::
34292bdd
JS
53 Generate a diff using the "patience diff" algorithm.
54
d909e076
TR
55--histogram::
56 Generate a diff using the "histogram diff" algorithm.
57
808e1db2 58--stat[=<width>[,<name-width>[,<count>]]]::
1b058bc3 59 Generate a diffstat. By default, as much space as necessary
df44483a
ZJS
60 will be used for the filename part, and the rest for the graph
61 part. Maximum width defaults to terminal width, or 80 columns
8d8136c3 62 if not connected to a terminal, and can be overridden by
df44483a
ZJS
63 `<width>`. The width of the filename part can be limited by
64 giving another width `<name-width>` after a comma. The width
65 of the graph part can be limited by using
66 `--stat-graph-width=<width>` (affects all commands generating
67 a stat graph) or by setting `diff.statGraphWidth=<width>`
68 (does not affect `git format-patch`).
808e1db2 69 By giving a third parameter `<count>`, you can limit the
1b058bc3
ZJS
70 output to the first `<count>` lines, followed by `...` if
71 there are more.
86e1ce96
MG
72+
73These parameters can also be set individually with `--stat-width=<width>`,
74`--stat-name-width=<name-width>` and `--stat-count=<count>`.
d75f7952 75
74e2abe5 76--numstat::
6cf378f0 77 Similar to `--stat`, but shows number of added and
74e2abe5 78 deleted lines in decimal notation and pathname without
2f89543e
JH
79 abbreviation, to make it more machine friendly. For
80 binary files, outputs two `-` instead of saying
81 `0 0`.
74e2abe5 82
ebd124c6 83--shortstat::
dce5ef14 84 Output only the last line of the `--stat` format containing total
ebd124c6
NP
85 number of modified files, as well as number of added and deleted
86 lines.
87
333f3fb0
JH
88--dirstat[=<param1,param2,...>]::
89 Output the distribution of relative amount of changes for each
90 sub-directory. The behavior of `--dirstat` can be customized by
91 passing it a comma separated list of parameters.
2d174951
JH
92 The defaults are controlled by the `diff.dirstat` configuration
93 variable (see linkgit:git-config[1]).
333f3fb0 94 The following parameters are available:
204f01a2 95+
333f3fb0
JH
96--
97`changes`;;
98 Compute the dirstat numbers by counting the lines that have been
99 removed from the source, or added to the destination. This ignores
100 the amount of pure code movements within a file. In other words,
101 rearranging lines in a file is not counted as much as other changes.
102 This is the default behavior when no parameter is given.
1c57a627
JH
103`lines`;;
104 Compute the dirstat numbers by doing the regular line-based diff
105 analysis, and summing the removed/added line counts. (For binary
106 files, count 64-byte chunks instead, since binary files have no
107 natural concept of lines). This is a more expensive `--dirstat`
108 behavior than the `changes` behavior, but it does count rearranged
109 lines within a file as much as other changes. The resulting output
110 is consistent with what you get from the other `--*stat` options.
333f3fb0
JH
111`files`;;
112 Compute the dirstat numbers by counting the number of files changed.
113 Each changed file counts equally in the dirstat analysis. This is
114 the computationally cheapest `--dirstat` behavior, since it does
115 not have to look at the file contents at all.
116`cumulative`;;
117 Count changes in a child directory for the parent directory as well.
118 Note that when using `cumulative`, the sum of the percentages
119 reported may exceed 100%. The default (non-cumulative) behavior can
120 be specified with the `noncumulative` parameter.
121<limit>;;
122 An integer parameter specifies a cut-off percent (3% by default).
123 Directories contributing less than this percentage of the changes
124 are not shown in the output.
125--
126+
127Example: The following will count changed files, while ignoring
128directories with less than 10% of the total amount of changed files,
129and accumulating child directory counts in the parent directories:
130`--dirstat=files,10,cumulative`.
fd33777b 131
4bbd261b
SE
132--summary::
133 Output a condensed summary of extended header information
134 such as creations, renames and mode changes.
135
02bc5b03 136ifndef::git-format-patch[]
29353273 137--patch-with-stat::
dce5ef14 138 Synonym for `-p --stat`.
02bc5b03 139endif::git-format-patch[]
29353273 140
d4cb003f 141ifndef::git-format-patch[]
64485b4a 142
dda2d79a 143-z::
5c931c8d
BG
144ifdef::git-log[]
145 Separate the commits with NULs instead of with new newlines.
146+
147Also, when `--raw` or `--numstat` has been given, do not munge
148pathnames and use NULs as output field terminators.
149endif::git-log[]
64485b4a 150ifndef::git-log[]
03aa87ed
CB
151 When `--raw`, `--numstat`, `--name-only` or `--name-status` has been
152 given, do not munge pathnames and use NULs as output field terminators.
5c931c8d 153endif::git-log[]
64485b4a
BG
154+
155Without this option, each pathname output will have TAB, LF, double quotes,
156and backslash characters replaced with `\t`, `\n`, `\"`, and `\\`,
157respectively, and the pathname will be enclosed in double quotes if
158any of those replacements occurred.
dda2d79a
JH
159
160--name-only::
161 Show only names of changed files.
162
946f5f7c 163--name-status::
a6f47b2b
MV
164 Show only names and status of changed files. See the description
165 of the `--diff-filter` option on what the status letters mean.
dda2d79a 166
752c0c24 167--submodule[=<format>]::
3fe271e9
TH
168 Specify how differences in submodules are shown. When `--submodule`
169 or `--submodule=log` is given, the 'log' format is used. This format lists
170 the commits in the range like linkgit:git-submodule[1] `summary` does.
171 Omitting the `--submodule` option or specifying `--submodule=short`,
172 uses the 'short' format. This format just shows the names of the commits
c47ef57c
RR
173 at the beginning and end of the range. Can be tweaked via the
174 `diff.submodule` configuration variable.
752c0c24 175
73e9da01 176--color[=<when>]::
b5376648 177 Show colored diff.
6999c540
MG
178 The value must be `always` (the default for `<when>`), `never`, or `auto`.
179 The default value is `never`.
180ifdef::git-diff[]
181 It can be changed by the `color.ui` and `color.diff`
182 configuration settings.
183endif::git-diff[]
b5376648
JH
184
185--no-color::
6999c540
MG
186 Turn off colored diff.
187ifdef::git-diff[]
188 This can be used to override configuration settings.
189endif::git-diff[]
190 It is the same as `--color=never`.
b5376648 191
882749a0
TR
192--word-diff[=<mode>]::
193 Show a word diff, using the <mode> to delimit changed words.
194 By default, words are delimited by whitespace; see
195 `--word-diff-regex` below. The <mode> defaults to 'plain', and
196 must be one of:
197+
198--
199color::
200 Highlight changed words using only colors. Implies `--color`.
201plain::
202 Show words as `[-removed-]` and `{+added+}`. Makes no
203 attempts to escape the delimiters if they appear in the input,
204 so the output may be ambiguous.
205porcelain::
206 Use a special line-based format intended for script
207 consumption. Added/removed/unchanged runs are printed in the
208 usual unified diff format, starting with a `+`/`-`/` `
209 character at the beginning of the line and extending to the
210 end of the line. Newlines in the input are represented by a
211 tilde `~` on a line of its own.
212none::
213 Disable word diff again.
214--
215+
216Note that despite the name of the first mode, color is used to
217highlight the changed parts in all modes if enabled.
218
219--word-diff-regex=<regex>::
220 Use <regex> to decide what a word is, instead of considering
221 runs of non-whitespace to be a word. Also implies
222 `--word-diff` unless it was already enabled.
2b6a5417 223+
882749a0 224Every non-overlapping match of the
c4b252c3
TR
225<regex> is considered a word. Anything between these matches is
226considered whitespace and ignored(!) for the purposes of finding
227differences. You may want to append `|[^[:space:]]` to your regular
228expression to make sure that it matches all non-whitespace characters.
229A match that contains a newline is silently truncated(!) at the
230newline.
80c49c3d 231+
98a4d87b
BSSJ
232The regex can also be set via a diff driver or configuration option, see
233linkgit:gitattributes[1] or linkgit:git-config[1]. Giving it explicitly
234overrides any diff driver or configuration setting. Diff drivers
235override configuration settings.
882749a0
TR
236
237--color-words[=<regex>]::
238 Equivalent to `--word-diff=color` plus (if a regex was
239 specified) `--word-diff-regex=<regex>`.
d4cb003f 240endif::git-format-patch[]
f59a59e2 241
b5376648
JH
242--no-renames::
243 Turn off rename detection, even when the configuration
244 file gives the default to do so.
245
02bc5b03 246ifndef::git-format-patch[]
16507fcf 247--check::
4f830390
CK
248 Warn if changes introduce whitespace errors. What are
249 considered whitespace errors is controlled by `core.whitespace`
250 configuration. By default, trailing whitespaces (including
251 lines that solely consist of whitespaces) and a space character
252 that is immediately followed by a tab character inside the
253 initial indent of the line are considered whitespace errors.
254 Exits with non-zero status if problems are found. Not compatible
255 with --exit-code.
02bc5b03 256endif::git-format-patch[]
16507fcf 257
80b1e511 258--full-index::
6457e58c
JM
259 Instead of the first handful of characters, show the full
260 pre- and post-image blob object names on the "index"
261 line when generating patch format output.
b5376648
JH
262
263--binary::
dce5ef14
BG
264 In addition to `--full-index`, output a binary diff that
265 can be applied with `git-apply`.
80b1e511 266
913419fc 267--abbrev[=<n>]::
47dd0d59
JH
268 Instead of showing the full 40-byte hexadecimal object
269 name in diff-raw format output and diff-tree header
323b9db8 270 lines, show only a partial prefix. This is
dce5ef14 271 independent of the `--full-index` option above, which controls
913419fc 272 the diff-patch output format. Non default number of
dce5ef14 273 digits can be specified with `--abbrev=<n>`.
47dd0d59 274
cf958afd 275-B[<n>][/<m>]::
37ab5156 276--break-rewrites[=[<n>][/<m>]]::
cf958afd
MM
277 Break complete rewrite changes into pairs of delete and
278 create. This serves two purposes:
279+
280It affects the way a change that amounts to a total rewrite of a file
281not as a series of deletion and insertion mixed together with a very
282few lines that happen to match textually as the context, but as a
283single deletion of everything old followed by a single insertion of
284everything new, and the number `m` controls this aspect of the -B
285option (defaults to 60%). `-B/70%` specifies that less than 30% of the
286original should remain in the result for git to consider it a total
287rewrite (i.e. otherwise the resulting patch will be a series of
288deletion and insertion mixed together with context lines).
289+
290When used with -M, a totally-rewritten file is also considered as the
291source of a rename (usually -M only considers a file that disappeared
292as the source of a rename), and the number `n` controls this aspect of
293the -B option (defaults to 50%). `-B20%` specifies that a change with
294addition and deletion compared to 20% or more of the file's size are
295eligible for being picked up as a possible source of a rename to
296another file.
297
298-M[<n>]::
f611ddc7 299--find-renames[=<n>]::
7ffad250 300ifndef::git-log[]
dda2d79a 301 Detect renames.
7ffad250
JK
302endif::git-log[]
303ifdef::git-log[]
304 If generating diffs, detect and report renames for each commit.
305 For following files across renames while traversing history, see
306 `--follow`.
307endif::git-log[]
4c007ae8 308 If `n` is specified, it is a threshold on the similarity
cf958afd
MM
309 index (i.e. amount of addition/deletions compared to the
310 file's size). For example, `-M90%` means git should consider a
311 delete/add pair to be a rename if more than 90% of the file
31d66aa4
SC
312 hasn't changed. Without a `%` sign, the number is to be read as
313 a fraction, with a decimal point before it. I.e., `-M5` becomes
314 0.5, and is thus the same as `-M50%`. Similarly, `-M05` is
315 the same as `-M5%`. To limit detection to exact renames, use
8240943b 316 `-M100%`. The default similarity index is 50%.
dda2d79a 317
cf958afd 318-C[<n>]::
f611ddc7 319--find-copies[=<n>]::
ca6c0970 320 Detect copies as well as renames. See also `--find-copies-harder`.
cf958afd 321 If `n` is specified, it has the same meaning as for `-M<n>`.
dda2d79a
JH
322
323--find-copies-harder::
ca6c0970 324 For performance reasons, by default, `-C` option finds copies only
a6080a0a 325 if the original file of the copy was modified in the same
f73ae1fc 326 changeset. This flag makes the command
dda2d79a
JH
327 inspect unmodified files as candidates for the source of
328 copy. This is a very expensive operation for large
ca6c0970
JS
329 projects, so use it with caution. Giving more than one
330 `-C` option has the same effect.
dda2d79a 331
467ddc14
JH
332-D::
333--irreversible-delete::
334 Omit the preimage for deletes, i.e. print only the header but not
335 the diff between the preimage and `/dev/null`. The resulting patch
336 is not meant to be applied with `patch` nor `git apply`; this is
337 solely for people who want to just concentrate on reviewing the
338 text after the change. In addition, the output obviously lack
339 enough information to apply such a patch in reverse, even manually,
340 hence the name of the option.
341+
342When used together with `-B`, omit also the preimage in the deletion part
343of a delete/create pair.
344
8082d8d3 345-l<num>::
dce5ef14 346 The `-M` and `-C` options require O(n^2) processing time where n
f73ae1fc 347 is the number of potential rename/copy targets. This
8082d8d3 348 option prevents rename/copy detection from running if
f73ae1fc 349 the number of rename/copy targets exceeds the specified
8082d8d3
JH
350 number.
351
d4cb003f 352ifndef::git-format-patch[]
f1037448
YD
353--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]::
354 Select only files that are Added (`A`), Copied (`C`),
355 Deleted (`D`), Modified (`M`), Renamed (`R`), have their
356 type (i.e. regular file, symlink, submodule, ...) changed (`T`),
357 are Unmerged (`U`), are
358 Unknown (`X`), or have had their pairing Broken (`B`).
359 Any combination of the filter characters (including none) can be used.
360 When `*` (All-or-none) is added to the combination, all
361 paths are selected if there is any file that matches
362 other criteria in the comparison; if there is no file
363 that matches other criteria, nothing is selected.
364
dda2d79a 365-S<string>::
821d56aa
JK
366 Look for differences that introduce or remove an instance of
367 <string>. Note that this is different than the string simply
368 appearing in diff output; see the 'pickaxe' entry in
369 linkgit:gitdiffcore[7] for more details.
dda2d79a 370
f506b8e8
JH
371-G<regex>::
372 Look for differences whose added or removed line matches
373 the given <regex>.
374
dda2d79a 375--pickaxe-all::
f506b8e8 376 When `-S` or `-G` finds a change, show all the changes in that
f73ae1fc 377 changeset, not just the files that contain the change
dda2d79a
JH
378 in <string>.
379
d01d8c67
PB
380--pickaxe-regex::
381 Make the <string> not a plain string but an extended POSIX
382 regex to match.
d4cb003f 383endif::git-format-patch[]
d01d8c67 384
dda2d79a
JH
385-O<orderfile>::
386 Output the patch in the order specified in the
387 <orderfile>, which has one shell glob pattern per line.
388
d4cb003f 389ifndef::git-format-patch[]
dda2d79a 390-R::
5f3aa197 391 Swap two inputs; that is, show differences from index or
dda2d79a
JH
392 on-disk file to tree contents.
393
c0cb4a06 394--relative[=<path>]::
cd676a51
JH
395 When run from a subdirectory of the project, it can be
396 told to exclude changes outside the directory and show
c0cb4a06
JH
397 pathnames relative to it with this option. When you are
398 not in a subdirectory (e.g. in a bare repository), you
399 can name which subdirectory to make the output relative
400 to by giving a <path> as an argument.
d4cb003f 401endif::git-format-patch[]
cd676a51 402
a9e67c8c 403-a::
d507bb15
SF
404--text::
405 Treat all files as text.
406
a44a0c99 407--ignore-space-at-eol::
0ac7903e 408 Ignore changes in whitespace at EOL.
a44a0c99 409
a9e67c8c 410-b::
8ebe185b 411--ignore-space-change::
0ac7903e
WC
412 Ignore changes in amount of whitespace. This ignores whitespace
413 at line end, and considers all other sequences of one or
414 more whitespace characters to be equivalent.
8ebe185b 415
a9e67c8c 416-w::
8ebe185b 417--ignore-all-space::
0ac7903e
WC
418 Ignore whitespace when comparing lines. This ignores
419 differences even if one line has whitespace where the other
8ebe185b
JN
420 line has none.
421
6d0e674a
RS
422--inter-hunk-context=<lines>::
423 Show the context between diff hunks, up to the specified number
424 of lines, thereby fusing hunks that are close to each other.
425
14937c2c
RS
426-W::
427--function-context::
428 Show whole surrounding functions of changes.
429
d4cb003f 430ifndef::git-format-patch[]
939ca96b 431ifndef::git-log[]
41bbf9d5
AR
432--exit-code::
433 Make the program exit with codes similar to diff(1).
434 That is, it exits with 1 if there were differences and
435 0 means no differences.
436
2a18c266 437--quiet::
dce5ef14 438 Disable all output of the program. Implies `--exit-code`.
939ca96b 439endif::git-log[]
d4cb003f 440endif::git-format-patch[]
2a18c266 441
72909bef
JS
442--ext-diff::
443 Allow an external diff helper to be executed. If you set an
5162e697
DM
444 external diff driver with linkgit:gitattributes[5], you need
445 to use this option with linkgit:git-log[1] and friends.
72909bef
JS
446
447--no-ext-diff::
448 Disallow external diff drivers.
449
d28790dc
JK
450--textconv::
451--no-textconv::
452 Allow (or disallow) external text conversion filters to be run
453 when comparing binary files. See linkgit:gitattributes[5] for
454 details. Because textconv filters are typically a one-way
455 conversion, the resulting diff is suitable for human
456 consumption, but cannot be applied. For this reason, textconv
457 filters are enabled by default only for linkgit:git-diff[1] and
458 linkgit:git-log[1], but not for linkgit:git-format-patch[1] or
459 diff plumbing commands.
460
dd44d419
JL
461--ignore-submodules[=<when>]::
462 Ignore changes to submodules in the diff generation. <when> can be
aee9c7d6
JL
463 either "none", "untracked", "dirty" or "all", which is the default
464 Using "none" will consider the submodule modified when it either contains
465 untracked or modified files or its HEAD differs from the commit recorded
466 in the superproject and can be used to override any settings of the
302ad7a9 467 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
dd44d419
JL
468 "untracked" is used submodules are not considered dirty when they only
469 contain untracked content (but they are still scanned for modified
470 content). Using "dirty" ignores all changes to the work tree of submodules,
471 only changes to the commits stored in the superproject are shown (this was
472 the behavior until 1.7.0). Using "all" hides all changes to submodules.
50fd9bd8 473
eab9a40b
JS
474--src-prefix=<prefix>::
475 Show the given source prefix instead of "a/".
476
477--dst-prefix=<prefix>::
478 Show the given destination prefix instead of "b/".
479
480--no-prefix::
481 Do not show any source or destination prefix.
482
8db9307c 483For more detailed explanation on these common options, see also
6998e4db 484linkgit:gitdiffcore[7].