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