Documentation/config/diff.txt

   1 diff.autoRefreshIndex::
   2         When using 'git diff' to compare with work tree
   3         files, do not consider stat-only changes as changed.
   4         Instead, silently run `git update-index --refresh` to
   5         update the cached stat information for paths whose
   6         contents in the work tree match the contents in the
   7         index.  This option defaults to true.  Note that this
   8         affects only 'git diff' Porcelain, and not lower level
   9         'diff' commands such as 'git diff-files'.
  10
  11 diff.dirstat::
  12         A comma separated list of `--dirstat` parameters specifying the
  13         default behavior of the `--dirstat` option to linkgit:git-diff[1]
  14         and friends. The defaults can be overridden on the command line
  15         (using `--dirstat=<param1,param2,...>`). The fallback defaults
  16         (when not changed by `diff.dirstat`) are `changes,noncumulative,3`.
  17         The following parameters are available:
  18 +
  19 --
  20 `changes`;;
  21         Compute the dirstat numbers by counting the lines that have been
  22         removed from the source, or added to the destination. This ignores
  23         the amount of pure code movements within a file.  In other words,
  24         rearranging lines in a file is not counted as much as other changes.
  25         This is the default behavior when no parameter is given.
  26 `lines`;;
  27         Compute the dirstat numbers by doing the regular line-based diff
  28         analysis, and summing the removed/added line counts. (For binary
  29         files, count 64-byte chunks instead, since binary files have no
  30         natural concept of lines). This is a more expensive `--dirstat`
  31         behavior than the `changes` behavior, but it does count rearranged
  32         lines within a file as much as other changes. The resulting output
  33         is consistent with what you get from the other `--*stat` options.
  34 `files`;;
  35         Compute the dirstat numbers by counting the number of files changed.
  36         Each changed file counts equally in the dirstat analysis. This is
  37         the computationally cheapest `--dirstat` behavior, since it does
  38         not have to look at the file contents at all.
  39 `cumulative`;;
  40         Count changes in a child directory for the parent directory as well.
  41         Note that when using `cumulative`, the sum of the percentages
  42         reported may exceed 100%. The default (non-cumulative) behavior can
  43         be specified with the `noncumulative` parameter.
  44 <limit>;;
  45         An integer parameter specifies a cut-off percent (3% by default).
  46         Directories contributing less than this percentage of the changes
  47         are not shown in the output.
  48 --
  49 +
  50 Example: The following will count changed files, while ignoring
  51 directories with less than 10% of the total amount of changed files,
  52 and accumulating child directory counts in the parent directories:
  53 `files,10,cumulative`.
  54
  55 diff.statNameWidth::
  56         Limit the width of the filename part in --stat output. If set, applies
  57         to all commands generating --stat output except format-patch.
  58
  59 diff.statGraphWidth::
  60         Limit the width of the graph part in --stat output. If set, applies
  61         to all commands generating --stat output except format-patch.
  62
  63 diff.context::
  64         Generate diffs with <n> lines of context instead of the default
  65         of 3. This value is overridden by the -U option.
  66
  67 diff.interHunkContext::
  68         Show the context between diff hunks, up to the specified number
  69         of lines, thereby fusing the hunks that are close to each other.
  70         This value serves as the default for the `--inter-hunk-context`
  71         command line option.
  72
  73 diff.external::
  74         If this config variable is set, diff generation is not
  75         performed using the internal diff machinery, but using the
  76         given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
  77         environment variable.  The command is called with parameters
  78         as described under "git Diffs" in linkgit:git[1].  Note: if
  79         you want to use an external diff program only on a subset of
  80         your files, you might want to use linkgit:gitattributes[5] instead.
  81
  82 diff.ignoreSubmodules::
  83         Sets the default value of --ignore-submodules. Note that this
  84         affects only 'git diff' Porcelain, and not lower level 'diff'
  85         commands such as 'git diff-files'. 'git checkout'
  86         and 'git switch' also honor
  87         this setting when reporting uncommitted changes. Setting it to
  88         'all' disables the submodule summary normally shown by 'git commit'
  89         and 'git status' when `status.submoduleSummary` is set unless it is
  90         overridden by using the --ignore-submodules command-line option.
  91         The 'git submodule' commands are not affected by this setting.
  92         By default this is set to untracked so that any untracked
  93         submodules are ignored.
  94
  95 diff.mnemonicPrefix::
  96         If set, 'git diff' uses a prefix pair that is different from the
  97         standard "a/" and "b/" depending on what is being compared.  When
  98         this configuration is in effect, reverse diff output also swaps
  99         the order of the prefixes:
 100 `git diff`;;
 101         compares the (i)ndex and the (w)ork tree;
 102 `git diff HEAD`;;
 103          compares a (c)ommit and the (w)ork tree;
 104 `git diff --cached`;;
 105         compares a (c)ommit and the (i)ndex;
 106 `git diff HEAD:file1 file2`;;
 107         compares an (o)bject and a (w)ork tree entity;
 108 `git diff --no-index a b`;;
 109         compares two non-git things (1) and (2).
 110
 111 diff.noPrefix::
 112         If set, 'git diff' does not show any source or destination prefix.
 113
 114 diff.srcPrefix::
 115         If set, 'git diff' uses this source prefix. Defaults to "a/".
 116
 117 diff.dstPrefix::
 118         If set, 'git diff' uses this destination prefix. Defaults to "b/".
 119
 120 diff.relative::
 121         If set to 'true', 'git diff' does not show changes outside of the directory
 122         and show pathnames relative to the current directory.
 123
 124 diff.orderFile::
 125         File indicating how to order files within a diff.
 126         See the '-O' option to linkgit:git-diff[1] for details.
 127         If `diff.orderFile` is a relative pathname, it is treated as
 128         relative to the top of the working tree.
 129
 130 diff.renameLimit::
 131         The number of files to consider in the exhaustive portion of
 132         copy/rename detection; equivalent to the 'git diff' option
 133         `-l`.  If not set, the default value is currently 1000.  This
 134         setting has no effect if rename detection is turned off.
 135
 136 diff.renames::
 137         Whether and how Git detects renames.  If set to "false",
 138         rename detection is disabled. If set to "true", basic rename
 139         detection is enabled.  If set to "copies" or "copy", Git will
 140         detect copies, as well.  Defaults to true.  Note that this
 141         affects only 'git diff' Porcelain like linkgit:git-diff[1] and
 142         linkgit:git-log[1], and not lower level commands such as
 143         linkgit:git-diff-files[1].
 144
 145 diff.suppressBlankEmpty::
 146         A boolean to inhibit the standard behavior of printing a space
 147         before each empty output line. Defaults to false.
 148
 149 diff.submodule::
 150         Specify the format in which differences in submodules are
 151         shown.  The "short" format just shows the names of the commits
 152         at the beginning and end of the range. The "log" format lists
 153         the commits in the range like linkgit:git-submodule[1] `summary`
 154         does. The "diff" format shows an inline diff of the changed
 155         contents of the submodule. Defaults to "short".
 156
 157 diff.wordRegex::
 158         A POSIX Extended Regular Expression used to determine what is a "word"
 159         when performing word-by-word difference calculations.  Character
 160         sequences that match the regular expression are "words", all other
 161         characters are *ignorable* whitespace.
 162
 163 diff.<driver>.command::
 164         The custom diff driver command.  See linkgit:gitattributes[5]
 165         for details.
 166
 167 diff.<driver>.xfuncname::
 168         The regular expression that the diff driver should use to
 169         recognize the hunk header.  A built-in pattern may also be used.
 170         See linkgit:gitattributes[5] for details.
 171
 172 diff.<driver>.binary::
 173         Set this option to true to make the diff driver treat files as
 174         binary.  See linkgit:gitattributes[5] for details.
 175
 176 diff.<driver>.textconv::
 177         The command that the diff driver should call to generate the
 178         text-converted version of a file.  The result of the
 179         conversion is used to generate a human-readable diff.  See
 180         linkgit:gitattributes[5] for details.
 181
 182 diff.<driver>.wordRegex::
 183         The regular expression that the diff driver should use to
 184         split words in a line.  See linkgit:gitattributes[5] for
 185         details.
 186
 187 diff.<driver>.cachetextconv::
 188         Set this option to true to make the diff driver cache the text
 189         conversion outputs.  See linkgit:gitattributes[5] for details.
 190
 191 include::../mergetools-diff.txt[]
 192
 193 diff.indentHeuristic::
 194         Set this option to `false` to disable the default heuristics
 195         that shift diff hunk boundaries to make patches easier to read.
 196
 197 diff.algorithm::
 198         Choose a diff algorithm.  The variants are as follows:
 199 +
 200 --
 201 `default`, `myers`;;
 202         The basic greedy diff algorithm. Currently, this is the default.
 203 `minimal`;;
 204         Spend extra time to make sure the smallest possible diff is
 205         produced.
 206 `patience`;;
 207         Use "patience diff" algorithm when generating patches.
 208 `histogram`;;
 209         This algorithm extends the patience algorithm to "support
 210         low-occurrence common elements".
 211 --
 212 +
 213
 214 diff.wsErrorHighlight::
 215         Highlight whitespace errors in the `context`, `old` or `new`
 216         lines of the diff.  Multiple values are separated by comma,
 217         `none` resets previous values, `default` reset the list to
 218         `new` and `all` is a shorthand for `old,new,context`.  The
 219         whitespace errors are colored with `color.diff.whitespace`.
 220         The command line option `--ws-error-highlight=<kind>`
 221         overrides this setting.
 222
 223 diff.colorMoved::
 224         If set to either a valid `<mode>` or a true value, moved lines
 225         in a diff are colored differently, for details of valid modes
 226         see '--color-moved' in linkgit:git-diff[1]. If simply set to
 227         true the default color mode will be used. When set to false,
 228         moved lines are not colored.
 229
 230 diff.colorMovedWS::
 231         When moved lines are colored using e.g. the `diff.colorMoved` setting,
 232         this option controls the `<mode>` how spaces are treated.
 233         For details of valid modes see '--color-moved-ws' in linkgit:git-diff[1].