Merge branch 'jc/fix-tree-walk' (early part)
[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[]
dda2d79a 88-z::
dce5ef14 89 NUL-line termination on output. This affects the `--raw`
654a7ccc 90 output field terminator. Also output from commands such
dce5ef14 91 as `git-log` will be delimited with NUL between commits.
dda2d79a
JH
92
93--name-only::
94 Show only names of changed files.
95
946f5f7c 96--name-status::
a6f47b2b
MV
97 Show only names and status of changed files. See the description
98 of the `--diff-filter` option on what the status letters mean.
dda2d79a 99
752c0c24
JS
100--submodule[=<format>]::
101 Chose the output format for submodule differences. <format> can be one of
102 'short' and 'log'. 'short' just shows pairs of commit names, this format
103 is used when this option is not given. 'log' is the default value for this
104 option and lists the commits in that commit range like the 'summary'
105 option of linkgit:git-submodule[1] does.
106
b5376648
JH
107--color::
108 Show colored diff.
109
110--no-color::
111 Turn off colored diff, even when the configuration file
112 gives the default to color output.
113
c4b252c3
TR
114--color-words[=<regex>]::
115 Show colored word diff, i.e., color words which have changed.
116 By default, words are separated by whitespace.
2b6a5417 117+
c4b252c3
TR
118When a <regex> is specified, every non-overlapping match of the
119<regex> is considered a word. Anything between these matches is
120considered whitespace and ignored(!) for the purposes of finding
121differences. You may want to append `|[^[:space:]]` to your regular
122expression to make sure that it matches all non-whitespace characters.
123A match that contains a newline is silently truncated(!) at the
124newline.
80c49c3d 125+
98a4d87b
BSSJ
126The regex can also be set via a diff driver or configuration option, see
127linkgit:gitattributes[1] or linkgit:git-config[1]. Giving it explicitly
128overrides any diff driver or configuration setting. Diff drivers
129override configuration settings.
d4cb003f 130endif::git-format-patch[]
f59a59e2 131
b5376648
JH
132--no-renames::
133 Turn off rename detection, even when the configuration
134 file gives the default to do so.
135
02bc5b03 136ifndef::git-format-patch[]
16507fcf
BL
137--check::
138 Warn if changes introduce trailing whitespace
62c64895
WC
139 or an indent that uses a space before a tab. Exits with
140 non-zero status if problems are found. Not compatible with
141 --exit-code.
02bc5b03 142endif::git-format-patch[]
16507fcf 143
80b1e511 144--full-index::
6457e58c
JM
145 Instead of the first handful of characters, show the full
146 pre- and post-image blob object names on the "index"
147 line when generating patch format output.
b5376648
JH
148
149--binary::
dce5ef14
BG
150 In addition to `--full-index`, output a binary diff that
151 can be applied with `git-apply`.
80b1e511 152
913419fc 153--abbrev[=<n>]::
47dd0d59
JH
154 Instead of showing the full 40-byte hexadecimal object
155 name in diff-raw format output and diff-tree header
323b9db8 156 lines, show only a partial prefix. This is
dce5ef14 157 independent of the `--full-index` option above, which controls
913419fc 158 the diff-patch output format. Non default number of
dce5ef14 159 digits can be specified with `--abbrev=<n>`.
47dd0d59 160
dda2d79a
JH
161-B::
162 Break complete rewrite changes into pairs of delete and create.
163
164-M::
165 Detect renames.
166
167-C::
ca6c0970 168 Detect copies as well as renames. See also `--find-copies-harder`.
dda2d79a 169
d4cb003f 170ifndef::git-format-patch[]
147cf317
JL
171--diff-filter=[ACDMRTUXB*]::
172 Select only files that are Added (`A`), Copied (`C`),
173 Deleted (`D`), Modified (`M`), Renamed (`R`), have their
f07c3c53
JH
174 type (i.e. regular file, symlink, submodule, ...) changed (`T`),
175 are Unmerged (`U`), are
147cf317
JL
176 Unknown (`X`), or have had their pairing Broken (`B`).
177 Any combination of the filter characters may be used.
178 When `*` (All-or-none) is added to the combination, all
179 paths are selected if there is any file that matches
180 other criteria in the comparison; if there is no file
181 that matches other criteria, nothing is selected.
d4cb003f 182endif::git-format-patch[]
147cf317 183
dda2d79a 184--find-copies-harder::
ca6c0970 185 For performance reasons, by default, `-C` option finds copies only
a6080a0a 186 if the original file of the copy was modified in the same
f73ae1fc 187 changeset. This flag makes the command
dda2d79a
JH
188 inspect unmodified files as candidates for the source of
189 copy. This is a very expensive operation for large
ca6c0970
JS
190 projects, so use it with caution. Giving more than one
191 `-C` option has the same effect.
dda2d79a 192
8082d8d3 193-l<num>::
dce5ef14 194 The `-M` and `-C` options require O(n^2) processing time where n
f73ae1fc 195 is the number of potential rename/copy targets. This
8082d8d3 196 option prevents rename/copy detection from running if
f73ae1fc 197 the number of rename/copy targets exceeds the specified
8082d8d3
JH
198 number.
199
d4cb003f 200ifndef::git-format-patch[]
dda2d79a 201-S<string>::
821d56aa
JK
202 Look for differences that introduce or remove an instance of
203 <string>. Note that this is different than the string simply
204 appearing in diff output; see the 'pickaxe' entry in
205 linkgit:gitdiffcore[7] for more details.
dda2d79a
JH
206
207--pickaxe-all::
dce5ef14 208 When `-S` finds a change, show all the changes in that
f73ae1fc 209 changeset, not just the files that contain the change
dda2d79a
JH
210 in <string>.
211
d01d8c67
PB
212--pickaxe-regex::
213 Make the <string> not a plain string but an extended POSIX
214 regex to match.
d4cb003f 215endif::git-format-patch[]
d01d8c67 216
dda2d79a
JH
217-O<orderfile>::
218 Output the patch in the order specified in the
219 <orderfile>, which has one shell glob pattern per line.
220
d4cb003f 221ifndef::git-format-patch[]
dda2d79a 222-R::
5f3aa197 223 Swap two inputs; that is, show differences from index or
dda2d79a
JH
224 on-disk file to tree contents.
225
c0cb4a06 226--relative[=<path>]::
cd676a51
JH
227 When run from a subdirectory of the project, it can be
228 told to exclude changes outside the directory and show
c0cb4a06
JH
229 pathnames relative to it with this option. When you are
230 not in a subdirectory (e.g. in a bare repository), you
231 can name which subdirectory to make the output relative
232 to by giving a <path> as an argument.
d4cb003f 233endif::git-format-patch[]
cd676a51 234
a9e67c8c 235-a::
d507bb15
SF
236--text::
237 Treat all files as text.
238
a44a0c99 239--ignore-space-at-eol::
0ac7903e 240 Ignore changes in whitespace at EOL.
a44a0c99 241
a9e67c8c 242-b::
8ebe185b 243--ignore-space-change::
0ac7903e
WC
244 Ignore changes in amount of whitespace. This ignores whitespace
245 at line end, and considers all other sequences of one or
246 more whitespace characters to be equivalent.
8ebe185b 247
a9e67c8c 248-w::
8ebe185b 249--ignore-all-space::
0ac7903e
WC
250 Ignore whitespace when comparing lines. This ignores
251 differences even if one line has whitespace where the other
8ebe185b
JN
252 line has none.
253
6d0e674a
RS
254--inter-hunk-context=<lines>::
255 Show the context between diff hunks, up to the specified number
256 of lines, thereby fusing hunks that are close to each other.
257
d4cb003f 258ifndef::git-format-patch[]
41bbf9d5
AR
259--exit-code::
260 Make the program exit with codes similar to diff(1).
261 That is, it exits with 1 if there were differences and
262 0 means no differences.
263
2a18c266 264--quiet::
dce5ef14 265 Disable all output of the program. Implies `--exit-code`.
d4cb003f 266endif::git-format-patch[]
2a18c266 267
72909bef
JS
268--ext-diff::
269 Allow an external diff helper to be executed. If you set an
5162e697
DM
270 external diff driver with linkgit:gitattributes[5], you need
271 to use this option with linkgit:git-log[1] and friends.
72909bef
JS
272
273--no-ext-diff::
274 Disallow external diff drivers.
275
50fd9bd8
JS
276--ignore-submodules::
277 Ignore changes to submodules in the diff generation.
278
eab9a40b
JS
279--src-prefix=<prefix>::
280 Show the given source prefix instead of "a/".
281
282--dst-prefix=<prefix>::
283 Show the given destination prefix instead of "b/".
284
285--no-prefix::
286 Do not show any source or destination prefix.
287
8db9307c 288For more detailed explanation on these common options, see also
6998e4db 289linkgit:gitdiffcore[7].