Merge branch 'mg/x-years-12-months'
[git/jnareb-git.git] / Documentation / diff-config.txt
blob2b1605f5c8f07b96f8e8c27a65717fca6046d613
1 diff.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'.
11 diff.external::
12         If this config variable is set, diff generation is not
13         performed using the internal diff machinery, but using the
14         given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
15         environment variable.  The command is called with parameters
16         as described under "git Diffs" in linkgit:git[1].  Note: if
17         you want to use an external diff program only on a subset of
18         your files, you might want to use linkgit:gitattributes[5] instead.
20 diff.ignoreSubmodules::
21         Sets the default value of --ignore-submodules. Note that this
22         affects only 'git diff' Porcelain, and not lower level 'diff'
23         commands such as 'git diff-files'. 'git checkout' also honors
24         this setting when reporting uncommitted changes.
26 diff.mnemonicprefix::
27         If set, 'git diff' uses a prefix pair that is different from the
28         standard "a/" and "b/" depending on what is being compared.  When
29         this configuration is in effect, reverse diff output also swaps
30         the order of the prefixes:
31 `git diff`;;
32         compares the (i)ndex and the (w)ork tree;
33 `git diff HEAD`;;
34          compares a (c)ommit and the (w)ork tree;
35 `git diff --cached`;;
36         compares a (c)ommit and the (i)ndex;
37 `git diff HEAD:file1 file2`;;
38         compares an (o)bject and a (w)ork tree entity;
39 `git diff --no-index a b`;;
40         compares two non-git things (1) and (2).
42 diff.noprefix::
43         If set, 'git diff' does not show any source or destination prefix.
45 diff.renameLimit::
46         The number of files to consider when performing the copy/rename
47         detection; equivalent to the 'git diff' option '-l'.
49 diff.renames::
50         Tells git to detect renames.  If set to any boolean value, it
51         will enable basic rename detection.  If set to "copies" or
52         "copy", it will detect copies, as well.
54 diff.suppressBlankEmpty::
55         A boolean to inhibit the standard behavior of printing a space
56         before each empty output line. Defaults to false.
58 diff.<driver>.command::
59         The custom diff driver command.  See linkgit:gitattributes[5]
60         for details.
62 diff.<driver>.xfuncname::
63         The regular expression that the diff driver should use to
64         recognize the hunk header.  A built-in pattern may also be used.
65         See linkgit:gitattributes[5] for details.
67 diff.<driver>.binary::
68         Set this option to true to make the diff driver treat files as
69         binary.  See linkgit:gitattributes[5] for details.
71 diff.<driver>.textconv::
72         The command that the diff driver should call to generate the
73         text-converted version of a file.  The result of the
74         conversion is used to generate a human-readable diff.  See
75         linkgit:gitattributes[5] for details.
77 diff.<driver>.wordregex::
78         The regular expression that the diff driver should use to
79         split words in a line.  See linkgit:gitattributes[5] for
80         details.
82 diff.<driver>.cachetextconv::
83         Set this option to true to make the diff driver cache the text
84         conversion outputs.  See linkgit:gitattributes[5] for details.
86 diff.tool::
87         The diff tool to be used by linkgit:git-difftool[1].  This
88         option overrides `merge.tool`, and has the same valid built-in
89         values as `merge.tool` minus "tortoisemerge" and plus
90         "kompare".  Any other value is treated as a custom diff tool,
91         and there must be a corresponding `difftool.<tool>.cmd`
92         option.