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.trustExitCode::
  83         If this boolean value is set to true then the
  84         `diff.external` command is expected to return exit code
  85         0 if it considers the input files to be equal or 1 if it
  86         considers them to be different, like `diff(1)`.
  87         If it is set to false, which is the default, then the command
  88         is expected to return exit code 0 regardless of equality.
  89         Any other exit code causes Git to report a fatal error.
  90
  91 diff.ignoreSubmodules::
  92         Sets the default value of --ignore-submodules. Note that this
  93         affects only 'git diff' Porcelain, and not lower level 'diff'
  94         commands such as 'git diff-files'. 'git checkout'
  95         and 'git switch' also honor
  96         this setting when reporting uncommitted changes. Setting it to
  97         'all' disables the submodule summary normally shown by 'git commit'
  98         and 'git status' when `status.submoduleSummary` is set unless it is
  99         overridden by using the --ignore-submodules command-line option.
 100         The 'git submodule' commands are not affected by this setting.
 101         By default this is set to untracked so that any untracked
 102         submodules are ignored.
 103
 104 diff.mnemonicPrefix::
 105         If set, 'git diff' uses a prefix pair that is different from the
 106         standard "a/" and "b/" depending on what is being compared.  When
 107         this configuration is in effect, reverse diff output also swaps
 108         the order of the prefixes:
 109 `git diff`;;
 110         compares the (i)ndex and the (w)ork tree;
 111 `git diff HEAD`;;
 112          compares a (c)ommit and the (w)ork tree;
 113 `git diff --cached`;;
 114         compares a (c)ommit and the (i)ndex;
 115 `git diff HEAD:file1 file2`;;
 116         compares an (o)bject and a (w)ork tree entity;
 117 `git diff --no-index a b`;;
 118         compares two non-git things (1) and (2).
 119
 120 diff.noPrefix::
 121         If set, 'git diff' does not show any source or destination prefix.
 122
 123 diff.srcPrefix::
 124         If set, 'git diff' uses this source prefix. Defaults to "a/".
 125
 126 diff.dstPrefix::
 127         If set, 'git diff' uses this destination prefix. Defaults to "b/".
 128
 129 diff.relative::
 130         If set to 'true', 'git diff' does not show changes outside of the directory
 131         and show pathnames relative to the current directory.
 132
 133 diff.orderFile::
 134         File indicating how to order files within a diff.
 135         See the '-O' option to linkgit:git-diff[1] for details.
 136         If `diff.orderFile` is a relative pathname, it is treated as
 137         relative to the top of the working tree.
 138
 139 diff.renameLimit::
 140         The number of files to consider in the exhaustive portion of
 141         copy/rename detection; equivalent to the 'git diff' option
 142         `-l`.  If not set, the default value is currently 1000.  This
 143         setting has no effect if rename detection is turned off.
 144
 145 diff.renames::
 146         Whether and how Git detects renames.  If set to "false",
 147         rename detection is disabled. If set to "true", basic rename
 148         detection is enabled.  If set to "copies" or "copy", Git will
 149         detect copies, as well.  Defaults to true.  Note that this
 150         affects only 'git diff' Porcelain like linkgit:git-diff[1] and
 151         linkgit:git-log[1], and not lower level commands such as
 152         linkgit:git-diff-files[1].
 153
 154 diff.suppressBlankEmpty::
 155         A boolean to inhibit the standard behavior of printing a space
 156         before each empty output line. Defaults to false.
 157
 158 diff.submodule::
 159         Specify the format in which differences in submodules are
 160         shown.  The "short" format just shows the names of the commits
 161         at the beginning and end of the range. The "log" format lists
 162         the commits in the range like linkgit:git-submodule[1] `summary`
 163         does. The "diff" format shows an inline diff of the changed
 164         contents of the submodule. Defaults to "short".
 165
 166 diff.wordRegex::
 167         A POSIX Extended Regular Expression used to determine what is a "word"
 168         when performing word-by-word difference calculations.  Character
 169         sequences that match the regular expression are "words", all other
 170         characters are *ignorable* whitespace.
 171
 172 diff.<driver>.command::
 173         The custom diff driver command.  See linkgit:gitattributes[5]
 174         for details.
 175
 176 diff.<driver>.trustExitCode::
 177         If this boolean value is set to true then the
 178         `diff.<driver>.command` command is expected to return exit code
 179         0 if it considers the input files to be equal or 1 if it
 180         considers them to be different, like `diff(1)`.
 181         If it is set to false, which is the default, then the command
 182         is expected to return exit code 0 regardless of equality.
 183         Any other exit code causes Git to report a fatal error.
 184
 185 diff.<driver>.xfuncname::
 186         The regular expression that the diff driver should use to
 187         recognize the hunk header.  A built-in pattern may also be used.
 188         See linkgit:gitattributes[5] for details.
 189
 190 diff.<driver>.binary::
 191         Set this option to true to make the diff driver treat files as
 192         binary.  See linkgit:gitattributes[5] for details.
 193
 194 diff.<driver>.textconv::
 195         The command that the diff driver should call to generate the
 196         text-converted version of a file.  The result of the
 197         conversion is used to generate a human-readable diff.  See
 198         linkgit:gitattributes[5] for details.
 199
 200 diff.<driver>.wordRegex::
 201         The regular expression that the diff driver should use to
 202         split words in a line.  See linkgit:gitattributes[5] for
 203         details.
 204
 205 diff.<driver>.cachetextconv::
 206         Set this option to true to make the diff driver cache the text
 207         conversion outputs.  See linkgit:gitattributes[5] for details.
 208
 209 include::../mergetools-diff.txt[]
 210
 211 diff.indentHeuristic::
 212         Set this option to `false` to disable the default heuristics
 213         that shift diff hunk boundaries to make patches easier to read.
 214
 215 diff.algorithm::
 216         Choose a diff algorithm.  The variants are as follows:
 217 +
 218 --
 219 `default`, `myers`;;
 220         The basic greedy diff algorithm. Currently, this is the default.
 221 `minimal`;;
 222         Spend extra time to make sure the smallest possible diff is
 223         produced.
 224 `patience`;;
 225         Use "patience diff" algorithm when generating patches.
 226 `histogram`;;
 227         This algorithm extends the patience algorithm to "support
 228         low-occurrence common elements".
 229 --
 230 +
 231
 232 diff.wsErrorHighlight::
 233         Highlight whitespace errors in the `context`, `old` or `new`
 234         lines of the diff.  Multiple values are separated by comma,
 235         `none` resets previous values, `default` reset the list to
 236         `new` and `all` is a shorthand for `old,new,context`.  The
 237         whitespace errors are colored with `color.diff.whitespace`.
 238         The command line option `--ws-error-highlight=<kind>`
 239         overrides this setting.
 240
 241 diff.colorMoved::
 242         If set to either a valid `<mode>` or a true value, moved lines
 243         in a diff are colored differently, for details of valid modes
 244         see '--color-moved' in linkgit:git-diff[1]. If simply set to
 245         true the default color mode will be used. When set to false,
 246         moved lines are not colored.
 247
 248 diff.colorMovedWS::
 249         When moved lines are colored using e.g. the `diff.colorMoved` setting,
 250         this option controls the `<mode>` how spaces are treated.
 251         For details of valid modes see '--color-moved-ws' in linkgit:git-diff[1].