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