Skip to content

Commit 57b76d3

Browse files
committed
Merge branch 'bn/config-doc-tt-varnames' into maint
Doc formatting fixes. * bn/config-doc-tt-varnames: config: consistently format $variables in monospaced font config: describe 'pathname' value type
2 parents 4e327bb + f212dcc commit 57b76d3

File tree

1 file changed

+29
-21
lines changed

1 file changed

+29
-21
lines changed

Documentation/config.txt

Lines changed: 29 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,16 @@ Includes
8181

8282
You can include one config file from another by setting the special
8383
`include.path` variable to the name of the file to be included. The
84+
variable takes a pathname as its value, and is subject to tilde
85+
expansion.
86+
87+
The
8488
included file is expanded immediately, as if its contents had been
8589
found at the location of the include directive. If the value of the
8690
`include.path` variable is a relative path, the path is considered to be
8791
relative to the configuration file in which the include directive was
88-
found. The value of `include.path` is subject to tilde expansion: `~/`
89-
is expanded to the value of `$HOME`, and `~user/` to the specified
90-
user's home directory. See below for examples.
92+
found. See below for examples.
93+
9194

9295
Example
9396
~~~~~~~
@@ -114,7 +117,7 @@ Example
114117
[include]
115118
path = /path/to/foo.inc ; include by absolute path
116119
path = foo ; expand "foo" relative to the current file
117-
path = ~/foo ; expand "foo" in your $HOME directory
120+
path = ~/foo ; expand "foo" in your `$HOME` directory
118121

119122

120123
Values
@@ -169,6 +172,13 @@ thing on the same output line (e.g. opening parenthesis before the
169172
list of branch names in `log --decorate` output) is set to be
170173
painted with `bold` or some other attribute.
171174

175+
pathname::
176+
A variable that takes a pathname value can be given a
177+
string that begins with "`~/`" or "`~user/`", and the usual
178+
tilde expansion happens to such a string: `~/`
179+
is expanded to the value of `$HOME`, and `~user/` to the
180+
specified user's home directory.
181+
172182

173183
Variables
174184
~~~~~~~~~
@@ -486,10 +496,10 @@ repository's usual working tree).
486496

487497
core.logAllRefUpdates::
488498
Enable the reflog. Updates to a ref <ref> is logged to the file
489-
"$GIT_DIR/logs/<ref>", by appending the new and old
499+
"`$GIT_DIR/logs/<ref>`", by appending the new and old
490500
SHA-1, the date/time and the reason of the update, but
491501
only when the file exists. If this configuration
492-
variable is set to true, missing "$GIT_DIR/logs/<ref>"
502+
variable is set to true, missing "`$GIT_DIR/logs/<ref>`"
493503
file is automatically created for branch heads (i.e. under
494504
refs/heads/), remote refs (i.e. under refs/remotes/),
495505
note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
@@ -593,12 +603,11 @@ be delta compressed, but larger binary media files won't be.
593603
Common unit suffixes of 'k', 'm', or 'g' are supported.
594604

595605
core.excludesFile::
596-
In addition to '.gitignore' (per-directory) and
597-
'.git/info/exclude', Git looks into this file for patterns
598-
of files which are not meant to be tracked. "`~/`" is expanded
599-
to the value of `$HOME` and "`~user/`" to the specified user's
600-
home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
601-
If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
606+
Specifies the pathname to the file that contains patterns to
607+
describe paths that are not meant to be tracked, in addition
608+
to '.gitignore' (per-directory) and '.git/info/exclude'.
609+
Defaults to `$XDG_CONFIG_HOME/git/ignore`.
610+
If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
602611
is used instead. See linkgit:gitignore[5].
603612

604613
core.askPass::
@@ -615,8 +624,8 @@ core.attributesFile::
615624
'.git/info/attributes', Git looks into this file for attributes
616625
(see linkgit:gitattributes[5]). Path expansions are made the same
617626
way as for `core.excludesFile`. Its default value is
618-
$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
619-
set or empty, $HOME/.config/git/attributes is used instead.
627+
`$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
628+
set or empty, `$HOME/.config/git/attributes` is used instead.
620629

621630
core.editor::
622631
Commands such as `commit` and `tag` that lets you edit
@@ -1106,9 +1115,8 @@ commit.status::
11061115
message. Defaults to true.
11071116

11081117
commit.template::
1109-
Specify a file to use as the template for new commit messages.
1110-
"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1111-
specified user's home directory.
1118+
Specify the pathname of a file to use as the template for
1119+
new commit messages.
11121120

11131121
credential.helper::
11141122
Specify an external helper to be called when a username or
@@ -1334,7 +1342,7 @@ gc.worktreePruneExpire::
13341342
'git worktree prune --expire 3.months.ago'.
13351343
This config variable can be used to set a different grace
13361344
period. The value "now" may be used to disable the grace
1337-
period and prune $GIT_DIR/worktrees immediately, or "never"
1345+
period and prune `$GIT_DIR/worktrees` immediately, or "never"
13381346
may be used to suppress pruning.
13391347

13401348
gc.reflogExpire::
@@ -1474,13 +1482,13 @@ grep.fallbackToNoIndex::
14741482
is executed outside of a git repository. Defaults to false.
14751483

14761484
gpg.program::
1477-
Use this custom program instead of "gpg" found on $PATH when
1485+
Use this custom program instead of "`gpg`" found on `$PATH` when
14781486
making or verifying a PGP signature. The program must support the
14791487
same command-line interface as GPG, namely, to verify a detached
1480-
signature, "gpg --verify $file - <$signature" is run, and the
1488+
signature, "`gpg --verify $file - <$signature`" is run, and the
14811489
program is expected to signal a good signature by exiting with
14821490
code 0, and to generate an ASCII-armored detached signature, the
1483-
standard input of "gpg -bsau $key" is fed with the contents to be
1491+
standard input of "`gpg -bsau $key`" is fed with the contents to be
14841492
signed, and the program is expected to send the result to its
14851493
standard output.
14861494

0 commit comments

Comments
 (0)