96e0a581a1206ff7c258c8f9e7235d16972d584e
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.
7 ifndef::git-format-patch[]
8 ifndef::git-diff[]
9 ifndef::git-log[]
10 :git-diff-core: 1
11 endif::git-log[]
12 endif::git-diff[]
13 endif::git-format-patch[]
15 ifdef::git-format-patch[]
16 -p::
17 --no-stat::
18 Generate plain patches without any diffstats.
19 endif::git-format-patch[]
21 ifndef::git-format-patch[]
22 -p::
23 -u::
24 --patch::
25 Generate patch (see section on generating patches).
26 {git-diff? This is the default.}
27 endif::git-format-patch[]
29 -U<n>::
30 --unified=<n>::
31 Generate diffs with <n> lines of context instead of
32 the usual three.
33 ifndef::git-format-patch[]
34 Implies `-p`.
35 endif::git-format-patch[]
37 ifndef::git-format-patch[]
38 --raw::
39 Generate the raw format.
40 {git-diff-core? This is the default.}
41 endif::git-format-patch[]
43 ifndef::git-format-patch[]
44 --patch-with-raw::
45 Synonym for `-p --raw`.
46 endif::git-format-patch[]
48 --patience::
49 Generate a diff using the "patience diff" algorithm.
51 --stat[=<width>[,<name-width>]]::
52 Generate a diffstat. You can override the default
53 output width for 80-column terminal by `--stat=<width>`.
54 The width of the filename part can be controlled by
55 giving another width to it separated by a comma.
57 --numstat::
58 Similar to `\--stat`, but shows number of added and
59 deleted lines in decimal notation and pathname without
60 abbreviation, to make it more machine friendly. For
61 binary files, outputs two `-` instead of saying
62 `0 0`.
64 --shortstat::
65 Output only the last line of the `--stat` format containing total
66 number of modified files, as well as number of added and deleted
67 lines.
69 --dirstat[=<limit>]::
70 Output the distribution of relative amount of changes (number of lines added or
71 removed) for each sub-directory. Directories with changes below
72 a cut-off percent (3% by default) are not shown. The cut-off percent
73 can be set with `--dirstat=<limit>`. Changes in a child directory are not
74 counted for the parent directory, unless `--cumulative` is used.
75 +
76 Note that the `--dirstat` option computes the changes while ignoring
77 the amount of pure code movements within a file. In other words,
78 rearranging lines in a file is not counted as much as other changes.
80 --dirstat-by-file[=<limit>]::
81 Same as `--dirstat`, but counts changed files instead of lines.
83 --summary::
84 Output a condensed summary of extended header information
85 such as creations, renames and mode changes.
87 ifndef::git-format-patch[]
88 --patch-with-stat::
89 Synonym for `-p --stat`.
90 endif::git-format-patch[]
92 ifndef::git-format-patch[]
94 -z::
95 ifdef::git-log[]
96 Separate the commits with NULs instead of with new newlines.
97 +
98 Also, when `--raw` or `--numstat` has been given, do not munge
99 pathnames and use NULs as output field terminators.
100 endif::git-log[]
101 ifndef::git-log[]
102 When `--raw`, `--numstat`, `--name-only` or `--name-status` has been
103 given, do not munge pathnames and use NULs as output field terminators.
104 endif::git-log[]
105 +
106 Without this option, each pathname output will have TAB, LF, double quotes,
107 and backslash characters replaced with `\t`, `\n`, `\"`, and `\\`,
108 respectively, and the pathname will be enclosed in double quotes if
109 any of those replacements occurred.
111 --name-only::
112 Show only names of changed files.
114 --name-status::
115 Show only names and status of changed files. See the description
116 of the `--diff-filter` option on what the status letters mean.
118 --submodule[=<format>]::
119 Chose the output format for submodule differences. <format> can be one of
120 'short' and 'log'. 'short' just shows pairs of commit names, this format
121 is used when this option is not given. 'log' is the default value for this
122 option and lists the commits in that commit range like the 'summary'
123 option of linkgit:git-submodule[1] does.
125 --color[=<when>]::
126 Show colored diff.
127 The value must be `always` (the default for `<when>`), `never`, or `auto`.
128 The default value is `never`.
129 ifdef::git-diff[]
130 It can be changed by the `color.ui` and `color.diff`
131 configuration settings.
132 endif::git-diff[]
134 --no-color::
135 Turn off colored diff.
136 ifdef::git-diff[]
137 This can be used to override configuration settings.
138 endif::git-diff[]
139 It is the same as `--color=never`.
141 --word-diff[=<mode>]::
142 Show a word diff, using the <mode> to delimit changed words.
143 By default, words are delimited by whitespace; see
144 `--word-diff-regex` below. The <mode> defaults to 'plain', and
145 must be one of:
146 +
147 --
148 color::
149 Highlight changed words using only colors. Implies `--color`.
150 plain::
151 Show words as `[-removed-]` and `{+added+}`. Makes no
152 attempts to escape the delimiters if they appear in the input,
153 so the output may be ambiguous.
154 porcelain::
155 Use a special line-based format intended for script
156 consumption. Added/removed/unchanged runs are printed in the
157 usual unified diff format, starting with a `+`/`-`/` `
158 character at the beginning of the line and extending to the
159 end of the line. Newlines in the input are represented by a
160 tilde `~` on a line of its own.
161 none::
162 Disable word diff again.
163 --
164 +
165 Note that despite the name of the first mode, color is used to
166 highlight the changed parts in all modes if enabled.
168 --word-diff-regex=<regex>::
169 Use <regex> to decide what a word is, instead of considering
170 runs of non-whitespace to be a word. Also implies
171 `--word-diff` unless it was already enabled.
172 +
173 Every non-overlapping match of the
174 <regex> is considered a word. Anything between these matches is
175 considered whitespace and ignored(!) for the purposes of finding
176 differences. You may want to append `|[^[:space:]]` to your regular
177 expression to make sure that it matches all non-whitespace characters.
178 A match that contains a newline is silently truncated(!) at the
179 newline.
180 +
181 The regex can also be set via a diff driver or configuration option, see
182 linkgit:gitattributes[1] or linkgit:git-config[1]. Giving it explicitly
183 overrides any diff driver or configuration setting. Diff drivers
184 override configuration settings.
186 --color-words[=<regex>]::
187 Equivalent to `--word-diff=color` plus (if a regex was
188 specified) `--word-diff-regex=<regex>`.
189 endif::git-format-patch[]
191 --no-renames::
192 Turn off rename detection, even when the configuration
193 file gives the default to do so.
195 ifndef::git-format-patch[]
196 --check::
197 Warn if changes introduce whitespace errors. What are
198 considered whitespace errors is controlled by `core.whitespace`
199 configuration. By default, trailing whitespaces (including
200 lines that solely consist of whitespaces) and a space character
201 that is immediately followed by a tab character inside the
202 initial indent of the line are considered whitespace errors.
203 Exits with non-zero status if problems are found. Not compatible
204 with --exit-code.
205 endif::git-format-patch[]
207 --full-index::
208 Instead of the first handful of characters, show the full
209 pre- and post-image blob object names on the "index"
210 line when generating patch format output.
212 --binary::
213 In addition to `--full-index`, output a binary diff that
214 can be applied with `git-apply`.
216 --abbrev[=<n>]::
217 Instead of showing the full 40-byte hexadecimal object
218 name in diff-raw format output and diff-tree header
219 lines, show only a partial prefix. This is
220 independent of the `--full-index` option above, which controls
221 the diff-patch output format. Non default number of
222 digits can be specified with `--abbrev=<n>`.
224 -B[<n>][/<m>]::
225 --break-rewrites[=[<n>][/<m>]]::
226 Break complete rewrite changes into pairs of delete and
227 create. This serves two purposes:
228 +
229 It affects the way a change that amounts to a total rewrite of a file
230 not as a series of deletion and insertion mixed together with a very
231 few lines that happen to match textually as the context, but as a
232 single deletion of everything old followed by a single insertion of
233 everything new, and the number `m` controls this aspect of the -B
234 option (defaults to 60%). `-B/70%` specifies that less than 30% of the
235 original should remain in the result for git to consider it a total
236 rewrite (i.e. otherwise the resulting patch will be a series of
237 deletion and insertion mixed together with context lines).
238 +
239 When used with -M, a totally-rewritten file is also considered as the
240 source of a rename (usually -M only considers a file that disappeared
241 as the source of a rename), and the number `n` controls this aspect of
242 the -B option (defaults to 50%). `-B20%` specifies that a change with
243 addition and deletion compared to 20% or more of the file's size are
244 eligible for being picked up as a possible source of a rename to
245 another file.
247 -M[<n>]::
248 --find-renames[=<n>]::
249 ifndef::git-log[]
250 Detect renames.
251 endif::git-log[]
252 ifdef::git-log[]
253 If generating diffs, detect and report renames for each commit.
254 For following files across renames while traversing history, see
255 `--follow`.
256 endif::git-log[]
257 If `n` is specified, it is a threshold on the similarity
258 index (i.e. amount of addition/deletions compared to the
259 file's size). For example, `-M90%` means git should consider a
260 delete/add pair to be a rename if more than 90% of the file
261 hasn't changed.
263 -C[<n>]::
264 --find-copies[=<n>]::
265 Detect copies as well as renames. See also `--find-copies-harder`.
266 If `n` is specified, it has the same meaning as for `-M<n>`.
268 --find-copies-harder::
269 For performance reasons, by default, `-C` option finds copies only
270 if the original file of the copy was modified in the same
271 changeset. This flag makes the command
272 inspect unmodified files as candidates for the source of
273 copy. This is a very expensive operation for large
274 projects, so use it with caution. Giving more than one
275 `-C` option has the same effect.
277 -l<num>::
278 The `-M` and `-C` options require O(n^2) processing time where n
279 is the number of potential rename/copy targets. This
280 option prevents rename/copy detection from running if
281 the number of rename/copy targets exceeds the specified
282 number.
284 ifndef::git-format-patch[]
285 --diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]::
286 Select only files that are Added (`A`), Copied (`C`),
287 Deleted (`D`), Modified (`M`), Renamed (`R`), have their
288 type (i.e. regular file, symlink, submodule, ...) changed (`T`),
289 are Unmerged (`U`), are
290 Unknown (`X`), or have had their pairing Broken (`B`).
291 Any combination of the filter characters (including none) can be used.
292 When `*` (All-or-none) is added to the combination, all
293 paths are selected if there is any file that matches
294 other criteria in the comparison; if there is no file
295 that matches other criteria, nothing is selected.
297 -S<string>::
298 Look for differences that introduce or remove an instance of
299 <string>. Note that this is different than the string simply
300 appearing in diff output; see the 'pickaxe' entry in
301 linkgit:gitdiffcore[7] for more details.
303 -G<regex>::
304 Look for differences whose added or removed line matches
305 the given <regex>.
307 --pickaxe-all::
308 When `-S` or `-G` finds a change, show all the changes in that
309 changeset, not just the files that contain the change
310 in <string>.
312 --pickaxe-regex::
313 Make the <string> not a plain string but an extended POSIX
314 regex to match.
315 endif::git-format-patch[]
317 -O<orderfile>::
318 Output the patch in the order specified in the
319 <orderfile>, which has one shell glob pattern per line.
321 ifndef::git-format-patch[]
322 -R::
323 Swap two inputs; that is, show differences from index or
324 on-disk file to tree contents.
326 --relative[=<path>]::
327 When run from a subdirectory of the project, it can be
328 told to exclude changes outside the directory and show
329 pathnames relative to it with this option. When you are
330 not in a subdirectory (e.g. in a bare repository), you
331 can name which subdirectory to make the output relative
332 to by giving a <path> as an argument.
333 endif::git-format-patch[]
335 -a::
336 --text::
337 Treat all files as text.
339 --ignore-space-at-eol::
340 Ignore changes in whitespace at EOL.
342 -b::
343 --ignore-space-change::
344 Ignore changes in amount of whitespace. This ignores whitespace
345 at line end, and considers all other sequences of one or
346 more whitespace characters to be equivalent.
348 -w::
349 --ignore-all-space::
350 Ignore whitespace when comparing lines. This ignores
351 differences even if one line has whitespace where the other
352 line has none.
354 --inter-hunk-context=<lines>::
355 Show the context between diff hunks, up to the specified number
356 of lines, thereby fusing hunks that are close to each other.
358 ifndef::git-format-patch[]
359 --exit-code::
360 Make the program exit with codes similar to diff(1).
361 That is, it exits with 1 if there were differences and
362 0 means no differences.
364 --quiet::
365 Disable all output of the program. Implies `--exit-code`.
366 endif::git-format-patch[]
368 --ext-diff::
369 Allow an external diff helper to be executed. If you set an
370 external diff driver with linkgit:gitattributes[5], you need
371 to use this option with linkgit:git-log[1] and friends.
373 --no-ext-diff::
374 Disallow external diff drivers.
376 --ignore-submodules[=<when>]::
377 Ignore changes to submodules in the diff generation. <when> can be
378 either "none", "untracked", "dirty" or "all", which is the default
379 Using "none" will consider the submodule modified when it either contains
380 untracked or modified files or its HEAD differs from the commit recorded
381 in the superproject and can be used to override any settings of the
382 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
383 "untracked" is used submodules are not considered dirty when they only
384 contain untracked content (but they are still scanned for modified
385 content). Using "dirty" ignores all changes to the work tree of submodules,
386 only changes to the commits stored in the superproject are shown (this was
387 the behavior until 1.7.0). Using "all" hides all changes to submodules.
389 --src-prefix=<prefix>::
390 Show the given source prefix instead of "a/".
392 --dst-prefix=<prefix>::
393 Show the given destination prefix instead of "b/".
395 --no-prefix::
396 Do not show any source or destination prefix.
398 For more detailed explanation on these common options, see also
399 linkgit:gitdiffcore[7].