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