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