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