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[]
25 Generate patch (see section on generating patches).
26 {git-diff? This is the default.}
27 endif::git-format-patch[]
31 Generate diffs with <n> lines of context instead of
33 ifndef::git-format-patch[]
35 endif::git-format-patch[]
37 ifndef::git-format-patch[]
39 Generate the raw format.
40 {git-diff-core? This is the default.}
41 endif::git-format-patch[]
43 ifndef::git-format-patch[]
45 Synonym for `-p --raw`.
46 endif::git-format-patch[]
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.
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
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
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 is not
74 counted for the parent directory, unless `--cumulative` is used.
76 --dirstat-by-file[=limit]::
77 Same as `--dirstat`, but counts changed files instead of lines.
80 Output a condensed summary of extended header information
81 such as creations, renames and mode changes.
83 ifndef::git-format-patch[]
85 Synonym for `-p --stat`.
86 endif::git-format-patch[]
88 ifndef::git-format-patch[]
92 Separate the commits with NULs instead of with new newlines.
94 Also, when `--raw` or `--numstat` has been given, do not munge
95 pathnames and use NULs as output field terminators.
98 When `--raw`, `--numstat`, `--name-only` or `--name-status` has been
99 given, do not munge pathnames and use NULs as output field terminators.
102 Without this option, each pathname output will have TAB, LF, double quotes,
103 and backslash characters replaced with `\t`, `\n`, `\"`, and `\\`,
104 respectively, and the pathname will be enclosed in double quotes if
105 any of those replacements occurred.
108 Show only names of changed files.
111 Show only names and status of changed files. See the description
112 of the `--diff-filter` option on what the status letters mean.
114 --submodule[=<format>]::
115 Chose the output format for submodule differences. <format> can be one of
116 'short' and 'log'. 'short' just shows pairs of commit names, this format
117 is used when this option is not given. 'log' is the default value for this
118 option and lists the commits in that commit range like the 'summary'
119 option of linkgit:git-submodule[1] does.
123 The value must be always (the default), never, or auto.
126 Turn off colored diff, even when the configuration file
127 gives the default to color output.
128 Same as `--color=never`.
130 --color-words[=<regex>]::
131 Show colored word diff, i.e., color words which have changed.
132 By default, words are separated by whitespace.
134 When a <regex> is specified, every non-overlapping match of the
135 <regex> is considered a word. Anything between these matches is
136 considered whitespace and ignored(!) for the purposes of finding
137 differences. You may want to append `|[^[:space:]]` to your regular
138 expression to make sure that it matches all non-whitespace characters.
139 A match that contains a newline is silently truncated(!) at the
142 The regex can also be set via a diff driver or configuration option, see
143 linkgit:gitattributes[1] or linkgit:git-config[1]. Giving it explicitly
144 overrides any diff driver or configuration setting. Diff drivers
145 override configuration settings.
146 endif::git-format-patch[]
149 Turn off rename detection, even when the configuration
150 file gives the default to do so.
152 ifndef::git-format-patch[]
154 Warn if changes introduce trailing whitespace
155 or an indent that uses a space before a tab. Exits with
156 non-zero status if problems are found. Not compatible with
158 endif::git-format-patch[]
161 Instead of the first handful of characters, show the full
162 pre- and post-image blob object names on the "index"
163 line when generating patch format output.
166 In addition to `--full-index`, output a binary diff that
167 can be applied with `git-apply`.
170 Instead of showing the full 40-byte hexadecimal object
171 name in diff-raw format output and diff-tree header
172 lines, show only a partial prefix. This is
173 independent of the `--full-index` option above, which controls
174 the diff-patch output format. Non default number of
175 digits can be specified with `--abbrev=<n>`.
178 Break complete rewrite changes into pairs of delete and create.
184 Detect copies as well as renames. See also `--find-copies-harder`.
186 ifndef::git-format-patch[]
187 --diff-filter=[ACDMRTUXB*]::
188 Select only files that are Added (`A`), Copied (`C`),
189 Deleted (`D`), Modified (`M`), Renamed (`R`), have their
190 type (i.e. regular file, symlink, submodule, ...) changed (`T`),
191 are Unmerged (`U`), are
192 Unknown (`X`), or have had their pairing Broken (`B`).
193 Any combination of the filter characters may be used.
194 When `*` (All-or-none) is added to the combination, all
195 paths are selected if there is any file that matches
196 other criteria in the comparison; if there is no file
197 that matches other criteria, nothing is selected.
198 endif::git-format-patch[]
200 --find-copies-harder::
201 For performance reasons, by default, `-C` option finds copies only
202 if the original file of the copy was modified in the same
203 changeset. This flag makes the command
204 inspect unmodified files as candidates for the source of
205 copy. This is a very expensive operation for large
206 projects, so use it with caution. Giving more than one
207 `-C` option has the same effect.
210 The `-M` and `-C` options require O(n^2) processing time where n
211 is the number of potential rename/copy targets. This
212 option prevents rename/copy detection from running if
213 the number of rename/copy targets exceeds the specified
216 ifndef::git-format-patch[]
218 Look for differences that introduce or remove an instance of
219 <string>. Note that this is different than the string simply
220 appearing in diff output; see the 'pickaxe' entry in
221 linkgit:gitdiffcore[7] for more details.
224 When `-S` finds a change, show all the changes in that
225 changeset, not just the files that contain the change
229 Make the <string> not a plain string but an extended POSIX
231 endif::git-format-patch[]
234 Output the patch in the order specified in the
235 <orderfile>, which has one shell glob pattern per line.
237 ifndef::git-format-patch[]
239 Swap two inputs; that is, show differences from index or
240 on-disk file to tree contents.
242 --relative[=<path>]::
243 When run from a subdirectory of the project, it can be
244 told to exclude changes outside the directory and show
245 pathnames relative to it with this option. When you are
246 not in a subdirectory (e.g. in a bare repository), you
247 can name which subdirectory to make the output relative
248 to by giving a <path> as an argument.
249 endif::git-format-patch[]
253 Treat all files as text.
255 --ignore-space-at-eol::
256 Ignore changes in whitespace at EOL.
259 --ignore-space-change::
260 Ignore changes in amount of whitespace. This ignores whitespace
261 at line end, and considers all other sequences of one or
262 more whitespace characters to be equivalent.
266 Ignore whitespace when comparing lines. This ignores
267 differences even if one line has whitespace where the other
270 --inter-hunk-context=<lines>::
271 Show the context between diff hunks, up to the specified number
272 of lines, thereby fusing hunks that are close to each other.
274 ifndef::git-format-patch[]
276 Make the program exit with codes similar to diff(1).
277 That is, it exits with 1 if there were differences and
278 0 means no differences.
281 Disable all output of the program. Implies `--exit-code`.
282 endif::git-format-patch[]
285 Allow an external diff helper to be executed. If you set an
286 external diff driver with linkgit:gitattributes[5], you need
287 to use this option with linkgit:git-log[1] and friends.
290 Disallow external diff drivers.
292 --ignore-submodules::
293 Ignore changes to submodules in the diff generation.
295 --src-prefix=<prefix>::
296 Show the given source prefix instead of "a/".
298 --dst-prefix=<prefix>::
299 Show the given destination prefix instead of "b/".
302 Do not show any source or destination prefix.
304 For more detailed explanation on these common options, see also
305 linkgit:gitdiffcore[7].