Skip to content

Commit 17a2f02

Browse files
committed
doc: git-diff: apply format changes to config part
Signed-off-by: Jean-Noël Avila <[email protected]>
1 parent daed146 commit 17a2f02

File tree

1 file changed

+82
-81
lines changed

1 file changed

+82
-81
lines changed

Documentation/config/diff.txt

Lines changed: 82 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
diff.autoRefreshIndex::
2-
When using 'git diff' to compare with work tree
1+
`diff.autoRefreshIndex`::
2+
When using `git diff` to compare with work tree
33
files, do not consider stat-only changes as changed.
44
Instead, silently run `git update-index --refresh` to
55
update the cached stat information for paths whose
66
contents in the work tree match the contents in the
77
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'.
8+
affects only `git diff` Porcelain, and not lower level
9+
`diff` commands such as '`git diff-files`.
1010

11-
diff.dirstat::
11+
`diff.dirstat`::
1212
A comma separated list of `--dirstat` parameters specifying the
1313
default behavior of the `--dirstat` option to linkgit:git-diff[1]
1414
and friends. The defaults can be overridden on the command line
15-
(using `--dirstat=<param1,param2,...>`). The fallback defaults
15+
(using `--dirstat=<param>,...`). The fallback defaults
1616
(when not changed by `diff.dirstat`) are `changes,noncumulative,3`.
1717
The following parameters are available:
1818
+
@@ -41,7 +41,7 @@ diff.dirstat::
4141
Note that when using `cumulative`, the sum of the percentages
4242
reported may exceed 100%. The default (non-cumulative) behavior can
4343
be specified with the `noncumulative` parameter.
44-
<limit>;;
44+
_<limit>_;;
4545
An integer parameter specifies a cut-off percent (3% by default).
4646
Directories contributing less than this percentage of the changes
4747
are not shown in the output.
@@ -52,57 +52,57 @@ directories with less than 10% of the total amount of changed files,
5252
and accumulating child directory counts in the parent directories:
5353
`files,10,cumulative`.
5454

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.
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`.
5858

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.
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`.
6262

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.
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.
6666

67-
diff.interHunkContext::
67+
`diff.interHunkContext`::
6868
Show the context between diff hunks, up to the specified number
6969
of lines, thereby fusing the hunks that are close to each other.
7070
This value serves as the default for the `--inter-hunk-context`
7171
command line option.
7272

73-
diff.external::
73+
`diff.external`::
7474
If this config variable is set, diff generation is not
7575
performed using the internal diff machinery, but using the
76-
given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
76+
given command. Can be overridden with the `GIT_EXTERNAL_DIFF`
7777
environment variable. The command is called with parameters
7878
as described under "git Diffs" in linkgit:git[1]. Note: if
7979
you want to use an external diff program only on a subset of
8080
your files, you might want to use linkgit:gitattributes[5] instead.
8181

82-
diff.trustExitCode::
83-
If this boolean value is set to true then the
82+
`diff.trustExitCode`::
83+
If this boolean value is set to `true` then the
8484
`diff.external` command is expected to return exit code
8585
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.
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.
8989
Any other exit code causes Git to report a fatal error.
9090

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
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
9696
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.
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.
101101
By default this is set to untracked so that any untracked
102102
submodules are ignored.
103103

104-
diff.mnemonicPrefix::
105-
If set, 'git diff' uses a prefix pair that is different from the
104+
`diff.mnemonicPrefix`::
105+
If set, `git diff` uses a prefix pair that is different from the
106106
standard "a/" and "b/" depending on what is being compared. When
107107
this configuration is in effect, reverse diff output also swaps
108108
the order of the prefixes:
@@ -112,111 +112,112 @@ diff.mnemonicPrefix::
112112
compares a (c)ommit and the (w)ork tree;
113113
`git diff --cached`;;
114114
compares a (c)ommit and the (i)ndex;
115-
`git diff HEAD:file1 file2`;;
115+
`git diff HEAD:<file1> <file2>`;;
116116
compares an (o)bject and a (w)ork tree entity;
117117
`git diff --no-index a b`;;
118118
compares two non-git things (1) and (2).
119119

120-
diff.noPrefix::
121-
If set, 'git diff' does not show any source or destination prefix.
120+
`diff.noPrefix`::
121+
If set, `git diff` does not show any source or destination prefix.
122122

123-
diff.srcPrefix::
124-
If set, 'git diff' uses this source prefix. Defaults to "a/".
123+
`diff.srcPrefix`::
124+
If set, `git diff` uses this source prefix. Defaults to "a/".
125125

126-
diff.dstPrefix::
127-
If set, 'git diff' uses this destination prefix. Defaults to "b/".
126+
`diff.dstPrefix`::
127+
If set, `git diff` uses this destination prefix. Defaults to "b/".
128128

129-
diff.relative::
130-
If set to 'true', 'git diff' does not show changes outside of the directory
129+
`diff.relative`::
130+
If set to `true`, `git diff` does not show changes outside of the directory
131131
and show pathnames relative to the current directory.
132132

133-
diff.orderFile::
133+
`diff.orderFile`::
134134
File indicating how to order files within a diff.
135-
See the '-O' option to linkgit:git-diff[1] for details.
135+
See the `-O` option to linkgit:git-diff[1] for details.
136136
If `diff.orderFile` is a relative pathname, it is treated as
137137
relative to the top of the working tree.
138138

