Skip to content

Commit f212dcc

Browse files
computersforpeacegitster
authored andcommitted
config: consistently format $variables in monospaced font
We don't consistently use `backticks` for formatting shell variables. This patch improves the consistency on shell variables (and a few nearby mentions of "gpg" commands), though it still doesn't straighten out the use of "quotes." Signed-off-by: Brian Norris <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent dca83ab commit f212dcc

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
@@ -487,10 +487,10 @@ repository's usual working tree).
487487

488488
core.logAllRefUpdates::
489489
Enable the reflog. Updates to a ref <ref> is logged to the file
490-
"$GIT_DIR/logs/<ref>", by appending the new and old
490+
"`$GIT_DIR/logs/<ref>`", by appending the new and old
491491
SHA-1, the date/time and the reason of the update, but
492492
only when the file exists. If this configuration
493-
variable is set to true, missing "$GIT_DIR/logs/<ref>"
493+
variable is set to true, missing "`$GIT_DIR/logs/<ref>`"
494494
file is automatically created for branch heads (i.e. under
495495
refs/heads/), remote refs (i.e. under refs/remotes/),
496496
note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
@@ -597,8 +597,8 @@ core.excludesFile::
597597
Specifies the pathname to the file that contains patterns to
598598
describe paths that are not meant to be tracked, in addition
599599
to '.gitignore' (per-directory) and '.git/info/exclude'.
600-
Defaults to $XDG_CONFIG_HOME/git/ignore.
601-
If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
600+
Defaults to `$XDG_CONFIG_HOME/git/ignore`.
601+
If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
602602
is used instead. See linkgit:gitignore[5].
603603

604604
core.askPass::
@@ -615,8 +615,8 @@ core.attributesFile::
615615
'.git/info/attributes', Git looks into this file for attributes
616616
(see linkgit:gitattributes[5]). Path expansions are made the same
617617
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.
618+
`$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
619+
set or empty, `$HOME/.config/git/attributes` is used instead.
620620

621621
core.editor::
622622
Commands such as `commit` and `tag` that lets you edit
@@ -1324,7 +1324,7 @@ gc.worktreePruneExpire::
13241324
'git worktree prune --expire 3.months.ago'.
13251325
This config variable can be used to set a different grace
13261326
period. The value "now" may be used to disable the grace
1327-
period and prune $GIT_DIR/worktrees immediately, or "never"
1327+
period and prune `$GIT_DIR/worktrees` immediately, or "never"
13281328
may be used to suppress pruning.
13291329

13301330
gc.reflogExpire::
@@ -1456,13 +1456,13 @@ grep.extendedRegexp::
14561456
other than 'default'.
14571457

14581458
gpg.program::
1459-
Use this custom program instead of "gpg" found on $PATH when
1459+
Use this custom program instead of "`gpg`" found on `$PATH` when
14601460
making or verifying a PGP signature. The program must support the
14611461
same command-line interface as GPG, namely, to verify a detached
1462-
signature, "gpg --verify $file - <$signature" is run, and the
1462+
signature, "`gpg --verify $file - <$signature`" is run, and the
14631463
program is expected to signal a good signature by exiting with
14641464
code 0, and to generate an ASCII-armored detached signature, the
1465-
standard input of "gpg -bsau $key" is fed with the contents to be
1465+
standard input of "`gpg -bsau $key`" is fed with the contents to be
14661466
signed, and the program is expected to send the result to its
14671467
standard output.
14681468

0 commit comments

Comments
 (0)