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