Skip to content

Commit 631b9ab

Browse files
committed
doc: format config values with backticks
Add backtick formatting to bare true/false values in configuration documentation so they render in monospace as config literals, matching the style used throughout most of the existing documentation. Signed-off-by: Md Ferdous Alam <mdferdousalam@gmail.com>
1 parent 7c02d39 commit 631b9ab

12 files changed

Lines changed: 58 additions & 58 deletions

File tree

Documentation/config/am.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
am.keepcr::
2-
If true, git-am will call git-mailsplit for patches in mbox format
2+
If `true`, git-am will call git-mailsplit for patches in mbox format
33
with parameter `--keep-cr`. In this case git-mailsplit will
44
not remove `\r` from lines ending with `\r\n`. Can be overridden
55
by giving `--no-keep-cr` from the command line.
66
See linkgit:git-am[1], linkgit:git-mailsplit[1].
77

88
am.threeWay::
99
By default, `git am` will fail if the patch does not apply cleanly. When
10-
set to true, this setting tells `git am` to fall back on 3-way merge if
10+
set to `true`, this setting tells `git am` to fall back on 3-way merge if
1111
the patch records the identity of blobs it is supposed to apply to and
1212
we have those blobs available locally (equivalent to giving the `--3way`
1313
option from the command line). Defaults to `false`.

Documentation/config/blame.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
blame.blankBoundary::
22
Show blank commit object name for boundary commits in
3-
linkgit:git-blame[1]. This option defaults to false.
3+
linkgit:git-blame[1]. This option defaults to `false`.
44

55
blame.coloring::
66
This determines the coloring scheme to be applied to blame

Documentation/config/clean.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
clean.requireForce::
22
A boolean to make git-clean refuse to delete files unless -f
3-
is given. Defaults to true.
3+
is given. Defaults to `true`.

