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