blob: cd0b81adbb69d1586b0c45a0168aa3ac2ef15303 [file] [log] [blame]
Sergei Organovc1a95fa2007-11-15 16:19:29 +03001// 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
7ifndef::git-format-patch[]
8ifndef::git-diff[]
Miklos Vajna272bd3c2007-11-01 15:57:40 +01009ifndef::git-log[]
Sergei Organovc1a95fa2007-11-15 16:19:29 +030010:git-diff-core: 1
Miklos Vajna272bd3c2007-11-01 15:57:40 +010011endif::git-log[]
Sergei Organovc1a95fa2007-11-15 16:19:29 +030012endif::git-diff[]
13endif::git-format-patch[]
14
15ifdef::git-format-patch[]
Junio C Hamanodda2d792005-07-13 12:52:35 -070016-p::
Björn Gustavsson2cfa8332009-11-07 10:58:55 +010017--no-stat::
Björn Gustavsson02bc5b02009-11-07 10:51:56 +010018 Generate plain patches without any diffstats.
Sergei Organovc1a95fa2007-11-15 16:19:29 +030019endif::git-format-patch[]
20
21ifndef::git-format-patch[]
22-p::
jidanni@jidanni.orga9e67c82008-12-29 15:03:17 +080023-u::
Will Palmer1c9eecf2010-05-13 09:59:00 +010024--patch::
Sergey Organov11422f22023-09-06 10:15:07 +030025 Generate patch (see <<generate_patch_text_with_p>>).
Jeff Kingd0258b92015-05-14 00:34:48 -040026ifdef::git-diff[]
27 This is the default.
28endif::git-diff[]
Junio C Hamanodda2d792005-07-13 12:52:35 -070029
Matthieu Moy7b02c832013-07-16 10:05:39 +020030-s::
31--no-patch::
Junio C Hamano9d484b92023-05-05 09:59:52 -070032 Suppress all output from the diff machinery. Useful for
33 commands like `git show` that show the patch by default to
34 squelch their output, or to cancel the effect of options like
35 `--patch`, `--stat` earlier on the command line in an alias.
36
Eric Sunshineb73a1bc2016-03-27 17:26:07 -040037endif::git-format-patch[]
Matthieu Moy7b02c832013-07-16 10:05:39 +020038
Sergey Organov1d245092020-12-21 18:19:59 +030039ifdef::git-log[]
Sergey Organovbe3820c2023-10-09 19:05:33 +030040-m::
41 Show diffs for merge commits in the default format. This is
42 similar to '--diff-merges=on', except `-m` will
43 produce no output unless `-p` is given as well.
44
45-c::
46 Produce combined diff output for merge commits.
47 Shortcut for '--diff-merges=combined -p'.
48
49--cc::
50 Produce dense combined diff output for merge commits.
51 Shortcut for '--diff-merges=dense-combined -p'.
52
Sergey Organovc8e5cb02023-10-09 19:05:34 +030053--dd::
54 Produce diff with respect to first parent for both merge and
55 regular commits.
56 Shortcut for '--diff-merges=first-parent -p'.
57
Sergey Organovbe3820c2023-10-09 19:05:33 +030058--remerge-diff::
59 Produce remerge-diff output for merge commits.
60 Shortcut for '--diff-merges=remerge -p'.
61
Sergey Organov1d245092020-12-21 18:19:59 +030062--no-diff-merges::
Sergey Organovbe3820c2023-10-09 19:05:33 +030063 Synonym for '--diff-merges=off'.
64
65--diff-merges=<format>::
Sergey Organov1d245092020-12-21 18:19:59 +030066 Specify diff format to be used for merge commits. Default is
Sergey Organovbe3820c2023-10-09 19:05:33 +030067 {diff-merges-default} unless `--first-parent` is in use, in
68 which case `first-parent` is the default.
Sergey Organov1d245092020-12-21 18:19:59 +030069+
Sergey Organovbe3820c2023-10-09 19:05:33 +030070The following formats are supported:
71+
72--
73off, none::
Sergey Organov1d245092020-12-21 18:19:59 +030074 Disable output of diffs for merge commits. Useful to override
75 implied value.
76+
Sergey Organovbe3820c2023-10-09 19:05:33 +030077on, m::
78 Make diff output for merge commits to be shown in the default
Junio C Hamano8183b632023-10-30 07:09:55 +090079 format. The default format can be changed using
Sergey Organovbe3820c2023-10-09 19:05:33 +030080 `log.diffMerges` configuration variable, whose default value
Jonathan Nieder6a38e332021-08-05 18:45:23 -070081 is `separate`.
Sergey Organov364bc112021-04-13 14:41:18 +030082+
Sergey Organovbe3820c2023-10-09 19:05:33 +030083first-parent, 1::
84 Show full diff with respect to first parent. This is the same
85 format as `--patch` produces for non-merge commits.
Sergey Organov1d245092020-12-21 18:19:59 +030086+
Sergey Organovbe3820c2023-10-09 19:05:33 +030087separate::
88 Show full diff with respect to each of parents.
89 Separate log entry and diff is generated for each parent.
Sergey Organov1d245092020-12-21 18:19:59 +030090+
Sergey Organovbe3820c2023-10-09 19:05:33 +030091combined, c::
92 Show differences from each of the parents to the merge
93 result simultaneously instead of showing pairwise diff between
94 a parent and the result one at a time. Furthermore, it lists
95 only files which were modified from all parents.
96+
97dense-combined, cc::
98 Further compress output produced by `--diff-merges=combined`
99 by omitting uninteresting hunks whose contents in the parents
100 have only two variants and the merge result picks one of them
101 without modification.
102+
103remerge, r::
104 Remerge two-parent merge commits to create a temporary tree
105 object--potentially containing files with conflict markers
106 and such. A diff is then shown between that temporary tree
107 and the actual merge commit.
Elijah Newrendb757e82022-02-02 02:37:28 +0000108+
109The output emitted when this option is used is subject to change, and
110so is its interaction with other options (unless explicitly
111documented).
Sergey Organovbe3820c2023-10-09 19:05:33 +0300112--
Sergey Organov1d245092020-12-21 18:19:59 +0300113
114--combined-all-paths::
115 This flag causes combined diffs (used for merge commits) to
116 list the name of the file from all parents. It thus only has
117 effect when `--diff-merges=[dense-]combined` is in use, and
118 is likely only useful if filename changes are detected (i.e.
119 when either rename or copy detection have been requested).
120endif::git-log[]
121
Robin Rosenberg4eb99472007-07-25 12:08:17 +0200122-U<n>::
Robin Rosenberg4eb99472007-07-25 12:08:17 +0200123--unified=<n>::
124 Generate diffs with <n> lines of context instead of
Sergey Organov714d4912020-10-31 22:37:34 +0300125 the usual three.
Björn Gustavsson02bc5b02009-11-07 10:51:56 +0100126ifndef::git-format-patch[]
Sergey Organov714d4912020-10-31 22:37:34 +0300127 Implies `--patch`.
Björn Gustavsson02bc5b02009-11-07 10:51:56 +0100128endif::git-format-patch[]
Robin Rosenberg4eb99472007-07-25 12:08:17 +0200129
Nguyễn Thái Ngọc Duyaf2f3682019-02-21 18:16:12 +0700130--output=<file>::
131 Output to a specific file instead of stdout.
132
133--output-indicator-new=<char>::
134--output-indicator-old=<char>::
135--output-indicator-context=<char>::
136 Specify the character used to indicate new, old or context
137 lines in the generated patch. Normally they are '+', '-' and
138 ' ' respectively.
139
Björn Gustavssond4cb0032009-11-07 10:52:29 +0100140ifndef::git-format-patch[]
Junio C Hamanob5376642006-07-07 05:28:05 -0700141--raw::
Matthieu Moyd89df362015-05-18 19:55:57 +0200142ifndef::git-log[]
143 Generate the diff in raw format.
Jeff Kingd0258b92015-05-14 00:34:48 -0400144ifdef::git-diff-core[]
145 This is the default.
146endif::git-diff-core[]
Matthieu Moyd89df362015-05-18 19:55:57 +0200147endif::git-log[]
148ifdef::git-log[]
149 For each commit, show a summary of changes using the raw diff
150 format. See the "RAW OUTPUT FORMAT" section of
151 linkgit:git-diff[1]. This is different from showing the log
152 itself in raw format, which you can achieve with
153 `--format=raw`.
154endif::git-log[]
Björn Gustavssond4cb0032009-11-07 10:52:29 +0100155endif::git-format-patch[]
Junio C Hamanob5376642006-07-07 05:28:05 -0700156
Björn Gustavsson02bc5b02009-11-07 10:51:56 +0100157ifndef::git-format-patch[]
Petr Baudis5c91da22006-04-11 13:22:17 +0200158--patch-with-raw::
Björn Gustavssondce5ef12009-11-07 10:53:07 +0100159 Synonym for `-p --raw`.
Björn Gustavsson02bc5b02009-11-07 10:51:56 +0100160endif::git-format-patch[]
Petr Baudis5c91da22006-04-11 13:22:17 +0200161
Jeff King9a6d5152020-07-29 16:12:10 -0400162ifdef::git-log[]
163-t::
164 Show the tree objects in the diff output.
165endif::git-log[]
166
Carlos Martín Nietobab76142017-10-29 16:12:28 +0100167--indent-heuristic::
Robert P. J. Day7eedad12018-06-11 09:56:13 -0400168 Enable the heuristic that shifts diff hunk boundaries to make patches
Carlos Martín Nietobab76142017-10-29 16:12:28 +0100169 easier to read. This is the default.
170
171--no-indent-heuristic::
172 Disable the indent heuristic.
Junio C Hamano5580b272016-06-10 10:58:55 -0700173
Junio C Hamano81b568c2011-10-01 21:56:28 -0700174--minimal::
175 Spend extra time to make sure the smallest possible
176 diff is produced.
177
Teemu Likonenec740422009-01-25 14:20:22 +0200178--patience::
Johannes Schindelin34292bd2009-01-01 17:39:17 +0100179 Generate a diff using the "patience diff" algorithm.
180
Thomas Rastd909e072012-03-06 14:15:02 +0100181--histogram::
182 Generate a diff using the "histogram diff" algorithm.
183
Jonathan Tan2477ab22017-11-27 11:47:47 -0800184--anchored=<text>::
185 Generate a diff using the "anchored diff" algorithm.
186+
187This option may be specified more than once.
188+
189If a line exists in both the source and destination, exists only once,
190and starts with this text, this algorithm attempts to prevent it from
191appearing as a deletion or addition in the output. It uses the "patience
192diff" algorithm internally.
193
Michal Privoznik07924d42013-01-16 08:51:58 +0100194--diff-algorithm={patience|minimal|histogram|myers}::
195 Choose a diff algorithm. The variants are as follows:
196+
197--
198`default`, `myers`;;
199 The basic greedy diff algorithm. Currently, this is the default.
200`minimal`;;
201 Spend extra time to make sure the smallest possible diff is
202 produced.
203`patience`;;
204 Use "patience diff" algorithm when generating patches.
205`histogram`;;
206 This algorithm extends the patience algorithm to "support
207 low-occurrence common elements".
208--
209+
Robert P. J. Day7eedad12018-06-11 09:56:13 -0400210For instance, if you configured the `diff.algorithm` variable to a
Michal Privoznik07924d42013-01-16 08:51:58 +0100211non-default value and want to use the default one, then you
212have to use `--diff-algorithm=default` option.
213
Michael J Gruber808e1db2011-05-27 14:36:41 +0200214--stat[=<width>[,<name-width>[,<count>]]]::
Zbigniew Jędrzejewski-Szmek1b058bc2012-03-01 13:26:43 +0100215 Generate a diffstat. By default, as much space as necessary
Zbigniew Jędrzejewski-Szmekdf444832012-03-01 13:26:46 +0100216 will be used for the filename part, and the rest for the graph
217 part. Maximum width defaults to terminal width, or 80 columns
Leila Muhtasib8d8136c2012-06-22 16:03:01 -0400218 if not connected to a terminal, and can be overridden by
Zbigniew Jędrzejewski-Szmekdf444832012-03-01 13:26:46 +0100219 `<width>`. The width of the filename part can be limited by
Dragan Simicbd48adc2023-09-11 17:39:44 +0200220 giving another width `<name-width>` after a comma or by setting
221 `diff.statNameWidth=<width>`. The width of the graph part can be
222 limited by using `--stat-graph-width=<width>` or by setting
223 `diff.statGraphWidth=<width>`. Using `--stat` or
224 `--stat-graph-width` affects all commands generating a stat graph,
225 while setting `diff.statNameWidth` or `diff.statGraphWidth`
226 does not affect `git format-patch`.
227 By giving a third parameter `<count>`, you can limit the output to
228 the first `<count>` lines, followed by `...` if there are more.
Michael J Gruber86e1ce962011-05-27 14:36:42 +0200229+
230These parameters can also be set individually with `--stat-width=<width>`,
231`--stat-name-width=<name-width>` and `--stat-count=<count>`.
Johannes Schindelind75f7952006-04-14 00:15:30 +0200232
Nguyễn Thái Ngọc Duyddf88fa2018-02-24 21:09:59 +0700233--compact-summary::
234 Output a condensed summary of extended header information such
235 as file creations or deletions ("new" or "gone", optionally "+l"
236 if it's a symlink) and mode changes ("+x" or "-x" for adding
237 or removing executable bit respectively) in diffstat. The
Karthikeyan Singaravelan1f2abe62018-06-17 04:35:54 +0000238 information is put between the filename part and the graph
Nguyễn Thái Ngọc Duyddf88fa2018-02-24 21:09:59 +0700239 part. Implies `--stat`.
240
Junio C Hamano74e2abe2006-10-12 03:01:00 -0700241--numstat::
Jeff King6cf378f2012-04-26 04:51:57 -0400242 Similar to `--stat`, but shows number of added and
Junio C Hamano74e2abe2006-10-12 03:01:00 -0700243 deleted lines in decimal notation and pathname without
Junio C Hamano2f895432006-12-26 00:15:26 -0800244 abbreviation, to make it more machine friendly. For
245 binary files, outputs two `-` instead of saying
246 `0 0`.
Junio C Hamano74e2abe2006-10-12 03:01:00 -0700247
Nicolas Pitreebd124c2006-12-14 23:15:44 -0500248--shortstat::
Björn Gustavssondce5ef12009-11-07 10:53:07 +0100249 Output only the last line of the `--stat` format containing total
Nicolas Pitreebd124c2006-12-14 23:15:44 -0500250 number of modified files, as well as number of added and deleted
251 lines.
252
Nguyễn Thái Ngọc Duy4ce7aab2019-02-21 18:16:03 +0700253-X[<param1,param2,...>]::
Johan Herland333f3fb2011-04-29 11:36:18 +0200254--dirstat[=<param1,param2,...>]::
255 Output the distribution of relative amount of changes for each
256 sub-directory. The behavior of `--dirstat` can be customized by
257 passing it a comma separated list of parameters.
Johan Herland2d174952011-04-29 11:36:19 +0200258 The defaults are controlled by the `diff.dirstat` configuration
259 variable (see linkgit:git-config[1]).
Johan Herland333f3fb2011-04-29 11:36:18 +0200260 The following parameters are available:
Johan Herland204f01a2011-04-11 00:48:50 +0200261+
Johan Herland333f3fb2011-04-29 11:36:18 +0200262--
263`changes`;;
264 Compute the dirstat numbers by counting the lines that have been
265 removed from the source, or added to the destination. This ignores
266 the amount of pure code movements within a file. In other words,
267 rearranging lines in a file is not counted as much as other changes.
268 This is the default behavior when no parameter is given.
Johan Herland1c57a622011-04-29 11:36:21 +0200269`lines`;;
270 Compute the dirstat numbers by doing the regular line-based diff
271 analysis, and summing the removed/added line counts. (For binary
272 files, count 64-byte chunks instead, since binary files have no
273 natural concept of lines). This is a more expensive `--dirstat`
274 behavior than the `changes` behavior, but it does count rearranged
275 lines within a file as much as other changes. The resulting output
276 is consistent with what you get from the other `--*stat` options.
Johan Herland333f3fb2011-04-29 11:36:18 +0200277`files`;;
278 Compute the dirstat numbers by counting the number of files changed.
279 Each changed file counts equally in the dirstat analysis. This is
280 the computationally cheapest `--dirstat` behavior, since it does
281 not have to look at the file contents at all.
282`cumulative`;;
283 Count changes in a child directory for the parent directory as well.
284 Note that when using `cumulative`, the sum of the percentages
285 reported may exceed 100%. The default (non-cumulative) behavior can
286 be specified with the `noncumulative` parameter.
287<limit>;;
288 An integer parameter specifies a cut-off percent (3% by default).
289 Directories contributing less than this percentage of the changes
290 are not shown in the output.
291--
292+
293Example: The following will count changed files, while ignoring
294directories with less than 10% of the total amount of changed files,
295and accumulating child directory counts in the parent directories:
296`--dirstat=files,10,cumulative`.
Heikki Orsilafd337772008-09-05 22:27:35 +0300297
Nguyễn Thái Ngọc Duy4ce7aab2019-02-21 18:16:03 +0700298--cumulative::
299 Synonym for --dirstat=cumulative
300
301--dirstat-by-file[=<param1,param2>...]::
Jean-Noël Avila51e846e2023-12-25 21:21:27 +0000302 Synonym for --dirstat=files,<param1>,<param2>...
Nguyễn Thái Ngọc Duy4ce7aab2019-02-21 18:16:03 +0700303
Sean4bbd2612006-05-14 08:13:49 -0400304--summary::
305 Output a condensed summary of extended header information
306 such as creations, renames and mode changes.
307
Björn Gustavsson02bc5b02009-11-07 10:51:56 +0100308ifndef::git-format-patch[]
Johannes Schindelin29353272006-04-15 13:41:18 +0200309--patch-with-stat::
Björn Gustavssondce5ef12009-11-07 10:53:07 +0100310 Synonym for `-p --stat`.
Björn Gustavsson02bc5b02009-11-07 10:51:56 +0100311endif::git-format-patch[]
Johannes Schindelin29353272006-04-15 13:41:18 +0200312
Björn Gustavssond4cb0032009-11-07 10:52:29 +0100313ifndef::git-format-patch[]
Björn Gustavsson64485b42009-11-22 20:43:20 +0100314
Junio C Hamanodda2d792005-07-13 12:52:35 -0700315-z::
Björn Gustavsson5c931c82009-11-23 08:40:24 +0100316ifdef::git-log[]
Štěpán Němec97509a32023-10-05 11:00:51 +0200317 Separate the commits with NULs instead of newlines.
Björn Gustavsson5c931c82009-11-23 08:40:24 +0100318+
319Also, when `--raw` or `--numstat` has been given, do not munge
320pathnames and use NULs as output field terminators.
321endif::git-log[]
Björn Gustavsson64485b42009-11-22 20:43:20 +0100322ifndef::git-log[]
Charles Bailey03aa87e2010-04-18 19:28:17 +0100323 When `--raw`, `--numstat`, `--name-only` or `--name-status` has been
324 given, do not munge pathnames and use NULs as output field terminators.
Björn Gustavsson5c931c82009-11-23 08:40:24 +0100325endif::git-log[]
Björn Gustavsson64485b42009-11-22 20:43:20 +0100326+
Andreas Heiduk860cd692017-03-02 20:03:52 +0100327Without this option, pathnames with "unusual" characters are quoted as
328explained for the configuration variable `core.quotePath` (see
329linkgit:git-config[1]).
Junio C Hamanodda2d792005-07-13 12:52:35 -0700330
331--name-only::
Junio C Hamano49866622024-05-17 10:14:46 -0700332 Show only the name of each changed file in the post-image tree.
333 The file names are often encoded in UTF-8.
Andrey Bienkowski9364bf42021-04-20 11:24:37 +0000334 For more information see the discussion about encoding in the linkgit:git-log[1]
335 manual page.
Junio C Hamanodda2d792005-07-13 12:52:35 -0700336
Junio C Hamano946f5f72005-09-21 00:20:06 -0700337--name-status::
Junio C Hamano49866622024-05-17 10:14:46 -0700338 Show only the name(s) and status of each changed file. See the description
Miklos Vajnaa6f47b22008-04-22 14:23:48 +0200339 of the `--diff-filter` option on what the status letters mean.
Andrey Bienkowski9364bf42021-04-20 11:24:37 +0000340 Just like `--name-only` the file names are often encoded in UTF-8.
Junio C Hamanodda2d792005-07-13 12:52:35 -0700341
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200342--submodule[=<format>]::
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700343 Specify how differences in submodules are shown. When specifying
344 `--submodule=short` the 'short' format is used. This format just
345 shows the names of the commits at the beginning and end of the range.
346 When `--submodule` or `--submodule=log` is specified, the 'log'
347 format is used. This format lists the commits in the range like
348 linkgit:git-submodule[1] `summary` does. When `--submodule=diff`
349 is specified, the 'diff' format is used. This format shows an
350 inline diff of the changes in the submodule contents between the
351 commit range. Defaults to `diff.submodule` or the 'short' format
352 if the config option is unset.
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200353
Mark Lodato73e9da02010-02-16 23:55:58 -0500354--color[=<when>]::
Junio C Hamanob5376642006-07-07 05:28:05 -0700355 Show colored diff.
Junio C Hamano3d0e75f2013-02-22 22:24:10 -0800356 `--color` (i.e. without '=<when>') is the same as `--color=always`.
357 '<when>' can be one of `always`, `never`, or `auto`.
Michael J Gruber6999c542011-04-27 09:38:27 +0200358ifdef::git-diff[]
359 It can be changed by the `color.ui` and `color.diff`
360 configuration settings.
361endif::git-diff[]
Junio C Hamanob5376642006-07-07 05:28:05 -0700362
363--no-color::
Michael J Gruber6999c542011-04-27 09:38:27 +0200364 Turn off colored diff.
365ifdef::git-diff[]
366 This can be used to override configuration settings.
367endif::git-diff[]
368 It is the same as `--color=never`.
Junio C Hamanob5376642006-07-07 05:28:05 -0700369
Stefan Beller61e89ea2017-06-30 13:53:10 -0700370--color-moved[=<mode>]::
371 Moved lines of code are colored differently.
372ifdef::git-diff[]
373 It can be changed by the `diff.colorMoved` configuration setting.
374endif::git-diff[]
375 The <mode> defaults to 'no' if the option is not given
376 and to 'zebra' if the option with no mode is given.
377 The mode must be one of:
378+
379--
380no::
381 Moved lines are not highlighted.
382default::
383 Is a synonym for `zebra`. This may change to a more sensible mode
384 in the future.
385plain::
386 Any line that is added in one location and was removed
387 in another location will be colored with 'color.diff.newMoved'.
388 Similarly 'color.diff.oldMoved' will be used for removed lines
389 that are added somewhere else in the diff. This mode picks up any
390 moved line, but it is not very useful in a review to determine
391 if a block of code was moved without permutation.
Stefan Beller51da15e2018-07-16 16:05:39 -0700392blocks::
Jonathan Tanf0b8fb62017-08-15 18:27:39 -0700393 Blocks of moved text of at least 20 alphanumeric characters
394 are detected greedily. The detected blocks are
Stefan Beller51da15e2018-07-16 16:05:39 -0700395 painted using either the 'color.diff.{old,new}Moved' color.
396 Adjacent blocks cannot be told apart.
397zebra::
398 Blocks of moved text are detected as in 'blocks' mode. The blocks
399 are painted using either the 'color.diff.{old,new}Moved' color or
Stefan Beller61e89ea2017-06-30 13:53:10 -0700400 'color.diff.{old,new}MovedAlternative'. The change between
Jonathan Tanf0b8fb62017-08-15 18:27:39 -0700401 the two colors indicates that a new block was detected.
Eric Sunshinee3f2f5f2018-07-24 17:58:45 -0400402dimmed-zebra::
Stefan Beller61e89ea2017-06-30 13:53:10 -0700403 Similar to 'zebra', but additional dimming of uninteresting parts
404 of moved code is performed. The bordering lines of two adjacent
405 blocks are considered interesting, the rest is uninteresting.
Eric Sunshinee3f2f5f2018-07-24 17:58:45 -0400406 `dimmed_zebra` is a deprecated synonym.
Stefan Beller61e89ea2017-06-30 13:53:10 -0700407--
408
Phillip Woodfbafb7c2018-11-23 11:16:50 +0000409--no-color-moved::
410 Turn off move detection. This can be used to override configuration
411 settings. It is the same as `--color-moved=no`.
412
Stefan Bellerb3095712018-07-16 16:05:40 -0700413--color-moved-ws=<modes>::
Phillip Wood748aa1a2018-11-23 11:16:51 +0000414 This configures how whitespace is ignored when performing the
Stefan Beller626c0b52018-07-18 12:31:56 -0700415 move detection for `--color-moved`.
416ifdef::git-diff[]
417 It can be set by the `diff.colorMovedWS` configuration setting.
418endif::git-diff[]
419 These modes can be given as a comma separated list:
Stefan Bellerb3095712018-07-16 16:05:40 -0700420+
421--
Phillip Woodb73bcba2018-11-23 11:16:52 +0000422no::
423 Do not ignore whitespace when performing move detection.
Stefan Bellerb3095712018-07-16 16:05:40 -0700424ignore-space-at-eol::
425 Ignore changes in whitespace at EOL.
426ignore-space-change::
427 Ignore changes in amount of whitespace. This ignores whitespace
428 at line end, and considers all other sequences of one or
429 more whitespace characters to be equivalent.
430ignore-all-space::
431 Ignore whitespace when comparing lines. This ignores differences
432 even if one line has whitespace where the other line has none.
Stefan Bellerca1f4ae2018-07-18 12:31:55 -0700433allow-indentation-change::
Phillip Wood748aa1a2018-11-23 11:16:51 +0000434 Initially ignore any whitespace in the move detection, then
Stefan Bellerca1f4ae2018-07-18 12:31:55 -0700435 group the moved code blocks only into a block if the change in
436 whitespace is the same per line. This is incompatible with the
437 other modes.
Stefan Bellerb3095712018-07-16 16:05:40 -0700438--
439
Phillip Woodb73bcba2018-11-23 11:16:52 +0000440--no-color-moved-ws::
441 Do not ignore whitespace when performing move detection. This can be
442 used to override configuration settings. It is the same as
443 `--color-moved-ws=no`.
444
Thomas Rast882749a2010-04-14 17:59:06 +0200445--word-diff[=<mode>]::
446 Show a word diff, using the <mode> to delimit changed words.
447 By default, words are delimited by whitespace; see
448 `--word-diff-regex` below. The <mode> defaults to 'plain', and
449 must be one of:
Johannes Schindelin2b6a5412009-01-17 17:29:45 +0100450+
Thomas Rast882749a2010-04-14 17:59:06 +0200451--
452color::
453 Highlight changed words using only colors. Implies `--color`.
454plain::
455 Show words as `[-removed-]` and `{+added+}`. Makes no
456 attempts to escape the delimiters if they appear in the input,
457 so the output may be ambiguous.
458porcelain::
459 Use a special line-based format intended for script
460 consumption. Added/removed/unchanged runs are printed in the
461 usual unified diff format, starting with a `+`/`-`/` `
462 character at the beginning of the line and extending to the
463 end of the line. Newlines in the input are represented by a
464 tilde `~` on a line of its own.
465none::
466 Disable word diff again.
467--
468+
469Note that despite the name of the first mode, color is used to
470highlight the changed parts in all modes if enabled.
471
472--word-diff-regex=<regex>::
473 Use <regex> to decide what a word is, instead of considering
474 runs of non-whitespace to be a word. Also implies
475 `--word-diff` unless it was already enabled.
476+
477Every non-overlapping match of the
Thomas Rastc4b252c2009-01-17 17:29:47 +0100478<regex> is considered a word. Anything between these matches is
479considered whitespace and ignored(!) for the purposes of finding
480differences. You may want to append `|[^[:space:]]` to your regular
481expression to make sure that it matches all non-whitespace characters.
482A match that contains a newline is silently truncated(!) at the
483newline.
Thomas Rast80c49c32009-01-17 17:29:48 +0100484+
Michael J Gruber2c15c002015-11-20 14:36:14 +0100485For example, `--word-diff-regex=.` will treat each character as a word
486and, correspondingly, show differences character by character.
487+
Boyd Stephen Smith Jr98a4d872009-01-20 21:46:57 -0600488The regex can also be set via a diff driver or configuration option, see
Junio C Hamano1cca17d2016-05-04 10:36:24 -0700489linkgit:gitattributes[5] or linkgit:git-config[1]. Giving it explicitly
Boyd Stephen Smith Jr98a4d872009-01-20 21:46:57 -0600490overrides any diff driver or configuration setting. Diff drivers
491override configuration settings.
Thomas Rast882749a2010-04-14 17:59:06 +0200492
493--color-words[=<regex>]::
494 Equivalent to `--word-diff=color` plus (if a regex was
495 specified) `--word-diff-regex=<regex>`.
Björn Gustavssond4cb0032009-11-07 10:52:29 +0100496endif::git-format-patch[]
Johannes Schindelinf59a59e2006-07-28 23:56:15 +0200497
Junio C Hamanob5376642006-07-07 05:28:05 -0700498--no-renames::
499 Turn off rename detection, even when the configuration
500 file gives the default to do so.
501
Nguyễn Thái Ngọc Duycdc43eb2019-02-21 18:16:18 +0700502--[no-]rename-empty::
503 Whether to use empty blobs as rename source.
504
Björn Gustavsson02bc5b02009-11-07 10:51:56 +0100505ifndef::git-format-patch[]
Bill Lear16507fc2007-01-27 07:21:53 -0600506--check::
Ori Avtalion30211fb2016-03-29 21:59:45 +0300507 Warn if changes introduce conflict markers or whitespace errors.
508 What are considered whitespace errors is controlled by `core.whitespace`
Christof Krüger4f830392011-06-22 17:33:02 +0200509 configuration. By default, trailing whitespaces (including
Robert P. J. Day7eedad12018-06-11 09:56:13 -0400510 lines that consist solely of whitespaces) and a space character
Christof Krüger4f830392011-06-22 17:33:02 +0200511 that is immediately followed by a tab character inside the
512 initial indent of the line are considered whitespace errors.
513 Exits with non-zero status if problems are found. Not compatible
514 with --exit-code.
Junio C Hamanob8767f72015-05-26 10:11:28 -0700515
516--ws-error-highlight=<kind>::
Andreas Heidukc0bb6d92017-07-25 22:53:15 +0200517 Highlight whitespace errors in the `context`, `old` or `new`
518 lines of the diff. Multiple values are separated by comma,
519 `none` resets previous values, `default` reset the list to
520 `new` and `all` is a shorthand for `old,new,context`. When
521 this option is not given, and the configuration variable
522 `diff.wsErrorHighlight` is not set, only whitespace errors in
523 `new` lines are highlighted. The whitespace errors are colored
Robert P. J. Day7eedad12018-06-11 09:56:13 -0400524 with `color.diff.whitespace`.
Junio C Hamanob8767f72015-05-26 10:11:28 -0700525
Björn Gustavsson02bc5b02009-11-07 10:51:56 +0100526endif::git-format-patch[]
Bill Lear16507fc2007-01-27 07:21:53 -0600527
Junio C Hamano80b1e512005-11-14 17:53:22 -0800528--full-index::
Jim Meyering6457e582008-07-02 09:49:59 +0200529 Instead of the first handful of characters, show the full
530 pre- and post-image blob object names on the "index"
531 line when generating patch format output.
Junio C Hamanob5376642006-07-07 05:28:05 -0700532
533--binary::
Björn Gustavssondce5ef12009-11-07 10:53:07 +0100534 In addition to `--full-index`, output a binary diff that
Sergey Organov714d4912020-10-31 22:37:34 +0300535 can be applied with `git-apply`.
536ifndef::git-format-patch[]
537 Implies `--patch`.
538endif::git-format-patch[]
Junio C Hamano80b1e512005-11-14 17:53:22 -0800539
Junio C Hamano913419f2005-12-18 02:03:15 -0800540--abbrev[=<n>]::
Junio C Hamano47dd0d52005-12-13 17:21:41 -0800541 Instead of showing the full 40-byte hexadecimal object
542 name in diff-raw format output and diff-tree header
Junio C Hamanocda34e02020-11-04 14:01:37 -0800543 lines, show the shortest prefix that is at least '<n>'
544 hexdigits long that uniquely refers the object.
Đoàn Trần Công Danh3046c7f2020-08-21 18:51:47 +0700545 In diff-patch output format, `--full-index` takes higher
546 precedence, i.e. if `--full-index` is specified, full blob
547 names will be shown regardless of `--abbrev`.
548 Non default number of digits can be specified with `--abbrev=<n>`.
Junio C Hamano47dd0d52005-12-13 17:21:41 -0800549
Matthieu Moycf958af2010-08-05 18:14:25 +0200550-B[<n>][/<m>]::
Kevin Ballard37ab5152010-09-27 16:58:26 -0700551--break-rewrites[=[<n>][/<m>]]::
Matthieu Moycf958af2010-08-05 18:14:25 +0200552 Break complete rewrite changes into pairs of delete and
553 create. This serves two purposes:
554+
555It affects the way a change that amounts to a total rewrite of a file
556not as a series of deletion and insertion mixed together with a very
557few lines that happen to match textually as the context, but as a
558single deletion of everything old followed by a single insertion of
559everything new, and the number `m` controls this aspect of the -B
560option (defaults to 60%). `-B/70%` specifies that less than 30% of the
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100561original should remain in the result for Git to consider it a total
Matthieu Moycf958af2010-08-05 18:14:25 +0200562rewrite (i.e. otherwise the resulting patch will be a series of
563deletion and insertion mixed together with context lines).
564+
565When used with -M, a totally-rewritten file is also considered as the
566source of a rename (usually -M only considers a file that disappeared
567as the source of a rename), and the number `n` controls this aspect of
568the -B option (defaults to 50%). `-B20%` specifies that a change with
569addition and deletion compared to 20% or more of the file's size are
570eligible for being picked up as a possible source of a rename to
571another file.
Junio C Hamanodda2d792005-07-13 12:52:35 -0700572
Matthieu Moycf958af2010-08-05 18:14:25 +0200573-M[<n>]::
Yann Dirsonf611ddc2010-11-10 21:27:12 +0100574--find-renames[=<n>]::
Jeff King7ffad252010-05-08 00:44:34 -0400575ifndef::git-log[]
Junio C Hamanodda2d792005-07-13 12:52:35 -0700576 Detect renames.
Jeff King7ffad252010-05-08 00:44:34 -0400577endif::git-log[]
578ifdef::git-log[]
579 If generating diffs, detect and report renames for each commit.
580 For following files across renames while traversing history, see
581 `--follow`.
582endif::git-log[]
João Britto4c007ae2011-05-06 01:16:17 -0300583 If `n` is specified, it is a threshold on the similarity
Matthieu Moycf958af2010-08-05 18:14:25 +0200584 index (i.e. amount of addition/deletions compared to the
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100585 file's size). For example, `-M90%` means Git should consider a
Matthieu Moycf958af2010-08-05 18:14:25 +0200586 delete/add pair to be a rename if more than 90% of the file
Sitaram Chamarty31d66aa2012-12-18 16:17:09 +0530587 hasn't changed. Without a `%` sign, the number is to be read as
588 a fraction, with a decimal point before it. I.e., `-M5` becomes
589 0.5, and is thus the same as `-M50%`. Similarly, `-M05` is
590 the same as `-M5%`. To limit detection to exact renames, use
Fraser Tweedale82409432013-07-05 18:42:17 +1000591 `-M100%`. The default similarity index is 50%.
Junio C Hamanodda2d792005-07-13 12:52:35 -0700592
Matthieu Moycf958af2010-08-05 18:14:25 +0200593-C[<n>]::
Yann Dirsonf611ddc2010-11-10 21:27:12 +0100594--find-copies[=<n>]::
Johannes Schindelinca6c0972007-06-11 21:12:19 +0100595 Detect copies as well as renames. See also `--find-copies-harder`.
Matthieu Moycf958af2010-08-05 18:14:25 +0200596 If `n` is specified, it has the same meaning as for `-M<n>`.
Junio C Hamanodda2d792005-07-13 12:52:35 -0700597
598--find-copies-harder::
Johannes Schindelinca6c0972007-06-11 21:12:19 +0100599 For performance reasons, by default, `-C` option finds copies only
Junio C Hamanoa6080a02007-06-07 00:04:01 -0700600 if the original file of the copy was modified in the same
Christian Mederf73ae1f2005-10-05 15:08:26 -0700601 changeset. This flag makes the command
Junio C Hamanodda2d792005-07-13 12:52:35 -0700602 inspect unmodified files as candidates for the source of
603 copy. This is a very expensive operation for large
Johannes Schindelinca6c0972007-06-11 21:12:19 +0100604 projects, so use it with caution. Giving more than one
605 `-C` option has the same effect.
Junio C Hamanodda2d792005-07-13 12:52:35 -0700606
Junio C Hamano467ddc12011-02-28 16:11:55 -0800607-D::
608--irreversible-delete::
609 Omit the preimage for deletes, i.e. print only the header but not
610 the diff between the preimage and `/dev/null`. The resulting patch
Justin Lebara58088a2014-03-31 15:11:44 -0700611 is not meant to be applied with `patch` or `git apply`; this is
Junio C Hamano467ddc12011-02-28 16:11:55 -0800612 solely for people who want to just concentrate on reviewing the
Anthony Sottilebc9b7e22017-07-31 07:00:31 -0700613 text after the change. In addition, the output obviously lacks
Junio C Hamano467ddc12011-02-28 16:11:55 -0800614 enough information to apply such a patch in reverse, even manually,
615 hence the name of the option.
616+
617When used together with `-B`, omit also the preimage in the deletion part
618of a delete/create pair.
619
Junio C Hamano8082d8d2005-09-21 00:18:27 -0700620-l<num>::
Elijah Newren6623a522021-07-15 00:45:22 +0000621 The `-M` and `-C` options involve some preliminary steps that
622 can detect subsets of renames/copies cheaply, followed by an
623 exhaustive fallback portion that compares all remaining
624 unpaired destinations to all relevant sources. (For renames,
625 only remaining unpaired sources are relevant; for copies, all
626 original sources are relevant.) For N sources and
627 destinations, this exhaustive check is O(N^2). This option
628 prevents the exhaustive portion of rename/copy detection from
629 running if the number of source/destination files involved
630 exceeds the specified number. Defaults to diff.renameLimit.
Elijah Newren9dd29db2021-07-15 00:45:23 +0000631 Note that a value of 0 is treated as unlimited.
Junio C Hamano8082d8d2005-09-21 00:18:27 -0700632
Björn Gustavssond4cb0032009-11-07 10:52:29 +0100633ifndef::git-format-patch[]
Yann Dirsonf1037442010-11-10 21:27:13 +0100634--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]::
635 Select only files that are Added (`A`), Copied (`C`),
636 Deleted (`D`), Modified (`M`), Renamed (`R`), have their
637 type (i.e. regular file, symlink, submodule, ...) changed (`T`),
638 are Unmerged (`U`), are
639 Unknown (`X`), or have had their pairing Broken (`B`).
640 Any combination of the filter characters (including none) can be used.
641 When `*` (All-or-none) is added to the combination, all
642 paths are selected if there is any file that matches
643 other criteria in the comparison; if there is no file
644 that matches other criteria, nothing is selected.
Junio C Hamano16726cf2016-07-14 12:17:47 -0700645+
646Also, these upper-case letters can be downcased to exclude. E.g.
647`--diff-filter=ad` excludes added and deleted paths.
Jeff King46af1072018-01-04 11:49:42 -0500648+
Johannes Schindelind843e312022-01-28 12:02:48 +0000649Note that not all diffs can feature all types. For instance, copied and
650renamed entries cannot appear if detection for those types is disabled.
Yann Dirsonf1037442010-11-10 21:27:13 +0100651
Junio C Hamanodda2d792005-07-13 12:52:35 -0700652-S<string>::
Ramkumar Ramachandra5bc3f0b2013-05-31 17:42:15 +0530653 Look for differences that change the number of occurrences of
654 the specified string (i.e. addition/deletion) in a file.
655 Intended for the scripter's use.
656+
657It is useful when you're looking for an exact block of code (like a
658struct), and want to know the history of that block since it first
659came into being: use the feature iteratively to feed the interesting
660block in the preimage back into `-S`, and keep going until you get the
661very first version of the block.
Thomas Braune0e7cb82018-12-14 19:49:12 +0100662+
663Binary files are searched as well.
Junio C Hamanodda2d792005-07-13 12:52:35 -0700664
Junio C Hamanof506b8e2010-08-23 10:17:03 -0700665-G<regex>::
Ramkumar Ramachandra5bc3f0b2013-05-31 17:42:15 +0530666 Look for differences whose patch text contains added/removed
667 lines that match <regex>.
668+
669To illustrate the difference between `-S<regex> --pickaxe-regex` and
670`-G<regex>`, consider a commit with the following diff in the same
671file:
672+
673----
Martin Ågren9299f842020-02-06 21:53:01 +0100674+ return frotz(nitfol, two->ptr, 1, 0);
Ramkumar Ramachandra5bc3f0b2013-05-31 17:42:15 +0530675...
Martin Ågren9299f842020-02-06 21:53:01 +0100676- hit = frotz(nitfol, mf2.ptr, 1, 0);
Ramkumar Ramachandra5bc3f0b2013-05-31 17:42:15 +0530677----
678+
Martin Ågren9299f842020-02-06 21:53:01 +0100679While `git log -G"frotz\(nitfol"` will show this commit, `git log
680-S"frotz\(nitfol" --pickaxe-regex` will not (because the number of
Ramkumar Ramachandra5bc3f0b2013-05-31 17:42:15 +0530681occurrences of that string did not change).
682+
Thomas Braune0e7cb82018-12-14 19:49:12 +0100683Unless `--text` is supplied patches of binary files without a textconv
684filter will be ignored.
685+
Ramkumar Ramachandra5bc3f0b2013-05-31 17:42:15 +0530686See the 'pickaxe' entry in linkgit:gitdiffcore[7] for more
687information.
Junio C Hamanof506b8e2010-08-23 10:17:03 -0700688
Stefan Beller15af58c2018-01-04 14:50:42 -0800689--find-object=<object-id>::
690 Look for differences that change the number of occurrences of
691 the specified object. Similar to `-S`, just the argument is different
692 in that it doesn't search for a specific string but for a specific
693 object id.
694+
695The object can be a blob or a submodule commit. It implies the `-t` option in
696`git-log` to also find trees.
697
Junio C Hamanodda2d792005-07-13 12:52:35 -0700698--pickaxe-all::
Junio C Hamanof506b8e2010-08-23 10:17:03 -0700699 When `-S` or `-G` finds a change, show all the changes in that
Christian Mederf73ae1f2005-10-05 15:08:26 -0700700 changeset, not just the files that contain the change
Junio C Hamanodda2d792005-07-13 12:52:35 -0700701 in <string>.
702
Petr Baudisd01d8c62006-03-29 02:16:33 +0200703--pickaxe-regex::
Ramkumar Ramachandra5bc3f0b2013-05-31 17:42:15 +0530704 Treat the <string> given to `-S` as an extended POSIX regular
705 expression to match.
Stefan Beller15af58c2018-01-04 14:50:42 -0800706
Björn Gustavssond4cb0032009-11-07 10:52:29 +0100707endif::git-format-patch[]
Petr Baudisd01d8c62006-03-29 02:16:33 +0200708
Junio C Hamanodda2d792005-07-13 12:52:35 -0700709-O<orderfile>::
Richard Hansen874444b2017-01-15 17:16:31 -0500710 Control the order in which files appear in the output.
Nguyễn Thái Ngọc Duyda0005b2015-03-11 16:32:45 -0400711 This overrides the `diff.orderFile` configuration variable
712 (see linkgit:git-config[1]). To cancel `diff.orderFile`,
Samuel Bronson6d8940b2013-12-18 19:08:12 -0500713 use `-O/dev/null`.
Richard Hansen874444b2017-01-15 17:16:31 -0500714+
715The output order is determined by the order of glob patterns in
716<orderfile>.
717All files with pathnames that match the first pattern are output
718first, all files with pathnames that match the second pattern (but not
719the first) are output next, and so on.
720All files with pathnames that do not match any pattern are output
721last, as if there was an implicit match-all pattern at the end of the
722file.
723If multiple pathnames have the same rank (they match the same pattern
724but no earlier patterns), their output order relative to each other is
725the normal order.
726+
727<orderfile> is parsed as follows:
728+
729--
730 - Blank lines are ignored, so they can be used as separators for
731 readability.
732
733 - Lines starting with a hash ("`#`") are ignored, so they can be used
734 for comments. Add a backslash ("`\`") to the beginning of the
735 pattern if it starts with a hash.
736
737 - Each other line contains a single pattern.
738--
739+
740Patterns have the same syntax and semantics as patterns used for
Elijah Newrenc30d4f12018-04-05 10:20:26 -0700741fnmatch(3) without the FNM_PATHNAME flag, except a pathname also
Richard Hansen874444b2017-01-15 17:16:31 -0500742matches a pattern if removing any number of the final pathname
743components matches the pattern. For example, the pattern "`foo*bar`"
744matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`".
Junio C Hamanodda2d792005-07-13 12:52:35 -0700745
Junio C Hamano1eb41362021-02-11 11:57:50 -0800746--skip-to=<file>::
747--rotate-to=<file>::
748 Discard the files before the named <file> from the output
749 (i.e. 'skip to'), or move them to the end of the output
Elijah Newrencf6cac22023-10-08 06:45:03 +0000750 (i.e. 'rotate to'). These options were invented primarily for the use
Junio C Hamano1eb41362021-02-11 11:57:50 -0800751 of the `git difftool` command, and may not be very useful
752 otherwise.
753
Björn Gustavssond4cb0032009-11-07 10:52:29 +0100754ifndef::git-format-patch[]
Junio C Hamanodda2d792005-07-13 12:52:35 -0700755-R::
Lukas_Sandström5f3aa192005-11-11 02:12:27 +0100756 Swap two inputs; that is, show differences from index or
Junio C Hamanodda2d792005-07-13 12:52:35 -0700757 on-disk file to tree contents.
Laurent Arnoudc28ded82020-05-22 12:46:18 +0200758endif::git-format-patch[]
Junio C Hamanodda2d792005-07-13 12:52:35 -0700759
Junio C Hamanoc0cb4a02008-02-13 00:34:39 -0800760--relative[=<path>]::
Laurent Arnoudc28ded82020-05-22 12:46:18 +0200761--no-relative::
Junio C Hamanocd676a52008-02-12 14:26:02 -0800762 When run from a subdirectory of the project, it can be
763 told to exclude changes outside the directory and show
Junio C Hamanoc0cb4a02008-02-13 00:34:39 -0800764 pathnames relative to it with this option. When you are
765 not in a subdirectory (e.g. in a bare repository), you
766 can name which subdirectory to make the output relative
767 to by giving a <path> as an argument.
Laurent Arnoudc28ded82020-05-22 12:46:18 +0200768 `--no-relative` can be used to countermand both `diff.relative` config
769 option and previous `--relative`.
Junio C Hamanocd676a52008-02-12 14:26:02 -0800770
jidanni@jidanni.orga9e67c82008-12-29 15:03:17 +0800771-a::
Stephan Federd507bb12006-07-07 15:57:09 +0200772--text::
773 Treat all files as text.
774
Junio C Hamanoe9282f02017-10-26 15:32:27 +0900775--ignore-cr-at-eol::
Elijah Newrenc30d4f12018-04-05 10:20:26 -0700776 Ignore carriage-return at the end of line when doing a comparison.
Junio C Hamanoe9282f02017-10-26 15:32:27 +0900777
Junio C Hamanoa44a0c92007-02-14 00:41:32 -0800778--ignore-space-at-eol::
Wincent Colaiuta0ac79032007-12-12 09:12:01 +0100779 Ignore changes in whitespace at EOL.
Junio C Hamanoa44a0c92007-02-14 00:41:32 -0800780
jidanni@jidanni.orga9e67c82008-12-29 15:03:17 +0800781-b::
Jakub Narebski8ebe1852006-12-03 17:24:41 +0100782--ignore-space-change::
Wincent Colaiuta0ac79032007-12-12 09:12:01 +0100783 Ignore changes in amount of whitespace. This ignores whitespace
784 at line end, and considers all other sequences of one or
785 more whitespace characters to be equivalent.
Jakub Narebski8ebe1852006-12-03 17:24:41 +0100786
jidanni@jidanni.orga9e67c82008-12-29 15:03:17 +0800787-w::
Jakub Narebski8ebe1852006-12-03 17:24:41 +0100788--ignore-all-space::
Wincent Colaiuta0ac79032007-12-12 09:12:01 +0100789 Ignore whitespace when comparing lines. This ignores
790 differences even if one line has whitespace where the other
Jakub Narebski8ebe1852006-12-03 17:24:41 +0100791 line has none.
792
Antoine Pelisse36617af2013-06-19 20:46:07 +0200793--ignore-blank-lines::
794 Ignore changes whose lines are all blank.
795
Michał Kępień296d4a92020-10-20 08:48:09 +0200796-I<regex>::
797--ignore-matching-lines=<regex>::
798 Ignore changes whose all lines match <regex>. This option may
799 be specified more than once.
800
René Scharfe6d0e6742008-12-28 19:45:32 +0100801--inter-hunk-context=<lines>::
802 Show the context between diff hunks, up to the specified number
803 of lines, thereby fusing hunks that are close to each other.
Vegard Nossumc4888672017-01-12 13:21:11 +0100804 Defaults to `diff.interHunkContext` or 0 if the config option
805 is unset.
René Scharfe6d0e6742008-12-28 19:45:32 +0100806
René Scharfe14937c22011-10-09 13:36:57 +0200807-W::
808--function-context::
Philippe Blain0cce88f2020-11-01 17:28:43 +0000809 Show whole function as context lines for each change.
810 The function names are determined in the same way as
811 `git diff` works out patch hunk headers (see 'Defining a
812 custom hunk-header' in linkgit:gitattributes[5]).
René Scharfe14937c22011-10-09 13:36:57 +0200813
Björn Gustavssond4cb0032009-11-07 10:52:29 +0100814ifndef::git-format-patch[]
Jeff King939ca962011-11-08 16:29:30 -0500815ifndef::git-log[]
Alex Riesen41bbf9d2007-03-14 01:17:04 +0100816--exit-code::
817 Make the program exit with codes similar to diff(1).
818 That is, it exits with 1 if there were differences and
819 0 means no differences.
820
Alex Riesen2a18c262007-03-25 01:55:43 +0100821--quiet::
Björn Gustavssondce5ef12009-11-07 10:53:07 +0100822 Disable all output of the program. Implies `--exit-code`.
René Scharfed7b97b72024-06-09 09:41:44 +0200823 Disables execution of external diff helpers whose exit code
824 is not trusted, i.e. their respective configuration option
825 `diff.trustExitCode` or `diff.<driver>.trustExitCode` or
826 environment variable `GIT_EXTERNAL_DIFF_TRUST_EXIT_CODE` is
827 false.
Jeff King939ca962011-11-08 16:29:30 -0500828endif::git-log[]
Björn Gustavssond4cb0032009-11-07 10:52:29 +0100829endif::git-format-patch[]
Alex Riesen2a18c262007-03-25 01:55:43 +0100830
Johannes Schindelin72909be2007-06-30 18:47:07 +0100831--ext-diff::
832 Allow an external diff helper to be executed. If you set an
Dan McGee5162e692007-12-29 00:20:38 -0600833 external diff driver with linkgit:gitattributes[5], you need
834 to use this option with linkgit:git-log[1] and friends.
Johannes Schindelin72909be2007-06-30 18:47:07 +0100835
836--no-ext-diff::
837 Disallow external diff drivers.
838
Jeff Kingd28790d2011-07-06 11:13:30 -0400839--textconv::
840--no-textconv::
841 Allow (or disallow) external text conversion filters to be run
842 when comparing binary files. See linkgit:gitattributes[5] for
843 details. Because textconv filters are typically a one-way
844 conversion, the resulting diff is suitable for human
845 consumption, but cannot be applied. For this reason, textconv
846 filters are enabled by default only for linkgit:git-diff[1] and
847 linkgit:git-log[1], but not for linkgit:git-format-patch[1] or
848 diff plumbing commands.
849
Jens Lehmanndd44d412010-06-08 18:31:51 +0200850--ignore-submodules[=<when>]::
851 Ignore changes to submodules in the diff generation. <when> can be
Phil Hordb1d04bf2013-05-28 19:36:44 +0000852 either "none", "untracked", "dirty" or "all", which is the default.
Jens Lehmannaee9c7d2010-08-06 00:39:25 +0200853 Using "none" will consider the submodule modified when it either contains
854 untracked or modified files or its HEAD differs from the commit recorded
855 in the superproject and can be used to override any settings of the
Jens Lehmann302ad7a2010-08-06 00:40:48 +0200856 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
Jens Lehmanndd44d412010-06-08 18:31:51 +0200857 "untracked" is used submodules are not considered dirty when they only
858 contain untracked content (but they are still scanned for modified
859 content). Using "dirty" ignores all changes to the work tree of submodules,
860 only changes to the commits stored in the superproject are shown (this was
861 the behavior until 1.7.0). Using "all" hides all changes to submodules.
Johannes Schindelin50fd9bd2008-05-14 18:03:31 +0100862
Johannes Schindelineab9a402007-12-18 19:32:14 +0000863--src-prefix=<prefix>::
864 Show the given source prefix instead of "a/".
865
866--dst-prefix=<prefix>::
867 Show the given destination prefix instead of "b/".
868
869--no-prefix::
870 Do not show any source or destination prefix.
871
Jeff Kingb39a5692023-03-09 01:09:54 -0500872--default-prefix::
873 Use the default source and destination prefixes ("a/" and "b/").
Peter Hutterer7fdc2652024-03-15 11:03:10 +1000874 This overrides configuration variables such as `diff.noprefix`,
875 `diff.srcPrefix`, `diff.dstPrefix`, and `diff.mnemonicPrefix`
876 (see `git-config`(1)).
Jeff Kingb39a5692023-03-09 01:09:54 -0500877
Jacob Keller660e1132016-08-31 16:27:20 -0700878--line-prefix=<prefix>::
879 Prepend an additional prefix to every line of output.
880
Nguyễn Thái Ngọc Duyb42b4512016-10-24 17:42:20 +0700881--ita-invisible-in-index::
882 By default entries added by "git add -N" appear as an existing
883 empty file in "git diff" and a new file in "git diff --cached".
884 This option makes the entry appear as a new file in "git diff"
885 and non-existent in "git diff --cached". This option could be
886 reverted with `--ita-visible-in-index`. Both options are
887 experimental and could be removed in future.
888
Junio C Hamano8db93072005-08-30 13:51:01 -0700889For more detailed explanation on these common options, see also
Jonathan Nieder6998e4d2008-06-30 17:01:21 -0500890linkgit:gitdiffcore[7].