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