Documentation/config/commitgraph.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ commitGraph.maxNewFilters::
99
commit-graph write` (c.f., linkgit:git-commit-graph[1]).
1010

1111
commitGraph.changedPaths::
12-
If true, then `git commit-graph write` will compute and write
12+
If `true`, then `git commit-graph write` will compute and write
1313
changed-path Bloom filters by default, equivalent to passing
14-
`--changed-paths`. If false or unset, changed-paths Bloom filters will
14+
`--changed-paths`. If `false` or unset, changed-paths Bloom filters will
1515
be written during `git commit-graph write` only if the filters already
1616
exist in the current commit-graph file. This matches the default
1717
behavior of `git commit-graph write` without any `--[no-]changed-paths`
@@ -20,8 +20,8 @@ commitGraph.changedPaths::
2020
always takes precedence over this configuration. Defaults to unset.
2121

2222
commitGraph.readChangedPaths::
23-
Deprecated. Equivalent to commitGraph.changedPathsVersion=-1 if true, and
24-
commitGraph.changedPathsVersion=0 if false. (If commitGraph.changedPathVersion
23+
Deprecated. Equivalent to commitGraph.changedPathsVersion=-1 if `true`, and
24+
commitGraph.changedPathsVersion=0 if `false`. (If commitGraph.changedPathVersion
2525
is also set, commitGraph.changedPathsVersion takes precedence.)
2626

2727
commitGraph.changedPathsVersion::

Documentation/config/credential.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ credential.interactive::
1919

2020
credential.useHttpPath::
2121
When acquiring credentials, consider the "path" component of an http
22-
or https URL to be important. Defaults to false. See
22+
or https URL to be important. Defaults to `false`. See
2323
linkgit:gitcredentials[7] for more information.
2424

2525
credential.sanitizePrompt::

Documentation/config/fmt-merge-msg.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
`merge.branchdesc`::
22
In addition to branch names, populate the log message with
33
the branch description text associated with them. Defaults
4-
to false.
4+
to `false`.
55

66
`merge.log`::
77
In addition to branch names, populate the log message with at
88
most the specified number of one-line descriptions from the
9-
actual commits that are being merged. Defaults to false, and
10-
true is a synonym for 20.
9+
actual commits that are being merged. Defaults to `false`, and
10+
`true` is a synonym for 20.
1111

1212
`merge.suppressDest`::
1313
By adding a glob that matches the names of integration

Documentation/config/format.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@ format.attach::
88

99
format.from::
1010
Provides the default value for the `--from` option to format-patch.
11-
Accepts a boolean value, or a name and email address. If false,
11+
Accepts a boolean value, or a name and email address. If `false`,
1212
format-patch defaults to `--no-from`, using commit authors directly in
13-
the "From:" field of patch mails. If true, format-patch defaults to
13+
the "From:" field of patch mails. If `true`, format-patch defaults to
1414
`--from`, using your committer identity in the "From:" field of patch
1515
mails and including a "From:" field in the body of the patch mail if
1616
different. If set to a non-boolean value, format-patch uses that
17-
value instead of your committer identity. Defaults to false.
17+
value instead of your committer identity. Defaults to `false`.
1818

1919
format.forceInBodyFrom::
2020
Provides the default value for the `--[no-]force-in-body-from`
21-
option to format-patch. Defaults to false.
21+
option to format-patch. Defaults to `false`.
2222

2323
format.numbered::
2424
A boolean which can enable or disable sequence numbers in patch
2525
subjects. It defaults to "auto" which enables it only if there
2626
is more than one patch. It can be enabled or disabled for all
27-
messages by setting it to "true" or "false". See --numbered
27+
messages by setting it to `true` or `false`. See --numbered
2828
option in linkgit:git-format-patch[1].
2929

3030
format.headers::
@@ -65,7 +65,7 @@ format.suffix::
6565
format.encodeEmailHeaders::
6666
Encode email headers that have non-ASCII characters with
6767
"Q-encoding" (described in RFC 2047) for email transmission.
68-
Defaults to true.
68+
Defaults to `true`.
6969

7070
format.pretty::
7171
ifndef::with-breaking-changes[]
@@ -85,7 +85,7 @@ format.thread::
8585
where the head is chosen from the cover letter, the
8686
`--in-reply-to`, and the first patch mail, in this order.
8787
`deep` threading makes every mail a reply to the previous one.
88-
A true boolean value is the same as `shallow`, and a false
88+
A `true` boolean value is the same as `shallow`, and a `false`
8989
value disables threading.
9090

9191
format.signOff::
@@ -99,7 +99,7 @@ format.coverLetter::
9999
A boolean that controls whether to generate a cover-letter when
100100
format-patch is invoked, but in addition can be set to "auto", to
101101
generate a cover-letter only when there's more than one patch.
102-
Default is false.
102+
Default is `false`.
103103

104104
format.outputDirectory::
105105
Set a custom directory to store the resulting files instead of the
@@ -119,11 +119,11 @@ format.useAutoBase::
119119
format.notes::
120120
Provides the default value for the `--notes` option to
121121
format-patch. Accepts a boolean value, or a ref which specifies
122-
where to get notes. If false, format-patch defaults to
123-
`--no-notes`. If true, format-patch defaults to `--notes`. If
122+
where to get notes. If `false`, format-patch defaults to
123+
`--no-notes`. If `true`, format-patch defaults to `--notes`. If
124124
set to a non-boolean value, format-patch defaults to
125125
`--notes=<ref>`, where `ref` is the non-boolean value. Defaults
126-
to false.
126+
to `false`.
127127
+
128128
If one wishes to use the ref `refs/notes/true`, please use that literal
129129
instead.

Documentation/config/grep.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
grep.lineNumber::
2-
If set to true, enable `-n` option by default.
2+
If set to `true`, enable `-n` option by default.
33

44
grep.column::
5-
If set to true, enable the `--column` option by default.
5+
If set to `true`, enable the `--column` option by default.
66

77
grep.patternType::
88
Set the default matching behavior. Using a value of 'basic', 'extended',
@@ -12,7 +12,7 @@ grep.patternType::
1212
between 'basic' and 'extended'.
1313

1414
grep.extendedRegexp::
15-
If set to true, enable `--extended-regexp` option by default. This
15+
If set to `true`, enable `--extended-regexp` option by default. This
1616
option is ignored when the `grep.patternType` option is set to a value
1717
other than 'default'.
1818

@@ -21,8 +21,8 @@ grep.threads::
2121
use as many threads as the number of logical cores available.
2222

2323
grep.fullName::
24-
If set to true, enable `--full-name` option by default.
24+
If set to `true`, enable `--full-name` option by default.
2525

2626
grep.fallbackToNoIndex::
27-
If set to true, fall back to `git grep --no-index` if `git grep`
28-
is executed outside of a git repository. Defaults to false.
27+
If set to `true`, fall back to `git grep --no-index` if `git grep`
28+
is executed outside of a git repository. Defaults to `false`.

Documentation/config/rebase.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,22 @@ rebase.stat::
99
rebase. False by default.
1010

1111
rebase.autoSquash::
12-
If set to true, enable the `--autosquash` option of
12+
If set to `true`, enable the `--autosquash` option of
1313
linkgit:git-rebase[1] by default for interactive mode.
1414
This can be overridden with the `--no-autosquash` option.
1515

1616
rebase.autoStash::
17-
When set to true, automatically create a temporary stash entry
17+
When set to `true`, automatically create a temporary stash entry
1818
before the operation begins, and apply it after the operation
1919
ends. This means that you can run rebase on a dirty worktree.
2020
However, use with care: the final stash application after a
2121
successful rebase might result in non-trivial conflicts.
2222
This option can be overridden by the `--no-autostash` and
2323
`--autostash` options of linkgit:git-rebase[1].
24-
Defaults to false.
24+
Defaults to `false`.
2525

2626
rebase.updateRefs::
27-
If set to true enable `--update-refs` option by default.
27+
If set to `true` enable `--update-refs` option by default.
2828

2929
rebase.missingCommitsCheck::
3030
If set to "warn", git rebase -i will print a warning if some
@@ -43,7 +43,7 @@ rebase.instructionFormat::
4343
automatically have the commit hash prepended to the format.
4444

4545
rebase.abbreviateCommands::
46-
If set to true, `git rebase` will use abbreviated command names in the
46+
If set to `true`, `git rebase` will use abbreviated command names in the
4747
todo list resulting in something like this:
4848
+
4949
-------------------------------------------
@@ -60,22 +60,22 @@ instead of:
6060
...
6161
-------------------------------------------
6262
+
63-
Defaults to false.
63+
Defaults to `false`.
6464
6565
rebase.rescheduleFailedExec::
6666
Automatically reschedule `exec` commands that failed. This only makes
6767
sense in interactive mode (or when an `--exec` option was provided).
6868
This is the same as specifying the `--reschedule-failed-exec` option.
6969
7070
rebase.forkPoint::
71-
If set to false set `--no-fork-point` option by default.
71+
If set to `false` set `--no-fork-point` option by default.
7272
7373
rebase.rebaseMerges::
7474
Whether and how to set the `--rebase-merges` option by default. Can
7575
be `rebase-cousins`, `no-rebase-cousins`, or a boolean. Setting to
76-
true or to `no-rebase-cousins` is equivalent to
76+
`true` or to `no-rebase-cousins` is equivalent to
7777
`--rebase-merges=no-rebase-cousins`, setting to `rebase-cousins` is
78-
equivalent to `--rebase-merges=rebase-cousins`, and setting to false is
78+
equivalent to `--rebase-merges=rebase-cousins`, and setting to `false` is
7979
equivalent to `--no-rebase-merges`. Passing `--rebase-merges` on the
8080
command line, with or without an argument, overrides any
8181
`rebase.rebaseMerges` configuration.

Documentation/config/rerere.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
rerere.autoUpdate::
2-
When set to true, `git-rerere` updates the index with the
2+
When set to `true`, `git-rerere` updates the index with the
33
resulting contents after it cleanly resolves conflicts using
4-
previously recorded resolutions. Defaults to false.
4+
previously recorded resolutions. Defaults to `false`.
55

66
rerere.enabled::
77
Activate recording of resolved conflicts, so that identical

0 commit comments

Comments
 (0)