Skip to content

Commit 34698ba

Browse files
committed
Merge branch 'bn/config-doc-tt-varnames'
Doc formatting fixes. * bn/config-doc-tt-varnames: config: consistently format $variables in monospaced font
2 parents e5e7a91 + f212dcc commit 34698ba

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

Documentation/config.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Example
117117
[include]
118118
path = /path/to/foo.inc ; include by absolute path
119119
path = foo ; expand "foo" relative to the current file
120-
path = ~/foo ; expand "foo" in your $HOME directory
120+
path = ~/foo ; expand "foo" in your `$HOME` directory
121121

122122

123123
Values
@@ -496,10 +496,10 @@ repository's usual working tree).
496496

497497
core.logAllRefUpdates::
498498
Enable the reflog. Updates to a ref <ref> is logged to the file
499-
"$GIT_DIR/logs/<ref>", by appending the new and old
499+
"`$GIT_DIR/logs/<ref>`", by appending the new and old
500500
SHA-1, the date/time and the reason of the update, but
501501
only when the file exists. If this configuration
502-
variable is set to true, missing "$GIT_DIR/logs/<ref>"
502+
variable is set to true, missing "`$GIT_DIR/logs/<ref>`"
503503
file is automatically created for branch heads (i.e. under
504504
refs/heads/), remote refs (i.e. under refs/remotes/),
505505
note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
@@ -606,8 +606,8 @@ core.excludesFile::
606606
Specifies the pathname to the file that contains patterns to
607607
describe paths that are not meant to be tracked, in addition
608608
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
609+
Defaults to `$XDG_CONFIG_HOME/git/ignore`.
610+
If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
611611
is used instead. See linkgit:gitignore[5].
612612

613613
core.askPass::
@@ -624,8 +624,8 @@ core.attributesFile::
624624
'.git/info/attributes', Git looks into this file for attributes
625625
(see linkgit:gitattributes[5]). Path expansions are made the same
626626
way as for `core.excludesFile`. Its default value is
627-
$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
628-
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.
629629

630630
core.hooksPath::
631631
By default Git will look for your hooks in the
@@ -1360,7 +1360,7 @@ gc.worktreePruneExpire::
13601360
'git worktree prune --expire 3.months.ago'.
13611361
This config variable can be used to set a different grace
13621362
period. The value "now" may be used to disable the grace
1363-
period and prune $GIT_DIR/worktrees immediately, or "never"
1363+
period and prune `$GIT_DIR/worktrees` immediately, or "never"
13641364
may be used to suppress pruning.
13651365

13661366
gc.reflogExpire::
@@ -1500,13 +1500,13 @@ grep.fallbackToNoIndex::
15001500
is executed outside of a git repository. Defaults to false.
15011501

15021502
gpg.program::
1503-
Use this custom program instead of "gpg" found on $PATH when
1503+
Use this custom program instead of "`gpg`" found on `$PATH` when
15041504
making or verifying a PGP signature. The program must support the
15051505
same command-line interface as GPG, namely, to verify a detached
1506-
signature, "gpg --verify $file - <$signature" is run, and the
1506+
signature, "`gpg --verify $file - <$signature`" is run, and the
15071507
program is expected to signal a good signature by exiting with
15081508
code 0, and to generate an ASCII-armored detached signature, the
1509-
standard input of "gpg -bsau $key" is fed with the contents to be
1509+
standard input of "`gpg -bsau $key`" is fed with the contents to be
15101510
signed, and the program is expected to send the result to its
15111511
standard output.
15121512

0 commit comments

Comments
 (0)