Submodules: Add the new "ignore" config option for diff and status
[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
5c5b2ea9
LT
51--stat[=width[,name-width]]::
52 Generate a diffstat. You can override the default
dce5ef14 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
37152d83 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
dce5ef14
BG
73 can be set with `--dirstat=limit`. Changes in a child directory is not
74 counted for the parent directory, unless `--cumulative` is used.
37152d83 75
fd33777b 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
dda2d79a
JH
209-B::
210 Break complete rewrite changes into pairs of delete and create.
211
212-M::
7ffad250 213ifndef::git-log[]
dda2d79a 214 Detect renames.
7ffad250
JK
215endif::git-log[]
216ifdef::git-log[]
217 If generating diffs, detect and report renames for each commit.
218 For following files across renames while traversing history, see
219 `--follow`.
220endif::git-log[]
dda2d79a
JH
221
222-C::
ca6c0970 223 Detect copies as well as renames. See also `--find-copies-harder`.
dda2d79a 224
d4cb003f 225ifndef::git-format-patch[]
147cf317
JL
226--diff-filter=[ACDMRTUXB*]::
227 Select only files that are Added (`A`), Copied (`C`),
228 Deleted (`D`), Modified (`M`), Renamed (`R`), have their
f07c3c53
JH
229 type (i.e. regular file, symlink, submodule, ...) changed (`T`),
230 are Unmerged (`U`), are
147cf317
JL
231 Unknown (`X`), or have had their pairing Broken (`B`).
232 Any combination of the filter characters may be used.
233 When `*` (All-or-none) is added to the combination, all
234 paths are selected if there is any file that matches
235 other criteria in the comparison; if there is no file
236 that matches other criteria, nothing is selected.
d4cb003f 237endif::git-format-patch[]
147cf317 238
dda2d79a 239--find-copies-harder::
ca6c0970 240 For performance reasons, by default, `-C` option finds copies only
a6080a0a 241 if the original file of the copy was modified in the same
f73ae1fc 242 changeset. This flag makes the command
dda2d79a
JH
243 inspect unmodified files as candidates for the source of
244 copy. This is a very expensive operation for large
ca6c0970
JS
245 projects, so use it with caution. Giving more than one
246 `-C` option has the same effect.
dda2d79a 247
8082d8d3 248-l<num>::
dce5ef14 249 The `-M` and `-C` options require O(n^2) processing time where n
f73ae1fc 250 is the number of potential rename/copy targets. This
8082d8d3 251 option prevents rename/copy detection from running if
f73ae1fc 252 the number of rename/copy targets exceeds the specified
8082d8d3
JH
253 number.
254
d4cb003f 255ifndef::git-format-patch[]
dda2d79a 256-S<string>::
821d56aa
JK
257 Look for differences that introduce or remove an instance of
258 <string>. Note that this is different than the string simply
259 appearing in diff output; see the 'pickaxe' entry in
260 linkgit:gitdiffcore[7] for more details.
dda2d79a
JH
261
262--pickaxe-all::
dce5ef14 263 When `-S` finds a change, show all the changes in that
f73ae1fc 264 changeset, not just the files that contain the change
dda2d79a
JH
265 in <string>.
266
d01d8c67
PB
267--pickaxe-regex::
268 Make the <string> not a plain string but an extended POSIX
269 regex to match.
d4cb003f 270endif::git-format-patch[]
d01d8c67 271
dda2d79a
JH
272-O<orderfile>::
273 Output the patch in the order specified in the
274 <orderfile>, which has one shell glob pattern per line.
275
d4cb003f 276ifndef::git-format-patch[]
dda2d79a 277-R::
5f3aa197 278 Swap two inputs; that is, show differences from index or
dda2d79a
JH
279 on-disk file to tree contents.
280
c0cb4a06 281--relative[=<path>]::
cd676a51
JH
282 When run from a subdirectory of the project, it can be
283 told to exclude changes outside the directory and show
c0cb4a06
JH
284 pathnames relative to it with this option. When you are
285 not in a subdirectory (e.g. in a bare repository), you
286 can name which subdirectory to make the output relative
287 to by giving a <path> as an argument.
d4cb003f 288endif::git-format-patch[]
cd676a51 289
a9e67c8c 290-a::
d507bb15
SF
291--text::
292 Treat all files as text.
293
a44a0c99 294--ignore-space-at-eol::
0ac7903e 295 Ignore changes in whitespace at EOL.
a44a0c99 296
a9e67c8c 297-b::
8ebe185b 298--ignore-space-change::
0ac7903e
WC
299 Ignore changes in amount of whitespace. This ignores whitespace
300 at line end, and considers all other sequences of one or
301 more whitespace characters to be equivalent.
8ebe185b 302
a9e67c8c 303-w::
8ebe185b 304--ignore-all-space::
0ac7903e
WC
305 Ignore whitespace when comparing lines. This ignores
306 differences even if one line has whitespace where the other
8ebe185b
JN
307 line has none.
308
6d0e674a
RS
309--inter-hunk-context=<lines>::
310 Show the context between diff hunks, up to the specified number
311 of lines, thereby fusing hunks that are close to each other.
312
d4cb003f 313ifndef::git-format-patch[]
41bbf9d5
AR
314--exit-code::
315 Make the program exit with codes similar to diff(1).
316 That is, it exits with 1 if there were differences and
317 0 means no differences.
318
2a18c266 319--quiet::
dce5ef14 320 Disable all output of the program. Implies `--exit-code`.
d4cb003f 321endif::git-format-patch[]
2a18c266 322
72909bef
JS
323--ext-diff::
324 Allow an external diff helper to be executed. If you set an
5162e697
DM
325 external diff driver with linkgit:gitattributes[5], you need
326 to use this option with linkgit:git-log[1] and friends.
72909bef
JS
327
328--no-ext-diff::
329 Disallow external diff drivers.
330
dd44d419
JL
331--ignore-submodules[=<when>]::
332 Ignore changes to submodules in the diff generation. <when> can be
aee9c7d6
JL
333 either "none", "untracked", "dirty" or "all", which is the default
334 Using "none" will consider the submodule modified when it either contains
335 untracked or modified files or its HEAD differs from the commit recorded
336 in the superproject and can be used to override any settings of the
337 'ignore' option in linkgit:git-config[1]. When
dd44d419
JL
338 "untracked" is used submodules are not considered dirty when they only
339 contain untracked content (but they are still scanned for modified
340 content). Using "dirty" ignores all changes to the work tree of submodules,
341 only changes to the commits stored in the superproject are shown (this was
342 the behavior until 1.7.0). Using "all" hides all changes to submodules.
50fd9bd8 343
eab9a40b
JS
344--src-prefix=<prefix>::
345 Show the given source prefix instead of "a/".
346
347--dst-prefix=<prefix>::
348 Show the given destination prefix instead of "b/".
349
350--no-prefix::
351 Do not show any source or destination prefix.
352
8db9307c 353For more detailed explanation on these common options, see also
6998e4db 354linkgit:gitdiffcore[7].