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