]>
Commit | Line | Data |
---|---|---|
c1a95fa6 SO |
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. | |
6 | ||
7 | ifndef::git-format-patch[] | |
8 | ifndef::git-diff[] | |
272bd3cf | 9 | ifndef::git-log[] |
c1a95fa6 | 10 | :git-diff-core: 1 |
272bd3cf | 11 | endif::git-log[] |
c1a95fa6 SO |
12 | endif::git-diff[] |
13 | endif::git-format-patch[] | |
14 | ||
15 | ifdef::git-format-patch[] | |
16 | -p:: | |
2cfa8330 | 17 | --no-stat:: |
02bc5b03 | 18 | Generate plain patches without any diffstats. |
c1a95fa6 SO |
19 | endif::git-format-patch[] |
20 | ||
21 | ifndef::git-format-patch[] | |
dda2d79a | 22 | -p:: |
a9e67c8c | 23 | -u:: |
1c9eecff | 24 | --patch:: |
c1a95fa6 | 25 | Generate patch (see section on generating patches). |
d0258b93 JK |
26 | ifdef::git-diff[] |
27 | This is the default. | |
28 | endif::git-diff[] | |
dda2d79a | 29 | |
7b02c834 MM |
30 | -s:: |
31 | --no-patch:: | |
32 | Suppress diff output. Useful for commands like `git show` that | |
33 | show the patch by default, or to cancel the effect of `--patch`. | |
b73a1bcc | 34 | endif::git-format-patch[] |
7b02c834 | 35 | |
1d24509b | 36 | ifdef::git-log[] |
db757e8b | 37 | --diff-merges=(off|none|on|first-parent|1|separate|m|combined|c|dense-combined|cc|remerge|r):: |
1d24509b SO |
38 | --no-diff-merges:: |
39 | Specify diff format to be used for merge commits. Default is | |
40 | {diff-merges-default} unless `--first-parent` is in use, in which case | |
41 | `first-parent` is the default. | |
42 | + | |
43 | --diff-merges=(off|none)::: | |
44 | --no-diff-merges::: | |
45 | Disable output of diffs for merge commits. Useful to override | |
46 | implied value. | |
47 | + | |
364bc11f SO |
48 | --diff-merges=on::: |
49 | --diff-merges=m::: | |
50 | -m::: | |
51 | This option makes diff output for merge commits to be shown in | |
6a38e333 JN |
52 | the default format. `-m` will produce the output only if `-p` |
53 | is given as well. The default format could be changed using | |
364bc11f | 54 | `log.diffMerges` configuration parameter, which default value |
6a38e333 | 55 | is `separate`. |
364bc11f | 56 | + |
1d24509b SO |
57 | --diff-merges=first-parent::: |
58 | --diff-merges=1::: | |
59 | This option makes merge commits show the full diff with | |
60 | respect to the first parent only. | |
61 | + | |
62 | --diff-merges=separate::: | |
1d24509b SO |
63 | This makes merge commits show the full diff with respect to |
64 | each of the parents. Separate log entry and diff is generated | |
6a38e333 | 65 | for each parent. |
1d24509b | 66 | + |
db757e8b EN |
67 | --diff-merges=remerge::: |
68 | --diff-merges=r::: | |
69 | --remerge-diff::: | |
70 | With this option, two-parent merge commits are remerged to | |
71 | create a temporary tree object -- potentially containing files | |
72 | with conflict markers and such. A diff is then shown between | |
73 | that temporary tree and the actual merge commit. | |
74 | + | |
75 | The output emitted when this option is used is subject to change, and | |
76 | so is its interaction with other options (unless explicitly | |
77 | documented). | |
78 | + | |
1d24509b SO |
79 | --diff-merges=combined::: |
80 | --diff-merges=c::: | |
81 | -c::: | |
82 | With this option, diff output for a merge commit shows the | |
83 | differences from each of the parents to the merge result | |
84 | simultaneously instead of showing pairwise diff between a | |
85 | parent and the result one at a time. Furthermore, it lists | |
86 | only files which were modified from all parents. `-c` implies | |
87 | `-p`. | |
88 | + | |
89 | --diff-merges=dense-combined::: | |
90 | --diff-merges=cc::: | |
91 | --cc::: | |
92 | With this option the output produced by | |
93 | `--diff-merges=combined` is further compressed by omitting | |
94 | uninteresting hunks whose contents in the parents have only | |
95 | two variants and the merge result picks one of them without | |
96 | modification. `--cc` implies `-p`. | |
97 | ||
98 | --combined-all-paths:: | |
99 | This flag causes combined diffs (used for merge commits) to | |
100 | list the name of the file from all parents. It thus only has | |
101 | effect when `--diff-merges=[dense-]combined` is in use, and | |
102 | is likely only useful if filename changes are detected (i.e. | |
103 | when either rename or copy detection have been requested). | |
104 | endif::git-log[] | |
105 | ||
4eb99473 | 106 | -U<n>:: |
4eb99473 RR |
107 | --unified=<n>:: |
108 | Generate diffs with <n> lines of context instead of | |
714d491a | 109 | the usual three. |
02bc5b03 | 110 | ifndef::git-format-patch[] |
714d491a | 111 | Implies `--patch`. |
02bc5b03 | 112 | endif::git-format-patch[] |
4eb99473 | 113 | |
af2f3680 NTND |
114 | --output=<file>:: |
115 | Output to a specific file instead of stdout. | |
116 | ||
117 | --output-indicator-new=<char>:: | |
118 | --output-indicator-old=<char>:: | |
119 | --output-indicator-context=<char>:: | |
120 | Specify the character used to indicate new, old or context | |
121 | lines in the generated patch. Normally they are '+', '-' and | |
122 | ' ' respectively. | |
123 | ||
d4cb003f | 124 | ifndef::git-format-patch[] |
b5376648 | 125 | --raw:: |
d89df367 MM |
126 | ifndef::git-log[] |
127 | Generate the diff in raw format. | |
d0258b93 JK |
128 | ifdef::git-diff-core[] |
129 | This is the default. | |
130 | endif::git-diff-core[] | |
d89df367 MM |
131 | endif::git-log[] |
132 | ifdef::git-log[] | |
133 | For each commit, show a summary of changes using the raw diff | |
134 | format. See the "RAW OUTPUT FORMAT" section of | |
135 | linkgit:git-diff[1]. This is different from showing the log | |
136 | itself in raw format, which you can achieve with | |
137 | `--format=raw`. | |
138 | endif::git-log[] | |
d4cb003f | 139 | endif::git-format-patch[] |
b5376648 | 140 | |
02bc5b03 | 141 | ifndef::git-format-patch[] |
5c91da25 | 142 | --patch-with-raw:: |
dce5ef14 | 143 | Synonym for `-p --raw`. |
02bc5b03 | 144 | endif::git-format-patch[] |
5c91da25 | 145 | |
9a6d515f JK |
146 | ifdef::git-log[] |
147 | -t:: | |
148 | Show the tree objects in the diff output. | |
149 | endif::git-log[] | |
150 | ||
bab76141 | 151 | --indent-heuristic:: |
7eedad15 | 152 | Enable the heuristic that shifts diff hunk boundaries to make patches |
bab76141 CMN |
153 | easier to read. This is the default. |
154 | ||
155 | --no-indent-heuristic:: | |
156 | Disable the indent heuristic. | |
5580b271 | 157 | |
81b568c8 JH |
158 | --minimal:: |
159 | Spend extra time to make sure the smallest possible | |
160 | diff is produced. | |
161 | ||
ec74042d | 162 | --patience:: |
34292bdd JS |
163 | Generate a diff using the "patience diff" algorithm. |
164 | ||
d909e076 TR |
165 | --histogram:: |
166 | Generate a diff using the "histogram diff" algorithm. | |
167 | ||
2477ab2e JT |
168 | --anchored=<text>:: |
169 | Generate a diff using the "anchored diff" algorithm. | |
170 | + | |
171 | This option may be specified more than once. | |
172 | + | |
173 | If a line exists in both the source and destination, exists only once, | |
174 | and starts with this text, this algorithm attempts to prevent it from | |
175 | appearing as a deletion or addition in the output. It uses the "patience | |
176 | diff" algorithm internally. | |
177 | ||
07924d4d MP |
178 | --diff-algorithm={patience|minimal|histogram|myers}:: |
179 | Choose a diff algorithm. The variants are as follows: | |
180 | + | |
181 | -- | |
182 | `default`, `myers`;; | |
183 | The basic greedy diff algorithm. Currently, this is the default. | |
184 | `minimal`;; | |
185 | Spend extra time to make sure the smallest possible diff is | |
186 | produced. | |
187 | `patience`;; | |
188 | Use "patience diff" algorithm when generating patches. | |
189 | `histogram`;; | |
190 | This algorithm extends the patience algorithm to "support | |
191 | low-occurrence common elements". | |
192 | -- | |
193 | + | |
7eedad15 | 194 | For instance, if you configured the `diff.algorithm` variable to a |
07924d4d MP |
195 | non-default value and want to use the default one, then you |
196 | have to use `--diff-algorithm=default` option. | |
197 | ||
808e1db2 | 198 | --stat[=<width>[,<name-width>[,<count>]]]:: |
1b058bc3 | 199 | Generate a diffstat. By default, as much space as necessary |
df44483a ZJS |
200 | will be used for the filename part, and the rest for the graph |
201 | part. Maximum width defaults to terminal width, or 80 columns | |
8d8136c3 | 202 | if not connected to a terminal, and can be overridden by |
df44483a ZJS |
203 | `<width>`. The width of the filename part can be limited by |
204 | giving another width `<name-width>` after a comma. The width | |
205 | of the graph part can be limited by using | |
206 | `--stat-graph-width=<width>` (affects all commands generating | |
207 | a stat graph) or by setting `diff.statGraphWidth=<width>` | |
208 | (does not affect `git format-patch`). | |
808e1db2 | 209 | By giving a third parameter `<count>`, you can limit the |
1b058bc3 ZJS |
210 | output to the first `<count>` lines, followed by `...` if |
211 | there are more. | |
86e1ce96 MG |
212 | + |
213 | These parameters can also be set individually with `--stat-width=<width>`, | |
214 | `--stat-name-width=<name-width>` and `--stat-count=<count>`. | |
d75f7952 | 215 | |
ddf88fa6 NTND |
216 | --compact-summary:: |
217 | Output a condensed summary of extended header information such | |
218 | as file creations or deletions ("new" or "gone", optionally "+l" | |
219 | if it's a symlink) and mode changes ("+x" or "-x" for adding | |
220 | or removing executable bit respectively) in diffstat. The | |
1f2abe68 | 221 | information is put between the filename part and the graph |
ddf88fa6 NTND |
222 | part. Implies `--stat`. |
223 | ||
74e2abe5 | 224 | --numstat:: |
6cf378f0 | 225 | Similar to `--stat`, but shows number of added and |
74e2abe5 | 226 | deleted lines in decimal notation and pathname without |
2f89543e JH |
227 | abbreviation, to make it more machine friendly. For |
228 | binary files, outputs two `-` instead of saying | |
229 | `0 0`. | |
74e2abe5 | 230 | |
ebd124c6 | 231 | --shortstat:: |
dce5ef14 | 232 | Output only the last line of the `--stat` format containing total |
ebd124c6 NP |
233 | number of modified files, as well as number of added and deleted |
234 | lines. | |
235 | ||
4ce7aab5 | 236 | -X[<param1,param2,...>]:: |
333f3fb0 JH |
237 | --dirstat[=<param1,param2,...>]:: |
238 | Output the distribution of relative amount of changes for each | |
239 | sub-directory. The behavior of `--dirstat` can be customized by | |
240 | passing it a comma separated list of parameters. | |
2d174951 JH |
241 | The defaults are controlled by the `diff.dirstat` configuration |
242 | variable (see linkgit:git-config[1]). | |
333f3fb0 | 243 | The following parameters are available: |
204f01a2 | 244 | + |
333f3fb0 JH |
245 | -- |
246 | `changes`;; | |
247 | Compute the dirstat numbers by counting the lines that have been | |
248 | removed from the source, or added to the destination. This ignores | |
249 | the amount of pure code movements within a file. In other words, | |
250 | rearranging lines in a file is not counted as much as other changes. | |
251 | This is the default behavior when no parameter is given. | |
1c57a627 JH |
252 | `lines`;; |
253 | Compute the dirstat numbers by doing the regular line-based diff | |
254 | analysis, and summing the removed/added line counts. (For binary | |
255 | files, count 64-byte chunks instead, since binary files have no | |
256 | natural concept of lines). This is a more expensive `--dirstat` | |
257 | behavior than the `changes` behavior, but it does count rearranged | |
258 | lines within a file as much as other changes. The resulting output | |
259 | is consistent with what you get from the other `--*stat` options. | |
333f3fb0 JH |
260 | `files`;; |
261 | Compute the dirstat numbers by counting the number of files changed. | |
262 | Each changed file counts equally in the dirstat analysis. This is | |
263 | the computationally cheapest `--dirstat` behavior, since it does | |
264 | not have to look at the file contents at all. | |
265 | `cumulative`;; | |
266 | Count changes in a child directory for the parent directory as well. | |
267 | Note that when using `cumulative`, the sum of the percentages | |
268 | reported may exceed 100%. The default (non-cumulative) behavior can | |
269 | be specified with the `noncumulative` parameter. | |
270 | <limit>;; | |
271 | An integer parameter specifies a cut-off percent (3% by default). | |
272 | Directories contributing less than this percentage of the changes | |
273 | are not shown in the output. | |
274 | -- | |
275 | + | |
276 | Example: The following will count changed files, while ignoring | |
277 | directories with less than 10% of the total amount of changed files, | |
278 | and accumulating child directory counts in the parent directories: | |
279 | `--dirstat=files,10,cumulative`. | |
fd33777b | 280 | |
4ce7aab5 NTND |
281 | --cumulative:: |
282 | Synonym for --dirstat=cumulative | |
283 | ||
284 | --dirstat-by-file[=<param1,param2>...]:: | |
285 | Synonym for --dirstat=files,param1,param2... | |
286 | ||
4bbd261b SE |
287 | --summary:: |
288 | Output a condensed summary of extended header information | |
289 | such as creations, renames and mode changes. | |
290 | ||
02bc5b03 | 291 | ifndef::git-format-patch[] |
29353273 | 292 | --patch-with-stat:: |
dce5ef14 | 293 | Synonym for `-p --stat`. |
02bc5b03 | 294 | endif::git-format-patch[] |
29353273 | 295 | |
d4cb003f | 296 | ifndef::git-format-patch[] |
64485b4a | 297 | |
dda2d79a | 298 | -z:: |
5c931c8d BG |
299 | ifdef::git-log[] |
300 | Separate the commits with NULs instead of with new newlines. | |
301 | + | |
302 | Also, when `--raw` or `--numstat` has been given, do not munge | |
303 | pathnames and use NULs as output field terminators. | |
304 | endif::git-log[] | |
64485b4a | 305 | ifndef::git-log[] |
03aa87ed CB |
306 | When `--raw`, `--numstat`, `--name-only` or `--name-status` has been |
307 | given, do not munge pathnames and use NULs as output field terminators. | |
5c931c8d | 308 | endif::git-log[] |
64485b4a | 309 | + |
860cd699 AH |
310 | Without this option, pathnames with "unusual" characters are quoted as |
311 | explained for the configuration variable `core.quotePath` (see | |
312 | linkgit:git-config[1]). | |
dda2d79a JH |
313 | |
314 | --name-only:: | |
9364bf46 AB |
315 | Show only names of changed files. The file names are often encoded in UTF-8. |
316 | For more information see the discussion about encoding in the linkgit:git-log[1] | |
317 | manual page. | |
dda2d79a | 318 | |
946f5f7c | 319 | --name-status:: |
a6f47b2b MV |
320 | Show only names and status of changed files. See the description |
321 | of the `--diff-filter` option on what the status letters mean. | |
9364bf46 | 322 | Just like `--name-only` the file names are often encoded in UTF-8. |
dda2d79a | 323 | |
752c0c24 | 324 | --submodule[=<format>]:: |
fd47ae6a JK |
325 | Specify how differences in submodules are shown. When specifying |
326 | `--submodule=short` the 'short' format is used. This format just | |
327 | shows the names of the commits at the beginning and end of the range. | |
328 | When `--submodule` or `--submodule=log` is specified, the 'log' | |
329 | format is used. This format lists the commits in the range like | |
330 | linkgit:git-submodule[1] `summary` does. When `--submodule=diff` | |
331 | is specified, the 'diff' format is used. This format shows an | |
332 | inline diff of the changes in the submodule contents between the | |
333 | commit range. Defaults to `diff.submodule` or the 'short' format | |
334 | if the config option is unset. | |
752c0c24 | 335 | |
73e9da01 | 336 | --color[=<when>]:: |
b5376648 | 337 | Show colored diff. |
3d0e75f2 JH |
338 | `--color` (i.e. without '=<when>') is the same as `--color=always`. |
339 | '<when>' can be one of `always`, `never`, or `auto`. | |
6999c540 MG |
340 | ifdef::git-diff[] |
341 | It can be changed by the `color.ui` and `color.diff` | |
342 | configuration settings. | |
343 | endif::git-diff[] | |
b5376648 JH |
344 | |
345 | --no-color:: | |
6999c540 MG |
346 | Turn off colored diff. |
347 | ifdef::git-diff[] | |
348 | This can be used to override configuration settings. | |
349 | endif::git-diff[] | |
350 | It is the same as `--color=never`. | |
b5376648 | 351 | |
61e89eaa SB |
352 | --color-moved[=<mode>]:: |
353 | Moved lines of code are colored differently. | |
354 | ifdef::git-diff[] | |
355 | It can be changed by the `diff.colorMoved` configuration setting. | |
356 | endif::git-diff[] | |
357 | The <mode> defaults to 'no' if the option is not given | |
358 | and to 'zebra' if the option with no mode is given. | |
359 | The mode must be one of: | |
360 | + | |
361 | -- | |
362 | no:: | |
363 | Moved lines are not highlighted. | |
364 | default:: | |
365 | Is a synonym for `zebra`. This may change to a more sensible mode | |
366 | in the future. | |
367 | plain:: | |
368 | Any line that is added in one location and was removed | |
369 | in another location will be colored with 'color.diff.newMoved'. | |
370 | Similarly 'color.diff.oldMoved' will be used for removed lines | |
371 | that are added somewhere else in the diff. This mode picks up any | |
372 | moved line, but it is not very useful in a review to determine | |
373 | if a block of code was moved without permutation. | |
51da15eb | 374 | blocks:: |
f0b8fb6e JT |
375 | Blocks of moved text of at least 20 alphanumeric characters |
376 | are detected greedily. The detected blocks are | |
51da15eb SB |
377 | painted using either the 'color.diff.{old,new}Moved' color. |
378 | Adjacent blocks cannot be told apart. | |
379 | zebra:: | |
380 | Blocks of moved text are detected as in 'blocks' mode. The blocks | |
381 | are painted using either the 'color.diff.{old,new}Moved' color or | |
61e89eaa | 382 | 'color.diff.{old,new}MovedAlternative'. The change between |
f0b8fb6e | 383 | the two colors indicates that a new block was detected. |
e3f2f5f9 | 384 | dimmed-zebra:: |
61e89eaa SB |
385 | Similar to 'zebra', but additional dimming of uninteresting parts |
386 | of moved code is performed. The bordering lines of two adjacent | |
387 | blocks are considered interesting, the rest is uninteresting. | |
e3f2f5f9 | 388 | `dimmed_zebra` is a deprecated synonym. |
61e89eaa SB |
389 | -- |
390 | ||
fbafb7c6 PW |
391 | --no-color-moved:: |
392 | Turn off move detection. This can be used to override configuration | |
393 | settings. It is the same as `--color-moved=no`. | |
394 | ||
b3095712 | 395 | --color-moved-ws=<modes>:: |
748aa1aa | 396 | This configures how whitespace is ignored when performing the |
626c0b5d SB |
397 | move detection for `--color-moved`. |
398 | ifdef::git-diff[] | |
399 | It can be set by the `diff.colorMovedWS` configuration setting. | |
400 | endif::git-diff[] | |
401 | These modes can be given as a comma separated list: | |
b3095712 SB |
402 | + |
403 | -- | |
b73bcbac PW |
404 | no:: |
405 | Do not ignore whitespace when performing move detection. | |
b3095712 SB |
406 | ignore-space-at-eol:: |
407 | Ignore changes in whitespace at EOL. | |
408 | ignore-space-change:: | |
409 | Ignore changes in amount of whitespace. This ignores whitespace | |
410 | at line end, and considers all other sequences of one or | |
411 | more whitespace characters to be equivalent. | |
412 | ignore-all-space:: | |
413 | Ignore whitespace when comparing lines. This ignores differences | |
414 | even if one line has whitespace where the other line has none. | |
ca1f4ae4 | 415 | allow-indentation-change:: |
748aa1aa | 416 | Initially ignore any whitespace in the move detection, then |
ca1f4ae4 SB |
417 | group the moved code blocks only into a block if the change in |
418 | whitespace is the same per line. This is incompatible with the | |
419 | other modes. | |
b3095712 SB |
420 | -- |
421 | ||
b73bcbac PW |
422 | --no-color-moved-ws:: |
423 | Do not ignore whitespace when performing move detection. This can be | |
424 | used to override configuration settings. It is the same as | |
425 | `--color-moved-ws=no`. | |
426 | ||
882749a0 TR |
427 | --word-diff[=<mode>]:: |
428 | Show a word diff, using the <mode> to delimit changed words. | |
429 | By default, words are delimited by whitespace; see | |
430 | `--word-diff-regex` below. The <mode> defaults to 'plain', and | |
431 | must be one of: | |
432 | + | |
433 | -- | |
434 | color:: | |
435 | Highlight changed words using only colors. Implies `--color`. | |
436 | plain:: | |
437 | Show words as `[-removed-]` and `{+added+}`. Makes no | |
438 | attempts to escape the delimiters if they appear in the input, | |
439 | so the output may be ambiguous. | |
440 | porcelain:: | |
441 | Use a special line-based format intended for script | |
442 | consumption. Added/removed/unchanged runs are printed in the | |
443 | usual unified diff format, starting with a `+`/`-`/` ` | |
444 | character at the beginning of the line and extending to the | |
445 | end of the line. Newlines in the input are represented by a | |
446 | tilde `~` on a line of its own. | |
447 | none:: | |
448 | Disable word diff again. | |
449 | -- | |
450 | + | |
451 | Note that despite the name of the first mode, color is used to | |
452 | highlight the changed parts in all modes if enabled. | |
453 | ||
454 | --word-diff-regex=<regex>:: | |
455 | Use <regex> to decide what a word is, instead of considering | |
456 | runs of non-whitespace to be a word. Also implies | |
457 | `--word-diff` unless it was already enabled. | |
2b6a5417 | 458 | + |
882749a0 | 459 | Every non-overlapping match of the |
c4b252c3 TR |
460 | <regex> is considered a word. Anything between these matches is |
461 | considered whitespace and ignored(!) for the purposes of finding | |
462 | differences. You may want to append `|[^[:space:]]` to your regular | |
463 | expression to make sure that it matches all non-whitespace characters. | |
464 | A match that contains a newline is silently truncated(!) at the | |
465 | newline. | |
80c49c3d | 466 | + |
2c15c006 MG |
467 | For example, `--word-diff-regex=.` will treat each character as a word |
468 | and, correspondingly, show differences character by character. | |
469 | + | |
98a4d87b | 470 | The regex can also be set via a diff driver or configuration option, see |
1cca17df | 471 | linkgit:gitattributes[5] or linkgit:git-config[1]. Giving it explicitly |
98a4d87b BSSJ |
472 | overrides any diff driver or configuration setting. Diff drivers |
473 | override configuration settings. | |
882749a0 TR |
474 | |
475 | --color-words[=<regex>]:: | |
476 | Equivalent to `--word-diff=color` plus (if a regex was | |
477 | specified) `--word-diff-regex=<regex>`. | |
d4cb003f | 478 | endif::git-format-patch[] |
f59a59e2 | 479 | |
b5376648 JH |
480 | --no-renames:: |
481 | Turn off rename detection, even when the configuration | |
482 | file gives the default to do so. | |
483 | ||
cdc43eb0 NTND |
484 | --[no-]rename-empty:: |
485 | Whether to use empty blobs as rename source. | |
486 | ||
02bc5b03 | 487 | ifndef::git-format-patch[] |
16507fcf | 488 | --check:: |
30211fb6 OA |
489 | Warn if changes introduce conflict markers or whitespace errors. |
490 | What are considered whitespace errors is controlled by `core.whitespace` | |
4f830390 | 491 | configuration. By default, trailing whitespaces (including |
7eedad15 | 492 | lines that consist solely of whitespaces) and a space character |
4f830390 CK |
493 | that is immediately followed by a tab character inside the |
494 | initial indent of the line are considered whitespace errors. | |
495 | Exits with non-zero status if problems are found. Not compatible | |
496 | with --exit-code. | |
b8767f79 JH |
497 | |
498 | --ws-error-highlight=<kind>:: | |
c0bb6d9c AH |
499 | Highlight whitespace errors in the `context`, `old` or `new` |
500 | lines of the diff. Multiple values are separated by comma, | |
501 | `none` resets previous values, `default` reset the list to | |
502 | `new` and `all` is a shorthand for `old,new,context`. When | |
503 | this option is not given, and the configuration variable | |
504 | `diff.wsErrorHighlight` is not set, only whitespace errors in | |
505 | `new` lines are highlighted. The whitespace errors are colored | |
7eedad15 | 506 | with `color.diff.whitespace`. |
b8767f79 | 507 | |
02bc5b03 | 508 | endif::git-format-patch[] |
16507fcf | 509 | |
80b1e511 | 510 | --full-index:: |
6457e58c JM |
511 | Instead of the first handful of characters, show the full |
512 | pre- and post-image blob object names on the "index" | |
513 | line when generating patch format output. | |
b5376648 JH |
514 | |
515 | --binary:: | |
dce5ef14 | 516 | In addition to `--full-index`, output a binary diff that |
714d491a SO |
517 | can be applied with `git-apply`. |
518 | ifndef::git-format-patch[] | |
519 | Implies `--patch`. | |
520 | endif::git-format-patch[] | |
80b1e511 | 521 | |
913419fc | 522 | --abbrev[=<n>]:: |
47dd0d59 JH |
523 | Instead of showing the full 40-byte hexadecimal object |
524 | name in diff-raw format output and diff-tree header | |
cda34e0d JH |
525 | lines, show the shortest prefix that is at least '<n>' |
526 | hexdigits long that uniquely refers the object. | |
3046c7f6 ĐTCD |
527 | In diff-patch output format, `--full-index` takes higher |
528 | precedence, i.e. if `--full-index` is specified, full blob | |
529 | names will be shown regardless of `--abbrev`. | |
530 | Non default number of digits can be specified with `--abbrev=<n>`. | |
47dd0d59 | 531 | |
cf958afd | 532 | -B[<n>][/<m>]:: |
37ab5156 | 533 | --break-rewrites[=[<n>][/<m>]]:: |
cf958afd MM |
534 | Break complete rewrite changes into pairs of delete and |
535 | create. This serves two purposes: | |
536 | + | |
537 | It affects the way a change that amounts to a total rewrite of a file | |
538 | not as a series of deletion and insertion mixed together with a very | |
539 | few lines that happen to match textually as the context, but as a | |
540 | single deletion of everything old followed by a single insertion of | |
541 | everything new, and the number `m` controls this aspect of the -B | |
542 | option (defaults to 60%). `-B/70%` specifies that less than 30% of the | |
2de9b711 | 543 | original should remain in the result for Git to consider it a total |
cf958afd MM |
544 | rewrite (i.e. otherwise the resulting patch will be a series of |
545 | deletion and insertion mixed together with context lines). | |
546 | + | |
547 | When used with -M, a totally-rewritten file is also considered as the | |
548 | source of a rename (usually -M only considers a file that disappeared | |
549 | as the source of a rename), and the number `n` controls this aspect of | |
550 | the -B option (defaults to 50%). `-B20%` specifies that a change with | |
551 | addition and deletion compared to 20% or more of the file's size are | |
552 | eligible for being picked up as a possible source of a rename to | |
553 | another file. | |
554 | ||
555 | -M[<n>]:: | |
f611ddc7 | 556 | --find-renames[=<n>]:: |
7ffad250 | 557 | ifndef::git-log[] |
dda2d79a | 558 | Detect renames. |
7ffad250 JK |
559 | endif::git-log[] |
560 | ifdef::git-log[] | |
561 | If generating diffs, detect and report renames for each commit. | |
562 | For following files across renames while traversing history, see | |
563 | `--follow`. | |
564 | endif::git-log[] | |
4c007ae8 | 565 | If `n` is specified, it is a threshold on the similarity |
cf958afd | 566 | index (i.e. amount of addition/deletions compared to the |
2de9b711 | 567 | file's size). For example, `-M90%` means Git should consider a |
cf958afd | 568 | delete/add pair to be a rename if more than 90% of the file |
31d66aa4 SC |
569 | hasn't changed. Without a `%` sign, the number is to be read as |
570 | a fraction, with a decimal point before it. I.e., `-M5` becomes | |
571 | 0.5, and is thus the same as `-M50%`. Similarly, `-M05` is | |
572 | the same as `-M5%`. To limit detection to exact renames, use | |
8240943b | 573 | `-M100%`. The default similarity index is 50%. |
dda2d79a | 574 | |
cf958afd | 575 | -C[<n>]:: |
f611ddc7 | 576 | --find-copies[=<n>]:: |
ca6c0970 | 577 | Detect copies as well as renames. See also `--find-copies-harder`. |
cf958afd | 578 | If `n` is specified, it has the same meaning as for `-M<n>`. |
dda2d79a JH |
579 | |
580 | --find-copies-harder:: | |
ca6c0970 | 581 | For performance reasons, by default, `-C` option finds copies only |
a6080a0a | 582 | if the original file of the copy was modified in the same |
f73ae1fc | 583 | changeset. This flag makes the command |
dda2d79a JH |
584 | inspect unmodified files as candidates for the source of |
585 | copy. This is a very expensive operation for large | |
ca6c0970 JS |
586 | projects, so use it with caution. Giving more than one |
587 | `-C` option has the same effect. | |
dda2d79a | 588 | |
467ddc14 JH |
589 | -D:: |
590 | --irreversible-delete:: | |
591 | Omit the preimage for deletes, i.e. print only the header but not | |
592 | the diff between the preimage and `/dev/null`. The resulting patch | |
a58088ab | 593 | is not meant to be applied with `patch` or `git apply`; this is |
467ddc14 | 594 | solely for people who want to just concentrate on reviewing the |
bc9b7e20 | 595 | text after the change. In addition, the output obviously lacks |
467ddc14 JH |
596 | enough information to apply such a patch in reverse, even manually, |
597 | hence the name of the option. | |
598 | + | |
599 | When used together with `-B`, omit also the preimage in the deletion part | |
600 | of a delete/create pair. | |
601 | ||
8082d8d3 | 602 | -l<num>:: |
6623a528 EN |
603 | The `-M` and `-C` options involve some preliminary steps that |
604 | can detect subsets of renames/copies cheaply, followed by an | |
605 | exhaustive fallback portion that compares all remaining | |
606 | unpaired destinations to all relevant sources. (For renames, | |
607 | only remaining unpaired sources are relevant; for copies, all | |
608 | original sources are relevant.) For N sources and | |
609 | destinations, this exhaustive check is O(N^2). This option | |
610 | prevents the exhaustive portion of rename/copy detection from | |
611 | running if the number of source/destination files involved | |
612 | exceeds the specified number. Defaults to diff.renameLimit. | |
9dd29dbe | 613 | Note that a value of 0 is treated as unlimited. |
8082d8d3 | 614 | |
d4cb003f | 615 | ifndef::git-format-patch[] |
f1037448 YD |
616 | --diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]:: |
617 | Select only files that are Added (`A`), Copied (`C`), | |
618 | Deleted (`D`), Modified (`M`), Renamed (`R`), have their | |
619 | type (i.e. regular file, symlink, submodule, ...) changed (`T`), | |
620 | are Unmerged (`U`), are | |
621 | Unknown (`X`), or have had their pairing Broken (`B`). | |
622 | Any combination of the filter characters (including none) can be used. | |
623 | When `*` (All-or-none) is added to the combination, all | |
624 | paths are selected if there is any file that matches | |
625 | other criteria in the comparison; if there is no file | |
626 | that matches other criteria, nothing is selected. | |
16726cfa JH |
627 | + |
628 | Also, these upper-case letters can be downcased to exclude. E.g. | |
629 | `--diff-filter=ad` excludes added and deleted paths. | |
46af107b | 630 | + |
d843e319 JS |
631 | Note that not all diffs can feature all types. For instance, copied and |
632 | renamed entries cannot appear if detection for those types is disabled. | |
f1037448 | 633 | |
dda2d79a | 634 | -S<string>:: |
5bc3f0b5 RR |
635 | Look for differences that change the number of occurrences of |
636 | the specified string (i.e. addition/deletion) in a file. | |
637 | Intended for the scripter's use. | |
638 | + | |
639 | It is useful when you're looking for an exact block of code (like a | |
640 | struct), and want to know the history of that block since it first | |
641 | came into being: use the feature iteratively to feed the interesting | |
642 | block in the preimage back into `-S`, and keep going until you get the | |
643 | very first version of the block. | |
e0e7cb80 TB |
644 | + |
645 | Binary files are searched as well. | |
dda2d79a | 646 | |
f506b8e8 | 647 | -G<regex>:: |
5bc3f0b5 RR |
648 | Look for differences whose patch text contains added/removed |
649 | lines that match <regex>. | |
650 | + | |
651 | To illustrate the difference between `-S<regex> --pickaxe-regex` and | |
652 | `-G<regex>`, consider a commit with the following diff in the same | |
653 | file: | |
654 | + | |
655 | ---- | |
9299f849 | 656 | + return frotz(nitfol, two->ptr, 1, 0); |
5bc3f0b5 | 657 | ... |
9299f849 | 658 | - hit = frotz(nitfol, mf2.ptr, 1, 0); |
5bc3f0b5 RR |
659 | ---- |
660 | + | |
9299f849 MÅ |
661 | While `git log -G"frotz\(nitfol"` will show this commit, `git log |
662 | -S"frotz\(nitfol" --pickaxe-regex` will not (because the number of | |
5bc3f0b5 RR |
663 | occurrences of that string did not change). |
664 | + | |
e0e7cb80 TB |
665 | Unless `--text` is supplied patches of binary files without a textconv |
666 | filter will be ignored. | |
667 | + | |
5bc3f0b5 RR |
668 | See the 'pickaxe' entry in linkgit:gitdiffcore[7] for more |
669 | information. | |
f506b8e8 | 670 | |
15af58c1 SB |
671 | --find-object=<object-id>:: |
672 | Look for differences that change the number of occurrences of | |
673 | the specified object. Similar to `-S`, just the argument is different | |
674 | in that it doesn't search for a specific string but for a specific | |
675 | object id. | |
676 | + | |
677 | The object can be a blob or a submodule commit. It implies the `-t` option in | |
678 | `git-log` to also find trees. | |
679 | ||
dda2d79a | 680 | --pickaxe-all:: |
f506b8e8 | 681 | When `-S` or `-G` finds a change, show all the changes in that |
f73ae1fc | 682 | changeset, not just the files that contain the change |
dda2d79a JH |
683 | in <string>. |
684 | ||
d01d8c67 | 685 | --pickaxe-regex:: |
5bc3f0b5 RR |
686 | Treat the <string> given to `-S` as an extended POSIX regular |
687 | expression to match. | |
15af58c1 | 688 | |
d4cb003f | 689 | endif::git-format-patch[] |
d01d8c67 | 690 | |
dda2d79a | 691 | -O<orderfile>:: |
874444b7 | 692 | Control the order in which files appear in the output. |
da0005b8 NTND |
693 | This overrides the `diff.orderFile` configuration variable |
694 | (see linkgit:git-config[1]). To cancel `diff.orderFile`, | |
6d8940b5 | 695 | use `-O/dev/null`. |
874444b7 RH |
696 | + |
697 | The output order is determined by the order of glob patterns in | |
698 | <orderfile>. | |
699 | All files with pathnames that match the first pattern are output | |
700 | first, all files with pathnames that match the second pattern (but not | |
701 | the first) are output next, and so on. | |
702 | All files with pathnames that do not match any pattern are output | |
703 | last, as if there was an implicit match-all pattern at the end of the | |
704 | file. | |
705 | If multiple pathnames have the same rank (they match the same pattern | |
706 | but no earlier patterns), their output order relative to each other is | |
707 | the normal order. | |
708 | + | |
709 | <orderfile> is parsed as follows: | |
710 | + | |
711 | -- | |
712 | - Blank lines are ignored, so they can be used as separators for | |
713 | readability. | |
714 | ||
715 | - Lines starting with a hash ("`#`") are ignored, so they can be used | |
716 | for comments. Add a backslash ("`\`") to the beginning of the | |
717 | pattern if it starts with a hash. | |
718 | ||
719 | - Each other line contains a single pattern. | |
720 | -- | |
721 | + | |
722 | Patterns have the same syntax and semantics as patterns used for | |
c30d4f1b | 723 | fnmatch(3) without the FNM_PATHNAME flag, except a pathname also |
874444b7 RH |
724 | matches a pattern if removing any number of the final pathname |
725 | components matches the pattern. For example, the pattern "`foo*bar`" | |
726 | matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`". | |
dda2d79a | 727 | |
1eb4136a JH |
728 | --skip-to=<file>:: |
729 | --rotate-to=<file>:: | |
730 | Discard the files before the named <file> from the output | |
731 | (i.e. 'skip to'), or move them to the end of the output | |
732 | (i.e. 'rotate to'). These were invented primarily for use | |
733 | of the `git difftool` command, and may not be very useful | |
734 | otherwise. | |
735 | ||
d4cb003f | 736 | ifndef::git-format-patch[] |
dda2d79a | 737 | -R:: |
5f3aa197 | 738 | Swap two inputs; that is, show differences from index or |
dda2d79a | 739 | on-disk file to tree contents. |
c28ded83 | 740 | endif::git-format-patch[] |
dda2d79a | 741 | |
c0cb4a06 | 742 | --relative[=<path>]:: |
c28ded83 | 743 | --no-relative:: |
cd676a51 JH |
744 | When run from a subdirectory of the project, it can be |
745 | told to exclude changes outside the directory and show | |
c0cb4a06 JH |
746 | pathnames relative to it with this option. When you are |
747 | not in a subdirectory (e.g. in a bare repository), you | |
748 | can name which subdirectory to make the output relative | |
749 | to by giving a <path> as an argument. | |
c28ded83 LA |
750 | `--no-relative` can be used to countermand both `diff.relative` config |
751 | option and previous `--relative`. | |
cd676a51 | 752 | |
a9e67c8c | 753 | -a:: |
d507bb15 SF |
754 | --text:: |
755 | Treat all files as text. | |
756 | ||
e9282f02 | 757 | --ignore-cr-at-eol:: |
c30d4f1b | 758 | Ignore carriage-return at the end of line when doing a comparison. |
e9282f02 | 759 | |
a44a0c99 | 760 | --ignore-space-at-eol:: |
0ac7903e | 761 | Ignore changes in whitespace at EOL. |
a44a0c99 | 762 | |
a9e67c8c | 763 | -b:: |
8ebe185b | 764 | --ignore-space-change:: |
0ac7903e WC |
765 | Ignore changes in amount of whitespace. This ignores whitespace |
766 | at line end, and considers all other sequences of one or | |
767 | more whitespace characters to be equivalent. | |
8ebe185b | 768 | |
a9e67c8c | 769 | -w:: |
8ebe185b | 770 | --ignore-all-space:: |
0ac7903e WC |
771 | Ignore whitespace when comparing lines. This ignores |
772 | differences even if one line has whitespace where the other | |
8ebe185b JN |
773 | line has none. |
774 | ||
36617af7 AP |
775 | --ignore-blank-lines:: |
776 | Ignore changes whose lines are all blank. | |
777 | ||
296d4a94 MK |
778 | -I<regex>:: |
779 | --ignore-matching-lines=<regex>:: | |
780 | Ignore changes whose all lines match <regex>. This option may | |
781 | be specified more than once. | |
782 | ||
6d0e674a RS |
783 | --inter-hunk-context=<lines>:: |
784 | Show the context between diff hunks, up to the specified number | |
785 | of lines, thereby fusing hunks that are close to each other. | |
c4888677 VN |
786 | Defaults to `diff.interHunkContext` or 0 if the config option |
787 | is unset. | |
6d0e674a | 788 | |
14937c2c RS |
789 | -W:: |
790 | --function-context:: | |
0cce88f1 PB |
791 | Show whole function as context lines for each change. |
792 | The function names are determined in the same way as | |
793 | `git diff` works out patch hunk headers (see 'Defining a | |
794 | custom hunk-header' in linkgit:gitattributes[5]). | |
14937c2c | 795 | |
d4cb003f | 796 | ifndef::git-format-patch[] |
939ca96b | 797 | ifndef::git-log[] |
41bbf9d5 AR |
798 | --exit-code:: |
799 | Make the program exit with codes similar to diff(1). | |
800 | That is, it exits with 1 if there were differences and | |
801 | 0 means no differences. | |
802 | ||
2a18c266 | 803 | --quiet:: |
dce5ef14 | 804 | Disable all output of the program. Implies `--exit-code`. |
939ca96b | 805 | endif::git-log[] |
d4cb003f | 806 | endif::git-format-patch[] |
2a18c266 | 807 | |
72909bef JS |
808 | --ext-diff:: |
809 | Allow an external diff helper to be executed. If you set an | |
5162e697 DM |
810 | external diff driver with linkgit:gitattributes[5], you need |
811 | to use this option with linkgit:git-log[1] and friends. | |
72909bef JS |
812 | |
813 | --no-ext-diff:: | |
814 | Disallow external diff drivers. | |
815 | ||
d28790dc JK |
816 | --textconv:: |
817 | --no-textconv:: | |
818 | Allow (or disallow) external text conversion filters to be run | |
819 | when comparing binary files. See linkgit:gitattributes[5] for | |
820 | details. Because textconv filters are typically a one-way | |
821 | conversion, the resulting diff is suitable for human | |
822 | consumption, but cannot be applied. For this reason, textconv | |
823 | filters are enabled by default only for linkgit:git-diff[1] and | |
824 | linkgit:git-log[1], but not for linkgit:git-format-patch[1] or | |
825 | diff plumbing commands. | |
826 | ||
dd44d419 JL |
827 | --ignore-submodules[=<when>]:: |
828 | Ignore changes to submodules in the diff generation. <when> can be | |
b1d04bfc | 829 | either "none", "untracked", "dirty" or "all", which is the default. |
aee9c7d6 JL |
830 | Using "none" will consider the submodule modified when it either contains |
831 | untracked or modified files or its HEAD differs from the commit recorded | |
832 | in the superproject and can be used to override any settings of the | |
302ad7a9 | 833 | 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When |
dd44d419 JL |
834 | "untracked" is used submodules are not considered dirty when they only |
835 | contain untracked content (but they are still scanned for modified | |
836 | content). Using "dirty" ignores all changes to the work tree of submodules, | |
837 | only changes to the commits stored in the superproject are shown (this was | |
838 | the behavior until 1.7.0). Using "all" hides all changes to submodules. | |
50fd9bd8 | 839 | |
eab9a40b JS |
840 | --src-prefix=<prefix>:: |
841 | Show the given source prefix instead of "a/". | |
842 | ||
843 | --dst-prefix=<prefix>:: | |
844 | Show the given destination prefix instead of "b/". | |
845 | ||
846 | --no-prefix:: | |
847 | Do not show any source or destination prefix. | |
848 | ||
660e113c JK |
849 | --line-prefix=<prefix>:: |
850 | Prepend an additional prefix to every line of output. | |
851 | ||
b42b4519 NTND |
852 | --ita-invisible-in-index:: |
853 | By default entries added by "git add -N" appear as an existing | |
854 | empty file in "git diff" and a new file in "git diff --cached". | |
855 | This option makes the entry appear as a new file in "git diff" | |
856 | and non-existent in "git diff --cached". This option could be | |
857 | reverted with `--ita-visible-in-index`. Both options are | |
858 | experimental and could be removed in future. | |
859 | ||
8db9307c | 860 | For more detailed explanation on these common options, see also |
6998e4db | 861 | linkgit:gitdiffcore[7]. |