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