mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

config: consistently format $variables in monospaced font

Browse Source 
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 <computersforpeace@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Brian Norris
2016-05-04 12:24:48 -07:00
committed by Junio C Hamano
parent dca83abde2
commit f212dcc7d3
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
Documentation/config.txt
View File

@ -117,7 +117,7 @@ Example
[include] [include]
path = /path/to/foo.inc ; include by absolute path path = /path/to/foo.inc ; include by absolute path
path = foo ; expand "foo" relative to the current file path = foo ; expand "foo" relative to the current file
path = ~/foo ; expand "foo" in your $HOME directory path = ~/foo ; expand "foo" in your `$HOME` directory
Values Values
@ -487,10 +487,10 @@ repository's usual working tree).
core.logAllRefUpdates:: core.logAllRefUpdates::
Enable the reflog. Updates to a ref <ref> is logged to the file Enable the reflog. Updates to a ref <ref> is logged to the file
"$GIT_DIR/logs/<ref>", by appending the new and old "`$GIT_DIR/logs/<ref>`", by appending the new and old
SHA-1, the date/time and the reason of the update, but SHA-1, the date/time and the reason of the update, but
only when the file exists. If this configuration only when the file exists. If this configuration
variable is set to true, missing "$GIT_DIR/logs/<ref>" variable is set to true, missing "`$GIT_DIR/logs/<ref>`"
file is automatically created for branch heads (i.e. under file is automatically created for branch heads (i.e. under
refs/heads/), remote refs (i.e. under refs/remotes/), refs/heads/), remote refs (i.e. under refs/remotes/),
note refs (i.e. under refs/notes/), and the symbolic ref HEAD. note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
@ -597,8 +597,8 @@ core.excludesFile::
Specifies the pathname to the file that contains patterns to Specifies the pathname to the file that contains patterns to
describe paths that are not meant to be tracked, in addition describe paths that are not meant to be tracked, in addition
to '.gitignore' (per-directory) and '.git/info/exclude'. to '.gitignore' (per-directory) and '.git/info/exclude'.
Defaults to $XDG_CONFIG_HOME/git/ignore. Defaults to `$XDG_CONFIG_HOME/git/ignore`.
If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
is used instead. See linkgit:gitignore[5]. is used instead. See linkgit:gitignore[5].
core.askPass:: core.askPass::
@ -615,8 +615,8 @@ core.attributesFile::
'.git/info/attributes', Git looks into this file for attributes '.git/info/attributes', Git looks into this file for attributes
(see linkgit:gitattributes[5]). Path expansions are made the same (see linkgit:gitattributes[5]). Path expansions are made the same
way as for `core.excludesFile`. Its default value is way as for `core.excludesFile`. Its default value is
$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
set or empty, $HOME/.config/git/attributes is used instead. set or empty, `$HOME/.config/git/attributes` is used instead.
core.editor:: core.editor::
Commands such as `commit` and `tag` that lets you edit Commands such as `commit` and `tag` that lets you edit
@ -1324,7 +1324,7 @@ gc.worktreePruneExpire::
'git worktree prune --expire 3.months.ago'. 'git worktree prune --expire 3.months.ago'.
This config variable can be used to set a different grace This config variable can be used to set a different grace
period. The value "now" may be used to disable the grace period. The value "now" may be used to disable the grace
period and prune $GIT_DIR/worktrees immediately, or "never" period and prune `$GIT_DIR/worktrees` immediately, or "never"
may be used to suppress pruning. may be used to suppress pruning.
gc.reflogExpire:: gc.reflogExpire::
@ -1456,13 +1456,13 @@ grep.extendedRegexp::
other than 'default'. other than 'default'.
gpg.program:: gpg.program::
Use this custom program instead of "gpg" found on $PATH when Use this custom program instead of "`gpg`" found on `$PATH` when
making or verifying a PGP signature. The program must support the making or verifying a PGP signature. The program must support the
same command-line interface as GPG, namely, to verify a detached same command-line interface as GPG, namely, to verify a detached
signature, "gpg --verify $file - <$signature" is run, and the signature, "`gpg --verify $file - <$signature`" is run, and the
program is expected to signal a good signature by exiting with program is expected to signal a good signature by exiting with
code 0, and to generate an ASCII-armored detached signature, the code 0, and to generate an ASCII-armored detached signature, the
standard input of "gpg -bsau $key" is fed with the contents to be standard input of "`gpg -bsau $key`" is fed with the contents to be
signed, and the program is expected to send the result to its signed, and the program is expected to send the result to its
standard output. standard output.