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 is 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), never, or auto.
 124
 125 --no-color::
 126         Turn off colored diff, even when the configuration file
 127         gives the default to color output.
 128         Same as `--color=never`.
 129
 130 --color-words[=<regex>]::
 131         Show colored word diff, i.e., color words which have changed.
 132         By default, words are separated by whitespace.
 133 +
 134 When a <regex> is specified, every non-overlapping match of the
 135 <regex> is considered a word.  Anything between these matches is
 136 considered whitespace and ignored(!) for the purposes of finding
 137 differences.  You may want to append `|[^[:space:]]` to your regular
 138 expression to make sure that it matches all non-whitespace characters.
 139 A match that contains a newline is silently truncated(!) at the
 140 newline.
 141 +
 142 The regex can also be set via a diff driver or configuration option, see
 143 linkgit:gitattributes[1] or linkgit:git-config[1].  Giving it explicitly
 144 overrides any diff driver or configuration setting.  Diff drivers
 145 override configuration settings.
 146 endif::git-format-patch[]
 147
 148 --no-renames::
 149         Turn off rename detection, even when the configuration
 150         file gives the default to do so.
 151
 152 ifndef::git-format-patch[]
 153 --check::
 154         Warn if changes introduce trailing whitespace
 155         or an indent that uses a space before a tab. Exits with
 156         non-zero status if problems are found. Not compatible with
 157         --exit-code.
 158 endif::git-format-patch[]
 159
 160 --full-index::
 161         Instead of the first handful of characters, show the full
 162         pre- and post-image blob object names on the "index"
 163         line when generating patch format output.
 164
 165 --binary::
 166         In addition to `--full-index`, output a binary diff that
 167         can be applied with `git-apply`.
 168
 169 --abbrev[=<n>]::
 170         Instead of showing the full 40-byte hexadecimal object
 171         name in diff-raw format output and diff-tree header
 172         lines, show only a partial prefix.  This is
 173         independent of the `--full-index` option above, which controls
 174         the diff-patch output format.  Non default number of
 175         digits can be specified with `--abbrev=<n>`.
 176
 177 -B::
 178         Break complete rewrite changes into pairs of delete and create.
 179
 180 -M::
 181         Detect renames.
 182
 183 -C::
 184         Detect copies as well as renames.  See also `--find-copies-harder`.
 185
 186 ifndef::git-format-patch[]
 187 --diff-filter=[ACDMRTUXB*]::
 188         Select only files that are Added (`A`), Copied (`C`),
 189         Deleted (`D`), Modified (`M`), Renamed (`R`), have their
 190         type (i.e. regular file, symlink, submodule, ...) changed (`T`),
 191         are Unmerged (`U`), are
 192         Unknown (`X`), or have had their pairing Broken (`B`).
 193         Any combination of the filter characters may be used.
 194         When `*` (All-or-none) is added to the combination, all
 195         paths are selected if there is any file that matches
 196         other criteria in the comparison; if there is no file
 197         that matches other criteria, nothing is selected.
 198 endif::git-format-patch[]
 199
 200 --find-copies-harder::
 201         For performance reasons, by default, `-C` option finds copies only
 202         if the original file of the copy was modified in the same
 203         changeset.  This flag makes the command
 204         inspect unmodified files as candidates for the source of
 205         copy.  This is a very expensive operation for large
 206         projects, so use it with caution.  Giving more than one
 207         `-C` option has the same effect.
 208
 209 -l<num>::
 210         The `-M` and `-C` options require O(n^2) processing time where n
 211         is the number of potential rename/copy targets.  This
 212         option prevents rename/copy detection from running if
 213         the number of rename/copy targets exceeds the specified
 214         number.
 215
 216 ifndef::git-format-patch[]
 217 -S<string>::
 218         Look for differences that introduce or remove an instance of
 219         <string>. Note that this is different than the string simply
 220         appearing in diff output; see the 'pickaxe' entry in
 221         linkgit:gitdiffcore[7] for more details.
 222
 223 --pickaxe-all::
 224         When `-S` finds a change, show all the changes in that
 225         changeset, not just the files that contain the change
 226         in <string>.
 227
 228 --pickaxe-regex::
 229         Make the <string> not a plain string but an extended POSIX
 230         regex to match.
 231 endif::git-format-patch[]
 232
 233 -O<orderfile>::
 234         Output the patch in the order specified in the
 235         <orderfile>, which has one shell glob pattern per line.
 236
 237 ifndef::git-format-patch[]
 238 -R::
 239         Swap two inputs; that is, show differences from index or
 240         on-disk file to tree contents.
 241
 242 --relative[=<path>]::
 243         When run from a subdirectory of the project, it can be
 244         told to exclude changes outside the directory and show
 245         pathnames relative to it with this option.  When you are
 246         not in a subdirectory (e.g. in a bare repository), you
 247         can name which subdirectory to make the output relative
 248         to by giving a <path> as an argument.
 249 endif::git-format-patch[]
 250
 251 -a::
 252 --text::
 253         Treat all files as text.
 254
 255 --ignore-space-at-eol::
 256         Ignore changes in whitespace at EOL.
 257
 258 -b::
 259 --ignore-space-change::
 260         Ignore changes in amount of whitespace.  This ignores whitespace
 261         at line end, and considers all other sequences of one or
 262         more whitespace characters to be equivalent.
 263
 264 -w::
 265 --ignore-all-space::
 266         Ignore whitespace when comparing lines.  This ignores
 267         differences even if one line has whitespace where the other
 268         line has none.
 269
 270 --inter-hunk-context=<lines>::
 271         Show the context between diff hunks, up to the specified number
 272         of lines, thereby fusing hunks that are close to each other.
 273
 274 ifndef::git-format-patch[]
 275 --exit-code::
 276         Make the program exit with codes similar to diff(1).
 277         That is, it exits with 1 if there were differences and
 278         0 means no differences.
 279
 280 --quiet::
 281         Disable all output of the program. Implies `--exit-code`.
 282 endif::git-format-patch[]
 283
 284 --ext-diff::
 285         Allow an external diff helper to be executed. If you set an
 286         external diff driver with linkgit:gitattributes[5], you need
 287         to use this option with linkgit:git-log[1] and friends.
 288
 289 --no-ext-diff::
 290         Disallow external diff drivers.
 291
 292 --ignore-submodules::
 293         Ignore changes to submodules in the diff generation.
 294
 295 --src-prefix=<prefix>::
 296         Show the given source prefix instead of "a/".
 297
 298 --dst-prefix=<prefix>::
 299         Show the given destination prefix instead of "b/".
 300
 301 --no-prefix::
 302         Do not show any source or destination prefix.
 303
 304 For more detailed explanation on these common options, see also
 305 linkgit:gitdiffcore[7].