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