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