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
This commit is contained in:
commit
57b76d3379
@ -81,13 +81,16 @@ Includes
|
||||
|
||||
You can include one config file from another by setting the special
|
||||
`include.path` variable to the name of the file to be included. The
|
||||
variable takes a pathname as its value, and is subject to tilde
|
||||
expansion.
|
||||
|
||||
The
|
||||
included file is expanded immediately, as if its contents had been
|
||||
found at the location of the include directive. If the value of the
|
||||
`include.path` variable is a relative path, the path is considered to be
|
||||
relative to the configuration file in which the include directive was
|
||||
found. The value of `include.path` is subject to tilde expansion: `~/`
|
||||
is expanded to the value of `$HOME`, and `~user/` to the specified
|
||||
user's home directory. See below for examples.
|
||||
found. See below for examples.
|
||||
|
||||
|
||||
Example
|
||||
~~~~~~~
|
||||
@ -114,7 +117,7 @@ Example
|
||||
[include]
|
||||
path = /path/to/foo.inc ; include by absolute path
|
||||
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
|
||||
@ -169,6 +172,13 @@ thing on the same output line (e.g. opening parenthesis before the
|
||||
list of branch names in `log --decorate` output) is set to be
|
||||
painted with `bold` or some other attribute.
|
||||
|
||||
pathname::
|
||||
A variable that takes a pathname value can be given a
|
||||
string that begins with "`~/`" or "`~user/`", and the usual
|
||||
tilde expansion happens to such a string: `~/`
|
||||
is expanded to the value of `$HOME`, and `~user/` to the
|
||||
specified user's home directory.
|
||||
|
||||
|
||||
Variables
|
||||
~~~~~~~~~
|
||||
@ -486,10 +496,10 @@ repository's usual working tree).
|
||||
|
||||
core.logAllRefUpdates::
|
||||
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
|
||||
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
|
||||
refs/heads/), remote refs (i.e. under refs/remotes/),
|
||||
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.
|
||||
Common unit suffixes of 'k', 'm', or 'g' are supported.
|
||||
|
||||
core.excludesFile::
|
||||
In addition to '.gitignore' (per-directory) and
|
||||
'.git/info/exclude', Git looks into this file for patterns
|
||||
of files which are not meant to be tracked. "`~/`" is expanded
|
||||
to the value of `$HOME` and "`~user/`" to the specified user's
|
||||
home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
|
||||
If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
|
||||
Specifies the pathname to the file that contains patterns to
|
||||
describe paths that are not meant to be tracked, in addition
|
||||
to '.gitignore' (per-directory) and '.git/info/exclude'.
|
||||
Defaults to `$XDG_CONFIG_HOME/git/ignore`.
|
||||
If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
|
||||
is used instead. See linkgit:gitignore[5].
|
||||
|
||||
core.askPass::
|
||||
@ -615,8 +624,8 @@ core.attributesFile::
|
||||
'.git/info/attributes', Git looks into this file for attributes
|
||||
(see linkgit:gitattributes[5]). Path expansions are made the same
|
||||
way as for `core.excludesFile`. Its default value is
|
||||
$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
|
||||
set or empty, $HOME/.config/git/attributes is used instead.
|
||||
`$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
|
||||
set or empty, `$HOME/.config/git/attributes` is used instead.
|
||||
|
||||
core.editor::
|
||||
Commands such as `commit` and `tag` that lets you edit
|
||||
@ -1106,9 +1115,8 @@ commit.status::
|
||||
message. Defaults to true.
|
||||
|
||||
commit.template::
|
||||
Specify a file to use as the template for new commit messages.
|
||||
"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
|
||||
specified user's home directory.
|
||||
Specify the pathname of a file to use as the template for
|
||||
new commit messages.
|
||||
|
||||
credential.helper::
|
||||
Specify an external helper to be called when a username or
|
||||
@ -1334,7 +1342,7 @@ gc.worktreePruneExpire::
|
||||
'git worktree prune --expire 3.months.ago'.
|
||||
This config variable can be used to set a different 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.
|
||||
|
||||
gc.reflogExpire::
|
||||
@ -1474,13 +1482,13 @@ grep.fallbackToNoIndex::
|
||||
is executed outside of a git repository. Defaults to false.
|
||||
|
||||
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
|
||||
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
|
||||
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
|
||||
standard output.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user