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 --minimal::
49 Spend extra time to make sure the smallest possible
50 diff is produced.
52 --patience::
53 Generate a diff using the "patience diff" algorithm.
55 --stat[=<width>[,<name-width>[,<count>]]]::
56 Generate a diffstat. By default, as much space as necessary
57 will be used for the filename part, and the rest for
58 the graph part. Maximum width defaults to terminal width,
59 or 80 columns if not connected to a terminal, and can be
60 overriden by `<width>`. The width of the filename part can be
61 limited by giving another width `<name-width>` after a comma.
62 By giving a third parameter `<count>`, you can limit the
63 output to the first `<count>` lines, followed by `...` if
64 there are more.
65 +
66 These parameters can also be set individually with `--stat-width=<width>`,
67 `--stat-name-width=<name-width>` and `--stat-count=<count>`.
69 --numstat::
70 Similar to `\--stat`, but shows number of added and
71 deleted lines in decimal notation and pathname without
72 abbreviation, to make it more machine friendly. For
73 binary files, outputs two `-` instead of saying
74 `0 0`.
76 --shortstat::
77 Output only the last line of the `--stat` format containing total
78 number of modified files, as well as number of added and deleted
79 lines.
81 --dirstat[=<param1,param2,...>]::
82 Output the distribution of relative amount of changes for each
83 sub-directory. The behavior of `--dirstat` can be customized by
84 passing it a comma separated list of parameters.
85 The defaults are controlled by the `diff.dirstat` configuration
86 variable (see linkgit:git-config[1]).
87 The following parameters are available:
88 +
89 --
90 `changes`;;
91 Compute the dirstat numbers by counting the lines that have been
92 removed from the source, or added to the destination. This ignores
93 the amount of pure code movements within a file. In other words,
94 rearranging lines in a file is not counted as much as other changes.
95 This is the default behavior when no parameter is given.
96 `lines`;;
97 Compute the dirstat numbers by doing the regular line-based diff
98 analysis, and summing the removed/added line counts. (For binary
99 files, count 64-byte chunks instead, since binary files have no
100 natural concept of lines). This is a more expensive `--dirstat`
101 behavior than the `changes` behavior, but it does count rearranged
102 lines within a file as much as other changes. The resulting output
103 is consistent with what you get from the other `--*stat` options.
104 `files`;;
105 Compute the dirstat numbers by counting the number of files changed.
106 Each changed file counts equally in the dirstat analysis. This is
107 the computationally cheapest `--dirstat` behavior, since it does
108 not have to look at the file contents at all.
109 `cumulative`;;
110 Count changes in a child directory for the parent directory as well.
111 Note that when using `cumulative`, the sum of the percentages
112 reported may exceed 100%. The default (non-cumulative) behavior can
113 be specified with the `noncumulative` parameter.
114 <limit>;;
115 An integer parameter specifies a cut-off percent (3% by default).
116 Directories contributing less than this percentage of the changes
117 are not shown in the output.
118 --
119 +
120 Example: The following will count changed files, while ignoring
121 directories with less than 10% of the total amount of changed files,
122 and accumulating child directory counts in the parent directories:
123 `--dirstat=files,10,cumulative`.
125 --summary::
126 Output a condensed summary of extended header information
127 such as creations, renames and mode changes.
129 ifndef::git-format-patch[]
130 --patch-with-stat::
131 Synonym for `-p --stat`.
132 endif::git-format-patch[]
134 ifndef::git-format-patch[]
136 -z::
137 ifdef::git-log[]
138 Separate the commits with NULs instead of with new newlines.
139 +
140 Also, when `--raw` or `--numstat` has been given, do not munge
141 pathnames and use NULs as output field terminators.
142 endif::git-log[]
143 ifndef::git-log[]
144 When `--raw`, `--numstat`, `--name-only` or `--name-status` has been
145 given, do not munge pathnames and use NULs as output field terminators.
146 endif::git-log[]
147 +
148 Without this option, each pathname output will have TAB, LF, double quotes,
149 and backslash characters replaced with `\t`, `\n`, `\"`, and `\\`,
150 respectively, and the pathname will be enclosed in double quotes if
151 any of those replacements occurred.
153 --name-only::
154 Show only names of changed files.
156 --name-status::
157 Show only names and status of changed files. See the description
158 of the `--diff-filter` option on what the status letters mean.
160 --submodule[=<format>]::
161 Chose the output format for submodule differences. <format> can be one of
162 'short' and 'log'. 'short' just shows pairs of commit names, this format
163 is used when this option is not given. 'log' is the default value for this
164 option and lists the commits in that commit range like the 'summary'
165 option of linkgit:git-submodule[1] does.
167 --color[=<when>]::
168 Show colored diff.
169 The value must be `always` (the default for `<when>`), `never`, or `auto`.
170 The default value is `never`.
171 ifdef::git-diff[]
172 It can be changed by the `color.ui` and `color.diff`
173 configuration settings.
174 endif::git-diff[]
176 --no-color::
177 Turn off colored diff.
178 ifdef::git-diff[]
179 This can be used to override configuration settings.
180 endif::git-diff[]
181 It is the same as `--color=never`.
183 --word-diff[=<mode>]::
184 Show a word diff, using the <mode> to delimit changed words.
185 By default, words are delimited by whitespace; see
186 `--word-diff-regex` below. The <mode> defaults to 'plain', and
187 must be one of:
188 +
189 --
190 color::
191 Highlight changed words using only colors. Implies `--color`.
192 plain::
193 Show words as `[-removed-]` and `{+added+}`. Makes no
194 attempts to escape the delimiters if they appear in the input,
195 so the output may be ambiguous.
196 porcelain::
197 Use a special line-based format intended for script
198 consumption. Added/removed/unchanged runs are printed in the
199 usual unified diff format, starting with a `+`/`-`/` `
200 character at the beginning of the line and extending to the
201 end of the line. Newlines in the input are represented by a
202 tilde `~` on a line of its own.
203 none::
204 Disable word diff again.
205 --
206 +
207 Note that despite the name of the first mode, color is used to
208 highlight the changed parts in all modes if enabled.
210 --word-diff-regex=<regex>::
211 Use <regex> to decide what a word is, instead of considering
212 runs of non-whitespace to be a word. Also implies
213 `--word-diff` unless it was already enabled.
214 +
215 Every non-overlapping match of the
216 <regex> is considered a word. Anything between these matches is
217 considered whitespace and ignored(!) for the purposes of finding
218 differences. You may want to append `|[^[:space:]]` to your regular
219 expression to make sure that it matches all non-whitespace characters.
220 A match that contains a newline is silently truncated(!) at the
221 newline.
222 +
223 The regex can also be set via a diff driver or configuration option, see
224 linkgit:gitattributes[1] or linkgit:git-config[1]. Giving it explicitly
225 overrides any diff driver or configuration setting. Diff drivers
226 override configuration settings.
228 --color-words[=<regex>]::
229 Equivalent to `--word-diff=color` plus (if a regex was
230 specified) `--word-diff-regex=<regex>`.
231 endif::git-format-patch[]
233 --no-renames::
234 Turn off rename detection, even when the configuration
235 file gives the default to do so.
237 ifndef::git-format-patch[]
238 --check::
239 Warn if changes introduce whitespace errors. What are
240 considered whitespace errors is controlled by `core.whitespace`
241 configuration. By default, trailing whitespaces (including
242 lines that solely consist of whitespaces) and a space character
243 that is immediately followed by a tab character inside the
244 initial indent of the line are considered whitespace errors.
245 Exits with non-zero status if problems are found. Not compatible
246 with --exit-code.
247 endif::git-format-patch[]
249 --full-index::
250 Instead of the first handful of characters, show the full
251 pre- and post-image blob object names on the "index"
252 line when generating patch format output.
254 --binary::
255 In addition to `--full-index`, output a binary diff that
256 can be applied with `git-apply`.
258 --abbrev[=<n>]::
259 Instead of showing the full 40-byte hexadecimal object
260 name in diff-raw format output and diff-tree header
261 lines, show only a partial prefix. This is
262 independent of the `--full-index` option above, which controls
263 the diff-patch output format. Non default number of
264 digits can be specified with `--abbrev=<n>`.
266 -B[<n>][/<m>]::
267 --break-rewrites[=[<n>][/<m>]]::
268 Break complete rewrite changes into pairs of delete and
269 create. This serves two purposes:
270 +
271 It affects the way a change that amounts to a total rewrite of a file
272 not as a series of deletion and insertion mixed together with a very
273 few lines that happen to match textually as the context, but as a
274 single deletion of everything old followed by a single insertion of
275 everything new, and the number `m` controls this aspect of the -B
276 option (defaults to 60%). `-B/70%` specifies that less than 30% of the
277 original should remain in the result for git to consider it a total
278 rewrite (i.e. otherwise the resulting patch will be a series of
279 deletion and insertion mixed together with context lines).
280 +
281 When used with -M, a totally-rewritten file is also considered as the
282 source of a rename (usually -M only considers a file that disappeared
283 as the source of a rename), and the number `n` controls this aspect of
284 the -B option (defaults to 50%). `-B20%` specifies that a change with
285 addition and deletion compared to 20% or more of the file's size are
286 eligible for being picked up as a possible source of a rename to
287 another file.
289 -M[<n>]::
290 --find-renames[=<n>]::
291 ifndef::git-log[]
292 Detect renames.
293 endif::git-log[]
294 ifdef::git-log[]
295 If generating diffs, detect and report renames for each commit.
296 For following files across renames while traversing history, see
297 `--follow`.
298 endif::git-log[]
299 If `n` is specified, it is a threshold on the similarity
300 index (i.e. amount of addition/deletions compared to the
301 file's size). For example, `-M90%` means git should consider a
302 delete/add pair to be a rename if more than 90% of the file
303 hasn't changed.
305 -C[<n>]::
306 --find-copies[=<n>]::
307 Detect copies as well as renames. See also `--find-copies-harder`.
308 If `n` is specified, it has the same meaning as for `-M<n>`.
310 --find-copies-harder::
311 For performance reasons, by default, `-C` option finds copies only
312 if the original file of the copy was modified in the same
313 changeset. This flag makes the command
314 inspect unmodified files as candidates for the source of
315 copy. This is a very expensive operation for large
316 projects, so use it with caution. Giving more than one
317 `-C` option has the same effect.
319 -D::
320 --irreversible-delete::
321 Omit the preimage for deletes, i.e. print only the header but not
322 the diff between the preimage and `/dev/null`. The resulting patch
323 is not meant to be applied with `patch` nor `git apply`; this is
324 solely for people who want to just concentrate on reviewing the
325 text after the change. In addition, the output obviously lack
326 enough information to apply such a patch in reverse, even manually,
327 hence the name of the option.
328 +
329 When used together with `-B`, omit also the preimage in the deletion part
330 of a delete/create pair.
332 -l<num>::
333 The `-M` and `-C` options require O(n^2) processing time where n
334 is the number of potential rename/copy targets. This
335 option prevents rename/copy detection from running if
336 the number of rename/copy targets exceeds the specified
337 number.
339 ifndef::git-format-patch[]
340 --diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]::
341 Select only files that are Added (`A`), Copied (`C`),
342 Deleted (`D`), Modified (`M`), Renamed (`R`), have their
343 type (i.e. regular file, symlink, submodule, ...) changed (`T`),
344 are Unmerged (`U`), are
345 Unknown (`X`), or have had their pairing Broken (`B`).
346 Any combination of the filter characters (including none) can be used.
347 When `*` (All-or-none) is added to the combination, all
348 paths are selected if there is any file that matches
349 other criteria in the comparison; if there is no file
350 that matches other criteria, nothing is selected.
352 -S<string>::
353 Look for differences that introduce or remove an instance of
354 <string>. Note that this is different than the string simply
355 appearing in diff output; see the 'pickaxe' entry in
356 linkgit:gitdiffcore[7] for more details.
358 -G<regex>::
359 Look for differences whose added or removed line matches
360 the given <regex>.
362 --pickaxe-all::
363 When `-S` or `-G` finds a change, show all the changes in that
364 changeset, not just the files that contain the change
365 in <string>.
367 --pickaxe-regex::
368 Make the <string> not a plain string but an extended POSIX
369 regex to match.
370 endif::git-format-patch[]
372 -O<orderfile>::
373 Output the patch in the order specified in the
374 <orderfile>, which has one shell glob pattern per line.
376 ifndef::git-format-patch[]
377 -R::
378 Swap two inputs; that is, show differences from index or
379 on-disk file to tree contents.
381 --relative[=<path>]::
382 When run from a subdirectory of the project, it can be
383 told to exclude changes outside the directory and show
384 pathnames relative to it with this option. When you are
385 not in a subdirectory (e.g. in a bare repository), you
386 can name which subdirectory to make the output relative
387 to by giving a <path> as an argument.
388 endif::git-format-patch[]
390 -a::
391 --text::
392 Treat all files as text.
394 --ignore-space-at-eol::
395 Ignore changes in whitespace at EOL.
397 -b::
398 --ignore-space-change::
399 Ignore changes in amount of whitespace. This ignores whitespace
400 at line end, and considers all other sequences of one or
401 more whitespace characters to be equivalent.
403 -w::
404 --ignore-all-space::
405 Ignore whitespace when comparing lines. This ignores
406 differences even if one line has whitespace where the other
407 line has none.
409 --inter-hunk-context=<lines>::
410 Show the context between diff hunks, up to the specified number
411 of lines, thereby fusing hunks that are close to each other.
413 -W::
414 --function-context::
415 Show whole surrounding functions of changes.
417 ifndef::git-format-patch[]
418 ifndef::git-log[]
419 --exit-code::
420 Make the program exit with codes similar to diff(1).
421 That is, it exits with 1 if there were differences and
422 0 means no differences.
424 --quiet::
425 Disable all output of the program. Implies `--exit-code`.
426 endif::git-log[]
427 endif::git-format-patch[]
429 --ext-diff::
430 Allow an external diff helper to be executed. If you set an
431 external diff driver with linkgit:gitattributes[5], you need
432 to use this option with linkgit:git-log[1] and friends.
434 --no-ext-diff::
435 Disallow external diff drivers.
437 --textconv::
438 --no-textconv::
439 Allow (or disallow) external text conversion filters to be run
440 when comparing binary files. See linkgit:gitattributes[5] for
441 details. Because textconv filters are typically a one-way
442 conversion, the resulting diff is suitable for human
443 consumption, but cannot be applied. For this reason, textconv
444 filters are enabled by default only for linkgit:git-diff[1] and
445 linkgit:git-log[1], but not for linkgit:git-format-patch[1] or
446 diff plumbing commands.
448 --ignore-submodules[=<when>]::
449 Ignore changes to submodules in the diff generation. <when> can be
450 either "none", "untracked", "dirty" or "all", which is the default
451 Using "none" will consider the submodule modified when it either contains
452 untracked or modified files or its HEAD differs from the commit recorded
453 in the superproject and can be used to override any settings of the
454 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
455 "untracked" is used submodules are not considered dirty when they only
456 contain untracked content (but they are still scanned for modified
457 content). Using "dirty" ignores all changes to the work tree of submodules,
458 only changes to the commits stored in the superproject are shown (this was
459 the behavior until 1.7.0). Using "all" hides all changes to submodules.
461 --src-prefix=<prefix>::
462 Show the given source prefix instead of "a/".
464 --dst-prefix=<prefix>::
465 Show the given destination prefix instead of "b/".
467 --no-prefix::
468 Do not show any source or destination prefix.
470 For more detailed explanation on these common options, see also
471 linkgit:gitdiffcore[7].