GIT-VERSION-GEN: restrict tags used
[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::
c1a95fa6
SO
24 Generate patch (see section on generating patches).
25 {git-diff? This is the default.}
26endif::git-format-patch[]
dda2d79a 27
4eb99473 28-U<n>::
4eb99473
RR
29--unified=<n>::
30 Generate diffs with <n> lines of context instead of
02bc5b03
BG
31 the usual three.
32ifndef::git-format-patch[]
dce5ef14 33 Implies `-p`.
02bc5b03 34endif::git-format-patch[]
4eb99473 35
d4cb003f 36ifndef::git-format-patch[]
b5376648
JH
37--raw::
38 Generate the raw format.
c1a95fa6 39 {git-diff-core? This is the default.}
d4cb003f 40endif::git-format-patch[]
b5376648 41
02bc5b03 42ifndef::git-format-patch[]
5c91da25 43--patch-with-raw::
dce5ef14 44 Synonym for `-p --raw`.
02bc5b03 45endif::git-format-patch[]
5c91da25 46
ec74042d 47--patience::
34292bdd
JS
48 Generate a diff using the "patience diff" algorithm.
49
5c5b2ea9
LT
50--stat[=width[,name-width]]::
51 Generate a diffstat. You can override the default
dce5ef14 52 output width for 80-column terminal by `--stat=width`.
5c5b2ea9
LT
53 The width of the filename part can be controlled by
54 giving another width to it separated by a comma.
d75f7952 55
74e2abe5 56--numstat::
dce5ef14 57 Similar to `\--stat`, but shows number of added and
74e2abe5 58 deleted lines in decimal notation and pathname without
2f89543e
JH
59 abbreviation, to make it more machine friendly. For
60 binary files, outputs two `-` instead of saying
61 `0 0`.
74e2abe5 62
ebd124c6 63--shortstat::
dce5ef14 64 Output only the last line of the `--stat` format containing total
ebd124c6
NP
65 number of modified files, as well as number of added and deleted
66 lines.
67
37152d83 68--dirstat[=limit]::
62e00b0a
HO
69 Output the distribution of relative amount of changes (number of lines added or
70 removed) for each sub-directory. Directories with changes below
71 a cut-off percent (3% by default) are not shown. The cut-off percent
dce5ef14
BG
72 can be set with `--dirstat=limit`. Changes in a child directory is not
73 counted for the parent directory, unless `--cumulative` is used.
37152d83 74
fd33777b 75--dirstat-by-file[=limit]::
dce5ef14 76 Same as `--dirstat`, but counts changed files instead of lines.
fd33777b 77
4bbd261b
SE
78--summary::
79 Output a condensed summary of extended header information
80 such as creations, renames and mode changes.
81
02bc5b03 82ifndef::git-format-patch[]
29353273 83--patch-with-stat::
dce5ef14 84 Synonym for `-p --stat`.
02bc5b03 85endif::git-format-patch[]
29353273 86
d4cb003f 87ifndef::git-format-patch[]
64485b4a 88
dda2d79a 89-z::
5c931c8d
BG
90ifdef::git-log[]
91 Separate the commits with NULs instead of with new newlines.
92+
93Also, when `--raw` or `--numstat` has been given, do not munge
94pathnames and use NULs as output field terminators.
95endif::git-log[]
64485b4a 96ifndef::git-log[]
03aa87ed
CB
97 When `--raw`, `--numstat`, `--name-only` or `--name-status` has been
98 given, do not munge pathnames and use NULs as output field terminators.
5c931c8d 99endif::git-log[]
64485b4a
BG
100+
101Without this option, each pathname output will have TAB, LF, double quotes,
102and backslash characters replaced with `\t`, `\n`, `\"`, and `\\`,
103respectively, and the pathname will be enclosed in double quotes if
104any of those replacements occurred.
dda2d79a
JH
105
106--name-only::
107 Show only names of changed files.
108
946f5f7c 109--name-status::
a6f47b2b
MV
110 Show only names and status of changed files. See the description
111 of the `--diff-filter` option on what the status letters mean.
dda2d79a 112
752c0c24
JS
113--submodule[=<format>]::
114 Chose the output format for submodule differences. <format> can be one of
115 'short' and 'log'. 'short' just shows pairs of commit names, this format
116 is used when this option is not given. 'log' is the default value for this
117 option and lists the commits in that commit range like the 'summary'
118 option of linkgit:git-submodule[1] does.
119
73e9da01 120--color[=<when>]::
b5376648 121 Show colored diff.
73e9da01 122 The value must be always (the default), never, or auto.
b5376648
JH
123
124--no-color::
125 Turn off colored diff, even when the configuration file
126 gives the default to color output.
73e9da01 127 Same as `--color=never`.
b5376648 128
c4b252c3
TR
129--color-words[=<regex>]::
130 Show colored word diff, i.e., color words which have changed.
131 By default, words are separated by whitespace.
2b6a5417 132+
c4b252c3
TR
133When a <regex> is specified, every non-overlapping match of the
134<regex> is considered a word. Anything between these matches is
135considered whitespace and ignored(!) for the purposes of finding
136differences. You may want to append `|[^[:space:]]` to your regular
137expression to make sure that it matches all non-whitespace characters.
138A match that contains a newline is silently truncated(!) at the
139newline.
80c49c3d 140+
98a4d87b
BSSJ
141The regex can also be set via a diff driver or configuration option, see
142linkgit:gitattributes[1] or linkgit:git-config[1]. Giving it explicitly
143overrides any diff driver or configuration setting. Diff drivers
144override configuration settings.
d4cb003f 145endif::git-format-patch[]
f59a59e2 146
b5376648
JH
147--no-renames::
148 Turn off rename detection, even when the configuration
149 file gives the default to do so.
150
02bc5b03 151ifndef::git-format-patch[]
16507fcf
BL
152--check::
153 Warn if changes introduce trailing whitespace
62c64895
WC
154 or an indent that uses a space before a tab. Exits with
155 non-zero status if problems are found. Not compatible with
156 --exit-code.
02bc5b03 157endif::git-format-patch[]
16507fcf 158
80b1e511 159--full-index::
6457e58c
JM
160 Instead of the first handful of characters, show the full
161 pre- and post-image blob object names on the "index"
162 line when generating patch format output.
b5376648
JH
163
164--binary::
dce5ef14
BG
165 In addition to `--full-index`, output a binary diff that
166 can be applied with `git-apply`.
80b1e511 167
913419fc 168--abbrev[=<n>]::
47dd0d59
JH
169 Instead of showing the full 40-byte hexadecimal object
170 name in diff-raw format output and diff-tree header
323b9db8 171 lines, show only a partial prefix. This is
dce5ef14 172 independent of the `--full-index` option above, which controls
913419fc 173 the diff-patch output format. Non default number of
dce5ef14 174 digits can be specified with `--abbrev=<n>`.
47dd0d59 175
dda2d79a
JH
176-B::
177 Break complete rewrite changes into pairs of delete and create.
178
179-M::
180 Detect renames.
181
182-C::
ca6c0970 183 Detect copies as well as renames. See also `--find-copies-harder`.
dda2d79a 184
d4cb003f 185ifndef::git-format-patch[]
147cf317
JL
186--diff-filter=[ACDMRTUXB*]::
187 Select only files that are Added (`A`), Copied (`C`),
188 Deleted (`D`), Modified (`M`), Renamed (`R`), have their
f07c3c53
JH
189 type (i.e. regular file, symlink, submodule, ...) changed (`T`),
190 are Unmerged (`U`), are
147cf317
JL
191 Unknown (`X`), or have had their pairing Broken (`B`).
192 Any combination of the filter characters may be used.
193 When `*` (All-or-none) is added to the combination, all
194 paths are selected if there is any file that matches
195 other criteria in the comparison; if there is no file
196 that matches other criteria, nothing is selected.
d4cb003f 197endif::git-format-patch[]
147cf317 198
dda2d79a 199--find-copies-harder::
ca6c0970 200 For performance reasons, by default, `-C` option finds copies only
a6080a0a 201 if the original file of the copy was modified in the same
f73ae1fc 202 changeset. This flag makes the command
dda2d79a
JH
203 inspect unmodified files as candidates for the source of
204 copy. This is a very expensive operation for large
ca6c0970
JS
205 projects, so use it with caution. Giving more than one
206 `-C` option has the same effect.
dda2d79a 207
8082d8d3 208-l<num>::
dce5ef14 209 The `-M` and `-C` options require O(n^2) processing time where n
f73ae1fc 210 is the number of potential rename/copy targets. This
8082d8d3 211 option prevents rename/copy detection from running if
f73ae1fc 212 the number of rename/copy targets exceeds the specified
8082d8d3
JH
213 number.
214
d4cb003f 215ifndef::git-format-patch[]
dda2d79a 216-S<string>::
821d56aa
JK
217 Look for differences that introduce or remove an instance of
218 <string>. Note that this is different than the string simply
219 appearing in diff output; see the 'pickaxe' entry in
220 linkgit:gitdiffcore[7] for more details.
dda2d79a
JH
221
222--pickaxe-all::
dce5ef14 223 When `-S` finds a change, show all the changes in that
f73ae1fc 224 changeset, not just the files that contain the change
dda2d79a
JH
225 in <string>.
226
d01d8c67
PB
227--pickaxe-regex::
228 Make the <string> not a plain string but an extended POSIX
229 regex to match.
d4cb003f 230endif::git-format-patch[]
d01d8c67 231
dda2d79a
JH
232-O<orderfile>::
233 Output the patch in the order specified in the
234 <orderfile>, which has one shell glob pattern per line.
235
d4cb003f 236ifndef::git-format-patch[]
dda2d79a 237-R::
5f3aa197 238 Swap two inputs; that is, show differences from index or
dda2d79a
JH
239 on-disk file to tree contents.
240
c0cb4a06 241--relative[=<path>]::
cd676a51
JH
242 When run from a subdirectory of the project, it can be
243 told to exclude changes outside the directory and show
c0cb4a06
JH
244 pathnames relative to it with this option. When you are
245 not in a subdirectory (e.g. in a bare repository), you
246 can name which subdirectory to make the output relative
247 to by giving a <path> as an argument.
d4cb003f 248endif::git-format-patch[]
cd676a51 249
a9e67c8c 250-a::
d507bb15
SF
251--text::
252 Treat all files as text.
253
a44a0c99 254--ignore-space-at-eol::
0ac7903e 255 Ignore changes in whitespace at EOL.
a44a0c99 256
a9e67c8c 257-b::
8ebe185b 258--ignore-space-change::
0ac7903e
WC
259 Ignore changes in amount of whitespace. This ignores whitespace
260 at line end, and considers all other sequences of one or
261 more whitespace characters to be equivalent.
8ebe185b 262
a9e67c8c 263-w::
8ebe185b 264--ignore-all-space::
0ac7903e
WC
265 Ignore whitespace when comparing lines. This ignores
266 differences even if one line has whitespace where the other
8ebe185b
JN
267 line has none.
268
6d0e674a
RS
269--inter-hunk-context=<lines>::
270 Show the context between diff hunks, up to the specified number
271 of lines, thereby fusing hunks that are close to each other.
272
d4cb003f 273ifndef::git-format-patch[]
41bbf9d5
AR
274--exit-code::
275 Make the program exit with codes similar to diff(1).
276 That is, it exits with 1 if there were differences and
277 0 means no differences.
278
2a18c266 279--quiet::
dce5ef14 280 Disable all output of the program. Implies `--exit-code`.
d4cb003f 281endif::git-format-patch[]
2a18c266 282
72909bef
JS
283--ext-diff::
284 Allow an external diff helper to be executed. If you set an
5162e697
DM
285 external diff driver with linkgit:gitattributes[5], you need
286 to use this option with linkgit:git-log[1] and friends.
72909bef
JS
287
288--no-ext-diff::
289 Disallow external diff drivers.
290
50fd9bd8
JS
291--ignore-submodules::
292 Ignore changes to submodules in the diff generation.
293
eab9a40b
JS
294--src-prefix=<prefix>::
295 Show the given source prefix instead of "a/".
296
297--dst-prefix=<prefix>::
298 Show the given destination prefix instead of "b/".
299
300--no-prefix::
301 Do not show any source or destination prefix.
302
8db9307c 303For more detailed explanation on these common options, see also
6998e4db 304linkgit:gitdiffcore[7].