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