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