Skip to content

Commit 3a1ca6e

Browse files
mdferdousalammdferdousalam
committed
doc: format config values with backticks
Wrap bare true/false config values in backticks throughout the Documentation/config/*.adoc files, following the convention used by most of the documentation. This ensures consistent formatting of boolean configuration values. Signed-off-by: Md Ferdous Alam <[email protected]>
1 parent 7c02d39 commit 3a1ca6e

39 files changed

+193
-193
lines changed

‎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: 3 additions & 3 deletions
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
@@ -14,11 +14,11 @@ blame.date::
1414

1515
blame.showEmail::
1616
Show the author email instead of author name in linkgit:git-blame[1].
17-
This option defaults to false.
17+
This option defaults to `false`.
1818

1919
blame.showRoot::
2020
Do not treat root commits as boundaries in linkgit:git-blame[1].
21-
This option defaults to false.
21+
This option defaults to `false`.
2222

2323
blame.ignoreRevsFile::
2424
Ignore revisions listed in the file, one unabbreviated object name per

‎Documentation/config/branch.adoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@
2020
that tracks another branch, this variable tells Git to set
2121
up pull to rebase instead of merge (see `branch.<name>.rebase`).
2222
The valid settings are:
23-
`never`;; rebase is never automatically set to true.
24-
`local`;; rebase is set to true for tracked branches of other local branches.
25-
`remote`;; rebase is set to true for tracked branches of remote-tracking branches.
26-
`always`;; rebase will be set to true for all tracking branches.
23+
`never`;; rebase is never automatically set to `true`.
24+
`local`;; rebase is set to `true` for tracked branches of other local branches.
25+
`remote`;; rebase is set to `true` for tracked branches of remote-tracking branches.
26+
`always`;; rebase will be set to `true` for all tracking branches.
2727

2828
+
2929
See `branch.autoSetupMerge` for details on how to set up a branch to track another branch.
@@ -81,7 +81,7 @@ This option defaults to `never`.
8181
supported.
8282
8383
`branch.<name>.rebase`::
84-
When true, rebase the branch _<name>_ on top of the fetched branch,
84+
When `true`, rebase the branch _<name>_ on top of the fetched branch,
8585
instead of merging the default branch from the default remote when
8686
`git pull` is run. See `pull.rebase` for doing this in a non
8787
branch-specific manner.

‎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/color.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ color.interactive.<slot>::
132132

133133
color.pager::
134134
A boolean to specify whether `auto` color modes should colorize
135-
output going to the pager. Defaults to true; set this to false
135+
output going to the pager. Defaults to `true`; set this to `false`
136136
if your pager does not understand ANSI color codes.
137137

138138
color.push::

‎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/core.adoc‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ Git for Windows or Eclipse).
1818
In such a case it may be necessary to set this variable to 'false'.
1919
See linkgit:git-update-index[1].
2020
+
21-
The default is true (when core.filemode is not specified in the config file).
21+
The default is `true` (when core.filemode is not specified in the config file).
2222

2323
core.hideDotFiles::
24-
(Windows-only) If true, mark newly-created directories and files whose
24+
(Windows-only) If `true`, mark newly-created directories and files whose
2525
name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
2626
directory is hidden, but no other files starting with a dot. The
2727
default mode is 'dotGitOnly'.
@@ -34,35 +34,35 @@ core.ignoreCase::
3434
it is really the same file, and continue to remember it as
3535
"Makefile".
3636
+
37-
The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
38-
will probe and set core.ignoreCase true if appropriate when the repository
37+
The default is `false`, except linkgit:git-clone[1] or linkgit:git-init[1]
38+
will probe and set core.ignoreCase `true` if appropriate when the repository
3939
is created.
4040
+
4141
Git relies on the proper configuration of this variable for your operating
4242
and file system. Modifying this value may result in unexpected behavior.
4343

4444
core.precomposeUnicode::
4545
This option is only used by Mac OS implementation of Git.
46-
When core.precomposeUnicode=true, Git reverts the unicode decomposition
46+
When core.precomposeUnicode=`true`, Git reverts the unicode decomposition
4747
of filenames done by Mac OS. This is useful when sharing a repository
4848
between Mac OS and Linux or Windows.
4949
(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
50-
When false, file names are handled fully transparent by Git,
50+
When `false`, file names are handled fully transparent by Git,
5151
which is backward compatible with older versions of Git.
5252

5353
core.protectHFS::
54-
If set to true, do not allow checkout of paths that would
54+
If set to `true`, do not allow checkout of paths that would
5555
be considered equivalent to `.git` on an HFS+ filesystem.
5656
Defaults to `true` on Mac OS, and `false` elsewhere.
5757

5858
core.protectNTFS::
59-
If set to true, do not allow checkout of paths that would
59+
If set to `true`, do not allow checkout of paths that would
6060
cause problems with the NTFS filesystem, e.g. conflict with
6161
8.3 "short" names.
6262
Defaults to `true` on Windows, and `false` elsewhere.
6363

6464
core.fsmonitor::
65-
If set to true, enable the built-in file system monitor
65+
If set to `true`, enable the built-in file system monitor
6666
daemon for this working directory (linkgit:git-fsmonitor{litdd}daemon[1]).
6767
+
6868
Like hook-based file system monitors, the built-in file system monitor
@@ -112,15 +112,15 @@ something that can be used to determine what files have changed
112112
without race conditions.
113113

114114
core.trustctime::
115-
If false, the ctime differences between the index and the
115+
If `false`, the ctime differences between the index and the
116116
working tree are ignored; useful when the inode change time
117117
is regularly modified by something outside Git (file system
118118
crawlers and some backup systems).
119-
See linkgit:git-update-index[1]. True by default.
119+
See linkgit:git-update-index[1]. `True` by default.
120120

121121
core.splitIndex::
122-
If true, the split-index feature of the index will be used.
123-
See linkgit:git-update-index[1]. False by default.
122+
If `true`, the split-index feature of the index will be used.
123+
See linkgit:git-update-index[1]. `False` by default.
124124

125125
core.untrackedCache::
126126
Determines what to do about the untracked cache feature of the
@@ -156,13 +156,13 @@ core.quotePath::
156156
backslashes in the same way C escapes control characters (e.g.
157157
`\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
158158
values larger than 0x80 (e.g. octal `\302\265` for "micro" in
159-
UTF-8). If this variable is set to false, bytes higher than
159+
UTF-8). If this variable is set to `false`, bytes higher than
160160
0x80 are not considered "unusual" any more. Double-quotes,
161161
backslash and control characters are always escaped regardless
162162
of the setting of this variable. A simple space character is
163163
not considered "unusual". Many commands can output pathnames
164164
completely verbatim using the `-z` option. The default value
165-
is true.
165+
is `true`.
166166

167167
core.eol::
168168
Sets the line ending type to use in the working directory for
@@ -176,7 +176,7 @@ core.eol::
176176
is set to `true` or `input`.
177177

178178
core.safecrlf::
179-
If true, makes Git check if converting `CRLF` is reversible when
179+
If `true`, makes Git check if converting `CRLF` is reversible when
180180
end-of-line conversion is active. Git will verify if a command
181181
modifies a file in the work tree either directly or indirectly.
182182
For example, committing a file followed by checking out the
@@ -223,7 +223,7 @@ mechanism.
223223
core.autocrlf::
224224
Setting this variable to "true" is the same as setting
225225
the `text` attribute to "auto" on all files and core.eol to "crlf".
226-
Set to true if you want to have `CRLF` line endings in your
226+
Set to `true` if you want to have `CRLF` line endings in your
227227
working directory and the repository has LF line endings.
228228
This variable can be set to 'input',
229229
in which case no output conversion is performed.
@@ -235,14 +235,14 @@ core.checkRoundtripEncoding::
235235
The default value is `SHIFT-JIS`.
236236

237237
core.symlinks::
238-
If false, symbolic links are checked out as small plain files that
238+
If `false`, symbolic links are checked out as small plain files that
239239
contain the link text. linkgit:git-update-index[1] and
240240
linkgit:git-add[1] will not change the recorded type to regular
241241
file. Useful on filesystems like FAT that do not support
242242
symbolic links.
243243
+
244-
The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
245-
will probe and set core.symlinks false if appropriate when the repository
244+
The default is `true`, except linkgit:git-clone[1] or linkgit:git-init[1]
245+
will probe and set core.symlinks `false` if appropriate when the repository
246246
is created.
247247

248248
core.gitProxy::
@@ -271,7 +271,7 @@ core.sshCommand::
271271
when the environment variable is set.
272272

273273
core.ignoreStat::
274-
If true, Git will avoid using lstat() calls to detect if files have
274+
If `true`, Git will avoid using lstat() calls to detect if files have
275275
changed by setting the "assume-unchanged" bit for those tracked files
276276
which it has updated identically in both the index and working tree.
277277
+
@@ -283,7 +283,7 @@ Git will not normally detect changes to those files.
283283
This is useful on systems where lstat() calls are very slow, such as
284284
CIFS/Microsoft Windows.
285285
+
286-
False by default.
286+
`False` by default.
287287

288288
core.preferSymlinkRefs::
289289
Instead of the default "symref" format for HEAD
@@ -313,16 +313,16 @@ core.alternateRefsPrefixes::
313313
`core.alternateRefsPrefixes` has no effect.
314314

315315
core.bare::
316-
If true this repository is assumed to be 'bare' and has no
316+
If `true` this repository is assumed to be 'bare' and has no
317317
working directory associated with it. If this is the case a
318318
number of commands that require a working directory will be
319319
disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
320320
+
321321
This setting is automatically guessed by linkgit:git-clone[1] or
322322
linkgit:git-init[1] when the repository was created. By default a
323323
repository that ends in "/.git" is assumed to be not bare (bare =
324-
false), while all other repositories are assumed to be bare (bare
325-
= true).
324+
`false`), while all other repositories are assumed to be bare (bare
325+
= `true`).
326326

327327
core.worktree::
328328
Set the path to the root of the working tree.
@@ -349,7 +349,7 @@ read-only snapshot of the same index to a location different from the
349349
repository's usual working tree).
350350

351351
core.lockfilePid::
352-
If true, Git will create a PID file alongside lock files. When a
352+
If `true`, Git will create a PID file alongside lock files. When a
353353
lock acquisition fails and a PID file exists, Git can provide
354354
additional diagnostic information about the process holding the
355355
lock, including whether it is still running. Defaults to `false`.
@@ -374,8 +374,8 @@ core.logAllRefUpdates::
374374
This information can be used to determine what commit
375375
was the tip of a branch "2 days ago".
376376
+
377-
This value is true by default in a repository that has
378-
a working directory associated with it, and false by
377+
This value is `true` by default in a repository that has
378+
a working directory associated with it, and `false` by
379379
default in a bare repository.
380380

381381
core.repositoryFormatVersion::
@@ -395,11 +395,11 @@ core.sharedRepository::
395395
the repo read/write-able for the owner and group, but inaccessible to
396396
others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
397397
repository that is group-readable but not group-writable.
398-
See linkgit:git-init[1]. False by default.
398+
See linkgit:git-init[1]. `False` by default.
399399

400400
core.warnAmbiguousRefs::
401-
If true, Git will warn you if the ref name you passed it is ambiguous
402-
and might match multiple refs in the repository. True by default.
401+
If `true`, Git will warn you if the ref name you passed it is ambiguous
402+
and might match multiple refs in the repository. `True` by default.
403403

404404
core.compression::
405405
An integer -1..9, indicating a default compression level.
@@ -708,7 +708,7 @@ core.fsyncObjectFiles::
708708
This setting is deprecated. Use core.fsync instead.
709709
+
710710
This setting affects data added to the Git repository in loose-object
711-
form. When set to true, Git will issue an fsync or similar system call
711+
form. When set to `true`, Git will issue an fsync or similar system call
712712
to flush caches so that loose-objects remain consistent in the face
713713
of a unclean system shutdown.
714714

@@ -719,7 +719,7 @@ This can speed up operations like 'git diff' and 'git status' especially
719719
on filesystems like NFS that have weak caching semantics and thus
720720
relatively high IO latencies. When enabled, Git will do the
721721
index comparison to the filesystem data in parallel, allowing
722-
overlapping IO's. Defaults to true.
722+
overlapping IO's. Defaults to `true`.
723723

724724
core.unsetenvvars::
725725
Windows-only: comma-separated list of environment variables'
@@ -746,8 +746,8 @@ This setting defaults to "refs/notes/commits", and it can be overridden by
746746
the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
747747

748748
core.commitGraph::
749-
If true, then git will read the commit-graph file (if it exists)
750-
to parse the graph structure of commits. Defaults to true. See
749+
If `true`, then git will read the commit-graph file (if it exists)
750+
to parse the graph structure of commits. Defaults to `true`. See
751751
linkgit:git-commit-graph[1] for more information.
752752

753753
core.useReplaceRefs::
@@ -758,7 +758,7 @@ core.useReplaceRefs::
758758
core.multiPackIndex::
759759
Use the multi-pack-index file to track multiple packfiles using a
760760
single index. See linkgit:git-multi-pack-index[1] for more
761-
information. Defaults to true.
761+
information. Defaults to `true`.
762762

763763
core.sparseCheckout::
764764
Enable "sparse checkout" feature. See linkgit:git-sparse-checkout[1]

‎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/fetch.adoc‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
in `git pull`) will recursively fetch into populated submodules.
44
This option can be set either to a boolean value or to `on-demand`.
55
Setting it to a boolean changes the behavior of fetch and pull to
6-
recurse unconditionally into submodules when set to true or to not
7-
recurse at all when set to false. When set to `on-demand`, fetch and
6+
recurse unconditionally into submodules when set to `true` or to not
7+
recurse at all when set to `false`. When set to `on-demand`, fetch and
88
pull will only recurse into a populated submodule when its
99
superproject retrieves a commit that updates the submodule's
1010
reference.
1111
Defaults to `on-demand`, or to the value of `submodule.recurse` if set.
1212

1313
`fetch.fsckObjects`::
14-
If it is set to true, git-fetch-pack will check all fetched
14+
If it is set to `true`, git-fetch-pack will check all fetched
1515
objects. See `transfer.fsckObjects` for what's
1616
checked. Defaults to `false`. If not set, the value of
1717
`transfer.fsckObjects` is used instead.
@@ -38,20 +38,20 @@
3838
`transfer.unpackLimit` is used instead.
3939

4040
`fetch.prune`::
41-
If true, fetch will automatically behave as if the `--prune`
41+
If `true`, fetch will automatically behave as if the `--prune`
4242
option was given on the command line. See also `remote.<name>.prune`
4343
and the PRUNING section of linkgit:git-fetch[1].
4444

4545
`fetch.pruneTags`::
46-
If true, fetch will automatically behave as if the
46+
If `true`, fetch will automatically behave as if the
4747
`refs/tags/*:refs/tags/*` refspec was provided when pruning,
4848
if not set already. This allows for setting both this option
4949
and `fetch.prune` to maintain a 1=1 mapping to upstream
5050
refs. See also `remote.<name>.pruneTags` and the PRUNING
5151
section of linkgit:git-fetch[1].
5252

5353
`fetch.all`::
54-
If true, fetch will attempt to update all available remotes.
54+
If `true`, fetch will attempt to update all available remotes.
5555
This behavior can be overridden by passing `--no-all` or by
5656
explicitly specifying one or more remote(s) to fetch from.
5757
Defaults to `false`.
@@ -95,7 +95,7 @@ For submodules, this setting can be overridden using the `submodule.fetchJobs`
9595
config setting.
9696

9797
`fetch.writeCommitGraph`::
98-
Set to true to write a commit-graph after every `git fetch` command
98+
Set to `true` to write a commit-graph after every `git fetch` command
9999
that downloads a pack-file from a remote. Using the `--split` option,
100100
most executions will create a very small commit-graph file on top of
101101
the existing commit-graph file(s). Occasionally, these files will

0 commit comments

Comments
 (0)