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[]
13 endif::git-format-patch[]
15 ifdef::git-format-patch[]
18 Generate plain patches without any diffstats.
19 endif::git-format-patch[]
21 ifndef::git-format-patch[]
24 Generate patch (see section on generating patches).
25 {git-diff? This is the default.}
26 endif::git-format-patch[]
30 Generate diffs with <n> lines of context instead of
32 ifndef::git-format-patch[]
34 endif::git-format-patch[]
36 ifndef::git-format-patch[]
38 Generate the raw format.
39 {git-diff-core? This is the default.}
40 endif::git-format-patch[]
42 ifndef::git-format-patch[]
44 Synonym for `-p --raw`.
45 endif::git-format-patch[]
48 Generate a diff using the "patience diff" algorithm.
50 --stat[=width[,name-width]]::
51 Generate a diffstat. You can override the default
52 output width for 80-column terminal by `--stat=width`.
53 The width of the filename part can be controlled by
54 giving another width to it separated by a comma.
57 Similar to `\--stat`, but shows number of added and
58 deleted lines in decimal notation and pathname without
59 abbreviation, to make it more machine friendly. For
60 binary files, outputs two `-` instead of saying
64 Output only the last line of the `--stat` format containing total
65 number of modified files, as well as number of added and deleted
69 Output the distribution of relative amount of changes (number of lines added or
70 removed) for each sub-directory. Directories with changes below
71 a cut-off percent (3% by default) are not shown. The cut-off percent
72 can be set with `--dirstat=limit`. Changes in a child directory is not
73 counted for the parent directory, unless `--cumulative` is used.
75 --dirstat-by-file[=limit]::
76 Same as `--dirstat`, but counts changed files instead of lines.
79 Output a condensed summary of extended header information
80 such as creations, renames and mode changes.
82 ifndef::git-format-patch[]
84 Synonym for `-p --stat`.
85 endif::git-format-patch[]
87 ifndef::git-format-patch[]
91 Separate the commits with NULs instead of with new newlines.
93 Also, when `--raw` or `--numstat` has been given, do not munge
94 pathnames and use NULs as output field terminators.
97 When `--raw` or `--numstat` has been given, do not munge
98 pathnames and use NULs as output field terminators.
101 Without this option, each pathname output will have TAB, LF, double quotes,
102 and backslash characters replaced with `\t`, `\n`, `\"`, and `\\`,
103 respectively, and the pathname will be enclosed in double quotes if
104 any of those replacements occurred.
107 Show only names of changed files.
110 Show only names and status of changed files. See the description
111 of the `--diff-filter` option on what the status letters mean.
113 --submodule[=<format>]::
114 Chose the output format for submodule differences. <format> can be one of
115 'short' and 'log'. 'short' just shows pairs of commit names, this format
116 is used when this option is not given. 'log' is the default value for this
117 option and lists the commits in that commit range like the 'summary'
118 option of linkgit:git-submodule[1] does.
122 The value must be always (the default), never, or auto.
125 Turn off colored diff, even when the configuration file
126 gives the default to color output.
127 Same as `--color=never`.
129 --word-diff[=<mode>]::
130 Show a word diff, using the <mode> to delimit changed words.
131 By default, words are delimited by whitespace; see
132 `--word-diff-regex` below. The <mode> defaults to 'plain', and
137 Highlight changed words using only colors. Implies `--color`.
139 Show words as `[-removed-]` and `{+added+}`. Makes no
140 attempts to escape the delimiters if they appear in the input,
141 so the output may be ambiguous.
143 Use a special line-based format intended for script
144 consumption. Added/removed/unchanged runs are printed in the
145 usual unified diff format, starting with a `+`/`-`/` `
146 character at the beginning of the line and extending to the
147 end of the line. Newlines in the input are represented by a
148 tilde `~` on a line of its own.
150 Disable word diff again.
153 Note that despite the name of the first mode, color is used to
154 highlight the changed parts in all modes if enabled.
156 --word-diff-regex=<regex>::
157 Use <regex> to decide what a word is, instead of considering
158 runs of non-whitespace to be a word. Also implies
159 `--word-diff` unless it was already enabled.
161 Every non-overlapping match of the
162 <regex> is considered a word. Anything between these matches is
163 considered whitespace and ignored(!) for the purposes of finding
164 differences. You may want to append `|[^[:space:]]` to your regular
165 expression to make sure that it matches all non-whitespace characters.
166 A match that contains a newline is silently truncated(!) at the
169 The regex can also be set via a diff driver or configuration option, see
170 linkgit:gitattributes[1] or linkgit:git-config[1]. Giving it explicitly
171 overrides any diff driver or configuration setting. Diff drivers
172 override configuration settings.
174 --color-words[=<regex>]::
175 Equivalent to `--word-diff=color` plus (if a regex was
176 specified) `--word-diff-regex=<regex>`.
177 endif::git-format-patch[]
180 Turn off rename detection, even when the configuration
181 file gives the default to do so.
183 ifndef::git-format-patch[]
185 Warn if changes introduce trailing whitespace
186 or an indent that uses a space before a tab. Exits with
187 non-zero status if problems are found. Not compatible with
189 endif::git-format-patch[]
192 Instead of the first handful of characters, show the full
193 pre- and post-image blob object names on the "index"
194 line when generating patch format output.
197 In addition to `--full-index`, output a binary diff that
198 can be applied with `git-apply`.
201 Instead of showing the full 40-byte hexadecimal object
202 name in diff-raw format output and diff-tree header
203 lines, show only a partial prefix. This is
204 independent of the `--full-index` option above, which controls
205 the diff-patch output format. Non default number of
206 digits can be specified with `--abbrev=<n>`.
209 Break complete rewrite changes into pairs of delete and create.
215 Detect copies as well as renames. See also `--find-copies-harder`.
217 ifndef::git-format-patch[]
218 --diff-filter=[ACDMRTUXB*]::
219 Select only files that are Added (`A`), Copied (`C`),
220 Deleted (`D`), Modified (`M`), Renamed (`R`), have their
221 type (i.e. regular file, symlink, submodule, ...) changed (`T`),
222 are Unmerged (`U`), are
223 Unknown (`X`), or have had their pairing Broken (`B`).
224 Any combination of the filter characters may be used.
225 When `*` (All-or-none) is added to the combination, all
226 paths are selected if there is any file that matches
227 other criteria in the comparison; if there is no file
228 that matches other criteria, nothing is selected.
229 endif::git-format-patch[]
231 --find-copies-harder::
232 For performance reasons, by default, `-C` option finds copies only
233 if the original file of the copy was modified in the same
234 changeset. This flag makes the command
235 inspect unmodified files as candidates for the source of
236 copy. This is a very expensive operation for large
237 projects, so use it with caution. Giving more than one
238 `-C` option has the same effect.
241 The `-M` and `-C` options require O(n^2) processing time where n
242 is the number of potential rename/copy targets. This
243 option prevents rename/copy detection from running if
244 the number of rename/copy targets exceeds the specified
247 ifndef::git-format-patch[]
249 Look for differences that introduce or remove an instance of
250 <string>. Note that this is different than the string simply
251 appearing in diff output; see the 'pickaxe' entry in
252 linkgit:gitdiffcore[7] for more details.
255 When `-S` finds a change, show all the changes in that
256 changeset, not just the files that contain the change
260 Make the <string> not a plain string but an extended POSIX
262 endif::git-format-patch[]
265 Output the patch in the order specified in the
266 <orderfile>, which has one shell glob pattern per line.
268 ifndef::git-format-patch[]
270 Swap two inputs; that is, show differences from index or
271 on-disk file to tree contents.
273 --relative[=<path>]::
274 When run from a subdirectory of the project, it can be
275 told to exclude changes outside the directory and show
276 pathnames relative to it with this option. When you are
277 not in a subdirectory (e.g. in a bare repository), you
278 can name which subdirectory to make the output relative
279 to by giving a <path> as an argument.
280 endif::git-format-patch[]
284 Treat all files as text.
286 --ignore-space-at-eol::
287 Ignore changes in whitespace at EOL.
290 --ignore-space-change::
291 Ignore changes in amount of whitespace. This ignores whitespace
292 at line end, and considers all other sequences of one or
293 more whitespace characters to be equivalent.
297 Ignore whitespace when comparing lines. This ignores
298 differences even if one line has whitespace where the other
301 --inter-hunk-context=<lines>::
302 Show the context between diff hunks, up to the specified number
303 of lines, thereby fusing hunks that are close to each other.
305 ifndef::git-format-patch[]
307 Make the program exit with codes similar to diff(1).
308 That is, it exits with 1 if there were differences and
309 0 means no differences.
312 Disable all output of the program. Implies `--exit-code`.
313 endif::git-format-patch[]
316 Allow an external diff helper to be executed. If you set an
317 external diff driver with linkgit:gitattributes[5], you need
318 to use this option with linkgit:git-log[1] and friends.
321 Disallow external diff drivers.
323 --ignore-submodules::
324 Ignore changes to submodules in the diff generation.
326 --src-prefix=<prefix>::
327 Show the given source prefix instead of "a/".
329 --dst-prefix=<prefix>::
330 Show the given destination prefix instead of "b/".
333 Do not show any source or destination prefix.
335 For more detailed explanation on these common options, see also
336 linkgit:gitdiffcore[7].