Documentation / diff-config.txton commit docs/config: consistify include.path examples (ce933eb)
   1diff.autoRefreshIndex::
   2        When using 'git diff' to compare with work tree
   3        files, do not consider stat-only change 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
  11diff.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+
  50Example: The following will count changed files, while ignoring
  51directories with less than 10% of the total amount of changed files,
  52and accumulating child directory counts in the parent directories:
  53`files,10,cumulative`.
  54
  55diff.statGraphWidth::
  56        Limit the width of the graph part in --stat output. If set, applies
  57        to all commands generating --stat output except format-patch.
  58
  59diff.context::
  60        Generate diffs with <n> lines of context instead of the default
  61        of 3. This value is overridden by the -U option.
  62
  63diff.interHunkContext::
  64        Show the context between diff hunks, up to the specified number
  65        of lines, thereby fusing the hunks that are close to each other.
  66        This value serves as the default for the `--inter-hunk-context`
  67        command line option.
  68
  69diff.external::
  70        If this config variable is set, diff generation is not
  71        performed using the internal diff machinery, but using the
  72        given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
  73        environment variable.  The command is called with parameters
  74        as described under "git Diffs" in linkgit:git[1].  Note: if
  75        you want to use an external diff program only on a subset of
  76        your files, you might want to use linkgit:gitattributes[5] instead.
  77
  78diff.ignoreSubmodules::
  79        Sets the default value of --ignore-submodules. Note that this
  80        affects only 'git diff' Porcelain, and not lower level 'diff'
  81        commands such as 'git diff-files'. 'git checkout' also honors
  82        this setting when reporting uncommitted changes. Setting it to
  83        'all' disables the submodule summary normally shown by 'git commit'
  84        and 'git status' when `status.submoduleSummary` is set unless it is
  85        overridden by using the --ignore-submodules command-line option.
  86        The 'git submodule' commands are not affected by this setting.
  87
  88diff.mnemonicPrefix::
  89        If set, 'git diff' uses a prefix pair that is different from the
  90        standard "a/" and "b/" depending on what is being compared.  When
  91        this configuration is in effect, reverse diff output also swaps
  92        the order of the prefixes:
  93`git diff`;;
  94        compares the (i)ndex and the (w)ork tree;
  95`git diff HEAD`;;
  96         compares a (c)ommit and the (w)ork tree;
  97`git diff --cached`;;
  98        compares a (c)ommit and the (i)ndex;
  99`git diff HEAD:file1 file2`;;
 100        compares an (o)bject and a (w)ork tree entity;
 101`git diff --no-index a b`;;
 102        compares two non-git things (1) and (2).
 103
 104diff.noprefix::
 105        If set, 'git diff' does not show any source or destination prefix.
 106
 107diff.orderFile::
 108        File indicating how to order files within a diff.
 109        See the '-O' option to linkgit:git-diff[1] for details.
 110        If `diff.orderFile` is a relative pathname, it is treated as
 111        relative to the top of the working tree.
 112
 113diff.renameLimit::
 114        The number of files to consider when performing the copy/rename
 115        detection; equivalent to the 'git diff' option `-l`.
 116
 117diff.renames::
 118        Whether and how Git detects renames.  If set to "false",
 119        rename detection is disabled. If set to "true", basic rename
 120        detection is enabled.  If set to "copies" or "copy", Git will
 121        detect copies, as well.  Defaults to true.  Note that this
 122        affects only 'git diff' Porcelain like linkgit:git-diff[1] and
 123        linkgit:git-log[1], and not lower level commands such as
 124        linkgit:git-diff-files[1].
 125
 126diff.suppressBlankEmpty::
 127        A boolean to inhibit the standard behavior of printing a space
 128        before each empty output line. Defaults to false.
 129
 130diff.submodule::
 131        Specify the format in which differences in submodules are
 132        shown.  The "short" format just shows the names of the commits
 133        at the beginning and end of the range. The "log" format lists
 134        the commits in the range like linkgit:git-submodule[1] `summary`
 135        does. The "diff" format shows an inline diff of the changed
 136        contents of the submodule. Defaults to "short".
 137
 138diff.wordRegex::
 139        A POSIX Extended Regular Expression used to determine what is a "word"
 140        when performing word-by-word difference calculations.  Character
 141        sequences that match the regular expression are "words", all other
 142        characters are *ignorable* whitespace.
 143
 144diff.<driver>.command::
 145        The custom diff driver command.  See linkgit:gitattributes[5]
 146        for details.
 147
 148diff.<driver>.xfuncname::
 149        The regular expression that the diff driver should use to
 150        recognize the hunk header.  A built-in pattern may also be used.
 151        See linkgit:gitattributes[5] for details.
 152
 153diff.<driver>.binary::
 154        Set this option to true to make the diff driver treat files as
 155        binary.  See linkgit:gitattributes[5] for details.
 156
 157diff.<driver>.textconv::
 158        The command that the diff driver should call to generate the
 159        text-converted version of a file.  The result of the
 160        conversion is used to generate a human-readable diff.  See
 161        linkgit:gitattributes[5] for details.
 162
 163diff.<driver>.wordRegex::
 164        The regular expression that the diff driver should use to
 165        split words in a line.  See linkgit:gitattributes[5] for
 166        details.
 167
 168diff.<driver>.cachetextconv::
 169        Set this option to true to make the diff driver cache the text
 170        conversion outputs.  See linkgit:gitattributes[5] for details.
 171
 172diff.tool::
 173        Controls which diff tool is used by linkgit:git-difftool[1].
 174        This variable overrides the value configured in `merge.tool`.
 175        The list below shows the valid built-in values.
 176        Any other value is treated as a custom diff tool and requires
 177        that a corresponding difftool.<tool>.cmd variable is defined.
 178
 179include::mergetools-diff.txt[]
 180
 181diff.indentHeuristic::
 182        Set this option to `true` to enable experimental heuristics
 183        that shift diff hunk boundaries to make patches easier to read.
 184
 185diff.algorithm::
 186        Choose a diff algorithm.  The variants are as follows:
 187+
 188--
 189`default`, `myers`;;
 190        The basic greedy diff algorithm. Currently, this is the default.
 191`minimal`;;
 192        Spend extra time to make sure the smallest possible diff is
 193        produced.
 194`patience`;;
 195        Use "patience diff" algorithm when generating patches.
 196`histogram`;;
 197        This algorithm extends the patience algorithm to "support
 198        low-occurrence common elements".
 199--
 200+
 201
 202diff.wsErrorHighlight::
 203        A comma separated list of `old`, `new`, `context`, that
 204        specifies how whitespace errors on lines are highlighted
 205        with `color.diff.whitespace`.  Can be overridden by the
 206        command line option `--ws-error-highlight=<kind>`