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