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[]
17 Generate patches without diffstat.
18 endif::git-format-patch[]
20 ifndef::git-format-patch[]
23 Generate patch (see section on generating patches).
24 {git-diff? This is the default.}
25 endif::git-format-patch[]
29 Generate diffs with <n> lines of context instead of
30 the usual three. Implies "-p".
33 Generate the raw format.
34 {git-diff-core? This is the default.}
37 Synonym for "-p --raw".
40 Generate a diff using the "patience diff" algorithm.
42 --stat[=width[,name-width]]::
43 Generate a diffstat. You can override the default
44 output width for 80-column terminal by "--stat=width".
45 The width of the filename part can be controlled by
46 giving another width to it separated by a comma.
49 Similar to \--stat, but shows number of added and
50 deleted lines in decimal notation and pathname without
51 abbreviation, to make it more machine friendly. For
52 binary files, outputs two `-` instead of saying
56 Output only the last line of the --stat format containing total
57 number of modified files, as well as number of added and deleted
61 Output the distribution of relative amount of changes (number of lines added or
62 removed) for each sub-directory. Directories with changes below
63 a cut-off percent (3% by default) are not shown. The cut-off percent
64 can be set with "--dirstat=limit". Changes in a child directory is not
65 counted for the parent directory, unless "--cumulative" is used.
67 --dirstat-by-file[=limit]::
68 Same as --dirstat, but counts changed files instead of lines.
71 Output a condensed summary of extended header information
72 such as creations, renames and mode changes.
75 Synonym for "-p --stat".
76 {git-format-patch? This is the default.}
79 NUL-line termination on output. This affects the --raw
80 output field terminator. Also output from commands such
81 as "git-log" will be delimited with NUL between commits.
84 Show only names of changed files.
87 Show only names and status of changed files. See the description
88 of the `--diff-filter` option on what the status letters mean.
90 --submodule[=<format>]::
91 Specify how differences in submodules are shown. When `--submodule`
92 or `--submodule=log` is given, the 'log' format is used. This format lists
93 the commits in the range like linkgit:git-submodule[1] `summary` does.
94 Omitting the `--submodule` option or specifying `--submodule=short`,
95 uses the 'short' format. This format just shows the names of the commits
96 at the beginning and end of the range.
102 Turn off colored diff, even when the configuration file
103 gives the default to color output.
105 --color-words[=<regex>]::
106 Show colored word diff, i.e., color words which have changed.
107 By default, words are separated by whitespace.
109 When a <regex> is specified, every non-overlapping match of the
110 <regex> is considered a word. Anything between these matches is
111 considered whitespace and ignored(!) for the purposes of finding
112 differences. You may want to append `|[^[:space:]]` to your regular
113 expression to make sure that it matches all non-whitespace characters.
114 A match that contains a newline is silently truncated(!) at the
117 The regex can also be set via a diff driver or configuration option, see
118 linkgit:gitattributes[1] or linkgit:git-config[1]. Giving it explicitly
119 overrides any diff driver or configuration setting. Diff drivers
120 override configuration settings.
123 Turn off rename detection, even when the configuration
124 file gives the default to do so.
127 Warn if changes introduce trailing whitespace
128 or an indent that uses a space before a tab. Exits with
129 non-zero status if problems are found. Not compatible with
133 Instead of the first handful of characters, show the full
134 pre- and post-image blob object names on the "index"
135 line when generating patch format output.
138 In addition to --full-index, output "binary diff" that
139 can be applied with "git apply".
142 Instead of showing the full 40-byte hexadecimal object
143 name in diff-raw format output and diff-tree header
144 lines, show only a partial prefix. This is
145 independent of --full-index option above, which controls
146 the diff-patch output format. Non default number of
147 digits can be specified with --abbrev=<n>.
150 Break complete rewrite changes into pairs of delete and create.
156 Detect copies as well as renames. See also `--find-copies-harder`.
158 --diff-filter=[ACDMRTUXB*]::
159 Select only files that are Added (`A`), Copied (`C`),
160 Deleted (`D`), Modified (`M`), Renamed (`R`), have their
161 type (i.e. regular file, symlink, submodule, ...) changed (`T`),
162 are Unmerged (`U`), are
163 Unknown (`X`), or have had their pairing Broken (`B`).
164 Any combination of the filter characters may be used.
165 When `*` (All-or-none) is added to the combination, all
166 paths are selected if there is any file that matches
167 other criteria in the comparison; if there is no file
168 that matches other criteria, nothing is selected.
170 --find-copies-harder::
171 For performance reasons, by default, `-C` option finds copies only
172 if the original file of the copy was modified in the same
173 changeset. This flag makes the command
174 inspect unmodified files as candidates for the source of
175 copy. This is a very expensive operation for large
176 projects, so use it with caution. Giving more than one
177 `-C` option has the same effect.
180 -M and -C options require O(n^2) processing time where n
181 is the number of potential rename/copy targets. This
182 option prevents rename/copy detection from running if
183 the number of rename/copy targets exceeds the specified
187 Look for differences that introduce or remove an instance of
188 <string>. Note that this is different than the string simply
189 appearing in diff output; see the 'pickaxe' entry in
190 linkgit:gitdiffcore[7] for more details.
193 When -S finds a change, show all the changes in that
194 changeset, not just the files that contain the change
198 Make the <string> not a plain string but an extended POSIX
202 Output the patch in the order specified in the
203 <orderfile>, which has one shell glob pattern per line.
206 Swap two inputs; that is, show differences from index or
207 on-disk file to tree contents.
209 --relative[=<path>]::
210 When run from a subdirectory of the project, it can be
211 told to exclude changes outside the directory and show
212 pathnames relative to it with this option. When you are
213 not in a subdirectory (e.g. in a bare repository), you
214 can name which subdirectory to make the output relative
215 to by giving a <path> as an argument.
219 Treat all files as text.
221 --ignore-space-at-eol::
222 Ignore changes in whitespace at EOL.
225 --ignore-space-change::
226 Ignore changes in amount of whitespace. This ignores whitespace
227 at line end, and considers all other sequences of one or
228 more whitespace characters to be equivalent.
232 Ignore whitespace when comparing lines. This ignores
233 differences even if one line has whitespace where the other
236 --inter-hunk-context=<lines>::
237 Show the context between diff hunks, up to the specified number
238 of lines, thereby fusing hunks that are close to each other.
241 Make the program exit with codes similar to diff(1).
242 That is, it exits with 1 if there were differences and
243 0 means no differences.
246 Disable all output of the program. Implies --exit-code.
249 Allow an external diff helper to be executed. If you set an
250 external diff driver with linkgit:gitattributes[5], you need
251 to use this option with linkgit:git-log[1] and friends.
254 Disallow external diff drivers.
256 --ignore-submodules::
257 Ignore changes to submodules in the diff generation.
259 --src-prefix=<prefix>::
260 Show the given source prefix instead of "a/".
262 --dst-prefix=<prefix>::
263 Show the given destination prefix instead of "b/".
266 Do not show any source or destination prefix.
268 For more detailed explanation on these common options, see also
269 linkgit:gitdiffcore[7].