Documentation/diff-options.txt

   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[]
   9 ifndef::git-log[]
  10 :git-diff-core: 1
  11 endif::git-log[]
  12 endif::git-diff[]
  13 endif::git-format-patch[]
  14
  15 ifdef::git-format-patch[]
  16 -p::
  17 --no-stat::
  18         Generate plain patches without any diffstats.
  19 endif::git-format-patch[]
  20
  21 ifndef::git-format-patch[]
  22 -p::
  23 -u::
  24 --patch::
  25         Generate patch (see section on generating patches).
  26         {git-diff? This is the default.}
  27 endif::git-format-patch[]
  28
  29 -U<n>::
  30 --unified=<n>::
  31         Generate diffs with <n> lines of context instead of
  32         the usual three.
  33 ifndef::git-format-patch[]
  34         Implies `-p`.
  35 endif::git-format-patch[]
  36
  37 ifndef::git-format-patch[]
  38 --raw::
  39         Generate the raw format.
  40         {git-diff-core? This is the default.}
  41 endif::git-format-patch[]
  42
  43 ifndef::git-format-patch[]
  44 --patch-with-raw::
  45         Synonym for `-p --raw`.
  46 endif::git-format-patch[]
  47
  48 --patience::
  49         Generate a diff using the "patience diff" algorithm.
  50
  51 --stat[=<width>[,<name-width>]]::
  52         Generate a diffstat.  You can override the default
  53         output width for 80-column terminal by `--stat=<width>`.
  54         The width of the filename part can be controlled by
  55         giving another width to it separated by a comma.
  56
  57 --numstat::
  58         Similar to `\--stat`, but shows number of added and
  59         deleted lines in decimal notation and pathname without
  60         abbreviation, to make it more machine friendly.  For
  61         binary files, outputs two `-` instead of saying
  62         `0 0`.
  63
  64 --shortstat::
  65         Output only the last line of the `--stat` format containing total
  66         number of modified files, as well as number of added and deleted
  67         lines.
  68
  69 --dirstat[=<limit>]::
  70         Output the distribution of relative amount of changes (number of lines added or
  71         removed) for each sub-directory. Directories with changes below
  72         a cut-off percent (3% by default) are not shown. The cut-off percent
  73         can be set with `--dirstat=<limit>`. Changes in a child directory are not
  74         counted for the parent directory, unless `--cumulative` is used.
  75
  76 --dirstat-by-file[=<limit>]::
  77         Same as `--dirstat`, but counts changed files instead of lines.
  78
  79 --summary::
  80         Output a condensed summary of extended header information
  81         such as creations, renames and mode changes.
  82
  83 ifndef::git-format-patch[]
  84 --patch-with-stat::
  85         Synonym for `-p --stat`.
  86 endif::git-format-patch[]
  87
  88 ifndef::git-format-patch[]
  89
  90 -z::
  91 ifdef::git-log[]
  92         Separate the commits with NULs instead of with new newlines.
  93 +
  94 Also, when `--raw` or `--numstat` has been given, do not munge
  95 pathnames and use NULs as output field terminators.
  96 endif::git-log[]
  97 ifndef::git-log[]
  98         When `--raw`, `--numstat`, `--name-only` or `--name-status` has been
  99         given, do not munge pathnames and use NULs as output field terminators.
 100 endif::git-log[]
 101 +
 102 Without this option, each pathname output will have TAB, LF, double quotes,
 103 and backslash characters replaced with `\t`, `\n`, `\"`, and `\\`,
 104 respectively, and the pathname will be enclosed in double quotes if
 105 any of those replacements occurred.
 106
 107 --name-only::
 108         Show only names of changed files.
 109
 110 --name-status::
 111         Show only names and status of changed files. See the description
 112         of the `--diff-filter` option on what the status letters mean.
 113
 114 --submodule[=<format>]::
 115         Chose the output format for submodule differences. <format> can be one of
 116         'short' and 'log'. 'short' just shows pairs of commit names, this format
 117         is used when this option is not given. 'log' is the default value for this
 118         option and lists the commits in that commit range like the 'summary'
 119         option of linkgit:git-submodule[1] does.
 120
 121 --color[=<when>]::
 122         Show colored diff.
 123         The value must be `always` (the default for `<when>`), `never`, or `auto`.
 124         The default value is `never`.
 125 ifdef::git-diff[]
 126         It can be changed by the `color.ui` and `color.diff`
 127         configuration settings.
 128 endif::git-diff[]
 129
 130 --no-color::
 131         Turn off colored diff.
 132 ifdef::git-diff[]
 133         This can be used to override configuration settings.
 134 endif::git-diff[]
 135         It is the same as `--color=never`.
 136
 137 --word-diff[=<mode>]::
 138         Show a word diff, using the <mode> to delimit changed words.
 139         By default, words are delimited by whitespace; see
 140         `--word-diff-regex` below.  The <mode> defaults to 'plain', and
 141         must be one of:
 142 +
 143 --
 144 color::
 145         Highlight changed words using only colors.  Implies `--color`.
 146 plain::
 147         Show words as `[-removed-]` and `{+added+}`.  Makes no
 148         attempts to escape the delimiters if they appear in the input,
 149         so the output may be ambiguous.
 150 porcelain::
 151         Use a special line-based format intended for script
 152         consumption.  Added/removed/unchanged runs are printed in the
 153         usual unified diff format, starting with a `+`/`-`/` `
 154         character at the beginning of the line and extending to the
 155         end of the line.  Newlines in the input are represented by a
 156         tilde `~` on a line of its own.
 157 none::
 158         Disable word diff again.
 159 --
 160 +
 161 Note that despite the name of the first mode, color is used to
 162 highlight the changed parts in all modes if enabled.
 163
 164 --word-diff-regex=<regex>::
 165         Use <regex> to decide what a word is, instead of considering
 166         runs of non-whitespace to be a word.  Also implies
 167         `--word-diff` unless it was already enabled.
 168 +
 169 Every non-overlapping match of the
 170 <regex> is considered a word.  Anything between these matches is
 171 considered whitespace and ignored(!) for the purposes of finding
 172 differences.  You may want to append `|[^[:space:]]` to your regular
 173 expression to make sure that it matches all non-whitespace characters.
 174 A match that contains a newline is silently truncated(!) at the
 175 newline.
 176 +
 177 The regex can also be set via a diff driver or configuration option, see
 178 linkgit:gitattributes[1] or linkgit:git-config[1].  Giving it explicitly
 179 overrides any diff driver or configuration setting.  Diff drivers
 180 override configuration settings.
 181
 182 --color-words[=<regex>]::
 183         Equivalent to `--word-diff=color` plus (if a regex was
 184         specified) `--word-diff-regex=<regex>`.
 185 endif::git-format-patch[]
 186
 187 --no-renames::
 188         Turn off rename detection, even when the configuration
 189         file gives the default to do so.
 190
 191 ifndef::git-format-patch[]
 192 --check::
 193         Warn if changes introduce trailing whitespace
 194         or an indent that uses a space before a tab. Exits with
 195         non-zero status if problems are found. Not compatible with
 196         --exit-code.
 197 endif::git-format-patch[]
 198
 199 --full-index::
 200         Instead of the first handful of characters, show the full
 201         pre- and post-image blob object names on the "index"
 202         line when generating patch format output.
 203
 204 --binary::
 205         In addition to `--full-index`, output a binary diff that
 206         can be applied with `git-apply`.
 207
 208 --abbrev[=<n>]::
 209         Instead of showing the full 40-byte hexadecimal object
 210         name in diff-raw format output and diff-tree header
 211         lines, show only a partial prefix.  This is
 212         independent of the `--full-index` option above, which controls
 213         the diff-patch output format.  Non default number of
 214         digits can be specified with `--abbrev=<n>`.
 215
 216 -B[<n>][/<m>]::
 217 --break-rewrites[=[<n>][/<m>]]::
 218         Break complete rewrite changes into pairs of delete and
 219         create. This serves two purposes:
 220 +
 221 It affects the way a change that amounts to a total rewrite of a file
 222 not as a series of deletion and insertion mixed together with a very
 223 few lines that happen to match textually as the context, but as a
 224 single deletion of everything old followed by a single insertion of
 225 everything new, and the number `m` controls this aspect of the -B
 226 option (defaults to 60%). `-B/70%` specifies that less than 30% of the
 227 original should remain in the result for git to consider it a total
 228 rewrite (i.e. otherwise the resulting patch will be a series of
 229 deletion and insertion mixed together with context lines).
 230 +
 231 When used with -M, a totally-rewritten file is also considered as the
 232 source of a rename (usually -M only considers a file that disappeared
 233 as the source of a rename), and the number `n` controls this aspect of
 234 the -B option (defaults to 50%). `-B20%` specifies that a change with
 235 addition and deletion compared to 20% or more of the file's size are
 236 eligible for being picked up as a possible source of a rename to
 237 another file.
 238
 239 -M[<n>]::
 240 --find-renames[=<n>]::
 241 ifndef::git-log[]
 242         Detect renames.
 243 endif::git-log[]
 244 ifdef::git-log[]
 245         If generating diffs, detect and report renames for each commit.
 246         For following files across renames while traversing history, see
 247         `--follow`.
 248 endif::git-log[]
 249         If `n` is specified, it is a is a threshold on the similarity
 250         index (i.e. amount of addition/deletions compared to the
 251         file's size). For example, `-M90%` means git should consider a
 252         delete/add pair to be a rename if more than 90% of the file
 253         hasn't changed.
 254
 255 -C[<n>]::
 256 --find-copies[=<n>]::
 257         Detect copies as well as renames.  See also `--find-copies-harder`.
 258         If `n` is specified, it has the same meaning as for `-M<n>`.
 259
 260 --find-copies-harder::
 261         For performance reasons, by default, `-C` option finds copies only
 262         if the original file of the copy was modified in the same
 263         changeset.  This flag makes the command
 264         inspect unmodified files as candidates for the source of
 265         copy.  This is a very expensive operation for large
 266         projects, so use it with caution.  Giving more than one
 267         `-C` option has the same effect.
 268
 269 -l<num>::
 270         The `-M` and `-C` options require O(n^2) processing time where n
 271         is the number of potential rename/copy targets.  This
 272         option prevents rename/copy detection from running if
 273         the number of rename/copy targets exceeds the specified
 274         number.
 275
 276 ifndef::git-format-patch[]
 277 --diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]::
 278         Select only files that are Added (`A`), Copied (`C`),
 279         Deleted (`D`), Modified (`M`), Renamed (`R`), have their
 280         type (i.e. regular file, symlink, submodule, ...) changed (`T`),
 281         are Unmerged (`U`), are
 282         Unknown (`X`), or have had their pairing Broken (`B`).
 283         Any combination of the filter characters (including none) can be used.
 284         When `*` (All-or-none) is added to the combination, all
 285         paths are selected if there is any file that matches
 286         other criteria in the comparison; if there is no file
 287         that matches other criteria, nothing is selected.
 288
 289 -S<string>::
 290         Look for differences that introduce or remove an instance of
 291         <string>. Note that this is different than the string simply
 292         appearing in diff output; see the 'pickaxe' entry in
 293         linkgit:gitdiffcore[7] for more details.
 294
 295 -G<regex>::
 296         Look for differences whose added or removed line matches
 297         the given <regex>.
 298
 299 --pickaxe-all::
 300         When `-S` or `-G` finds a change, show all the changes in that
 301         changeset, not just the files that contain the change
 302         in <string>.
 303
 304 --pickaxe-regex::
 305         Make the <string> not a plain string but an extended POSIX
 306         regex to match.
 307 endif::git-format-patch[]
 308
 309 -O<orderfile>::
 310         Output the patch in the order specified in the
 311         <orderfile>, which has one shell glob pattern per line.
 312
 313 ifndef::git-format-patch[]
 314 -R::
 315         Swap two inputs; that is, show differences from index or
 316         on-disk file to tree contents.
 317
 318 --relative[=<path>]::
 319         When run from a subdirectory of the project, it can be
 320         told to exclude changes outside the directory and show
 321         pathnames relative to it with this option.  When you are
 322         not in a subdirectory (e.g. in a bare repository), you
 323         can name which subdirectory to make the output relative
 324         to by giving a <path> as an argument.
 325 endif::git-format-patch[]
 326
 327 -a::
 328 --text::
 329         Treat all files as text.
 330
 331 --ignore-space-at-eol::
 332         Ignore changes in whitespace at EOL.
 333
 334 -b::
 335 --ignore-space-change::
 336         Ignore changes in amount of whitespace.  This ignores whitespace
 337         at line end, and considers all other sequences of one or
 338         more whitespace characters to be equivalent.
 339
 340 -w::
 341 --ignore-all-space::
 342         Ignore whitespace when comparing lines.  This ignores
 343         differences even if one line has whitespace where the other
 344         line has none.
 345
 346 --inter-hunk-context=<lines>::
 347         Show the context between diff hunks, up to the specified number
 348         of lines, thereby fusing hunks that are close to each other.
 349
 350 ifndef::git-format-patch[]
 351 --exit-code::
 352         Make the program exit with codes similar to diff(1).
 353         That is, it exits with 1 if there were differences and
 354         0 means no differences.
 355
 356 --quiet::
 357         Disable all output of the program. Implies `--exit-code`.
 358 endif::git-format-patch[]
 359
 360 --ext-diff::
 361         Allow an external diff helper to be executed. If you set an
 362         external diff driver with linkgit:gitattributes[5], you need
 363         to use this option with linkgit:git-log[1] and friends.
 364
 365 --no-ext-diff::
 366         Disallow external diff drivers.
 367
 368 --ignore-submodules[=<when>]::
 369         Ignore changes to submodules in the diff generation. <when> can be
 370         either "none", "untracked", "dirty" or "all", which is the default
 371         Using "none" will consider the submodule modified when it either contains
 372         untracked or modified files or its HEAD differs from the commit recorded
 373         in the superproject and can be used to override any settings of the
 374         'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
 375         "untracked" is used submodules are not considered dirty when they only
 376         contain untracked content (but they are still scanned for modified
 377         content). Using "dirty" ignores all changes to the work tree of submodules,
 378         only changes to the commits stored in the superproject are shown (this was
 379         the behavior until 1.7.0). Using "all" hides all changes to submodules.
 380
 381 --src-prefix=<prefix>::
 382         Show the given source prefix instead of "a/".
 383
 384 --dst-prefix=<prefix>::
 385         Show the given destination prefix instead of "b/".
 386
 387 --no-prefix::
 388         Do not show any source or destination prefix.
 389
 390 For more detailed explanation on these common options, see also
 391 linkgit:gitdiffcore[7].