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