139-
diff.renameLimit::
139+
`diff.renameLimit`::
140140
The number of files to consider in the exhaustive portion of
141-
copy/rename detection; equivalent to the 'git diff' option
141+
copy/rename detection; equivalent to the `git diff` option
142142
`-l`. If not set, the default value is currently 1000. This
143143
setting has no effect if rename detection is turned off.
144144

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
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
149149
detect copies, as well. Defaults to true. Note that this
150-
affects only 'git diff' Porcelain like linkgit:git-diff[1] and
150+
affects only `git diff` Porcelain like linkgit:git-diff[1] and
151151
linkgit:git-log[1], and not lower level commands such as
152152
linkgit:git-diff-files[1].
153153

154-
diff.suppressBlankEmpty::
154+
`diff.suppressBlankEmpty`::
155155
A boolean to inhibit the standard behavior of printing a space
156-
before each empty output line. Defaults to false.
156+
before each empty output line. Defaults to `false`.
157157

158-
diff.submodule::
158+
`diff.submodule`::
159159
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
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
162162
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".
163+
does. The `diff` format shows an inline diff of the changed
164+
contents of the submodule. Defaults to `short`.
165165

166-
diff.wordRegex::
166+
`diff.wordRegex`::
167167
A POSIX Extended Regular Expression used to determine what is a "word"
168168
when performing word-by-word difference calculations. Character
169169
sequences that match the regular expression are "words", all other
170170
characters are *ignorable* whitespace.
171171

172-
diff.<driver>.command::
172+
`diff.<driver>.command`::
173173
The custom diff driver command. See linkgit:gitattributes[5]
174174
for details.
175175

176-
diff.<driver>.trustExitCode::
176+
`diff.<driver>.trustExitCode`::
177177
If this boolean value is set to true then the
178178
`diff.<driver>.command` command is expected to return exit code
179179
0 if it considers the input files to be equal or 1 if it
180-
considers them to be different, like `diff(1)`.
180+
considers them to be different, like `diff`(1).
181181
If it is set to false, which is the default, then the command
182182
is expected to return exit code 0 regardless of equality.
183183
Any other exit code causes Git to report a fatal error.
184184

185-
diff.<driver>.xfuncname::
185+
`diff.<driver>.xfuncname`::
186186
The regular expression that the diff driver should use to
187187
recognize the hunk header. A built-in pattern may also be used.
188188
See linkgit:gitattributes[5] for details.
189189

190-
diff.<driver>.binary::
191-
Set this option to true to make the diff driver treat files as
190+
`diff.<driver>.binary`::
191+
Set this option to `true` to make the diff driver treat files as
192192
binary. See linkgit:gitattributes[5] for details.
193193

194-
diff.<driver>.textconv::
194+
`diff.<driver>.textconv`::
195195
The command that the diff driver should call to generate the
196196
text-converted version of a file. The result of the
197197
conversion is used to generate a human-readable diff. See
198198
linkgit:gitattributes[5] for details.
199199

200-
diff.<driver>.wordRegex::
200+
`diff.<driver>.wordRegex`::
201201
The regular expression that the diff driver should use to
202202
split words in a line. See linkgit:gitattributes[5] for
203203
details.
204204

205-
diff.<driver>.cachetextconv::
205+
`diff.<driver>.cachetextconv`::
206206
Set this option to true to make the diff driver cache the text
207207
conversion outputs. See linkgit:gitattributes[5] for details.
208208

209209
include::../mergetools-diff.txt[]
210210

211-
diff.indentHeuristic::
211+
`diff.indentHeuristic`::
212212
Set this option to `false` to disable the default heuristics
213213
that shift diff hunk boundaries to make patches easier to read.
214214

215-
diff.algorithm::
215+
`diff.algorithm`::
216216
Choose a diff algorithm. The variants are as follows:
217217
+
218218
--
219-
`default`, `myers`;;
219+
`default`;;
220+
`myers`;;
220221
The basic greedy diff algorithm. Currently, this is the default.
221222
`minimal`;;
222223
Spend extra time to make sure the smallest possible diff is
@@ -229,7 +230,7 @@ diff.algorithm::
229230
--
230231
+
231232

232-
diff.wsErrorHighlight::
233+
`diff.wsErrorHighlight`::
233234
Highlight whitespace errors in the `context`, `old` or `new`
234235
lines of the diff. Multiple values are separated by comma,
235236
`none` resets previous values, `default` reset the list to
@@ -238,14 +239,14 @@ diff.wsErrorHighlight::
238239
The command line option `--ws-error-highlight=<kind>`
239240
overrides this setting.
240241

241-
diff.colorMoved::
242-
If set to either a valid `<mode>` or a true value, moved lines
242+
`diff.colorMoved`::
243+
If set to either a valid _<mode>_ or a true value, moved lines
243244
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,
245+
see `--color-moved` in linkgit:git-diff[1]. If simply set to
246+
`true` the default color mode will be used. When set to `false`,
246247
moved lines are not colored.
247248

248-
diff.colorMovedWS::
249+
`diff.colorMovedWS`::
249250
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].
251+
this option controls the mode how spaces are treated.
252+
For details of valid modes see `--color-moved-ws` in linkgit:git-diff[1].

0 commit comments

Comments
 (0)