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

config: describe 'pathname' value type

Browse Source 
We have a dedicated section for various value-types used in the
configuration variables already, because we needed to describe how
booleans and scaled integers can be spelled, and the pathname type
would fit there.

Adjust the description of `include.path`, `core.excludesFile` and
`commit.template` variables slightly to clarify that these variables
are of this type.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Junio C Hamano
2016-04-29 10:43:55 -07:00
parent e46579643d
commit dca83abde2
1 changed files with 19 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
Documentation/config.txt
View File

@ -81,13 +81,16 @@ Includes
You can include one config file from another by setting the special 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 `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 included file is expanded immediately, as if its contents had been
found at the location of the include directive. If the value of the 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 `include.path` variable is a relative path, the path is considered to be
relative to the configuration file in which the include directive was relative to the configuration file in which the include directive was
found. The value of `include.path` is subject to tilde expansion: `~/` found. See below for examples.
is expanded to the value of `$HOME`, and `~user/` to the specified
user's home directory. See below for examples.
Example Example
~~~~~~~ ~~~~~~~
@ -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 list of branch names in `log --decorate` output) is set to be
painted with `bold` or some other attribute. 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 Variables
~~~~~~~~~ ~~~~~~~~~
@ -584,11 +594,10 @@ be delta compressed, but larger binary media files won't be.
Common unit suffixes of 'k', 'm', or 'g' are supported. Common unit suffixes of 'k', 'm', or 'g' are supported.
core.excludesFile:: core.excludesFile::
In addition to '.gitignore' (per-directory) and Specifies the pathname to the file that contains patterns to
'.git/info/exclude', Git looks into this file for patterns describe paths that are not meant to be tracked, in addition
of files which are not meant to be tracked. "`~/`" is expanded to '.gitignore' (per-directory) and '.git/info/exclude'.
to the value of `$HOME` and "`~user/`" to the specified user's Defaults to $XDG_CONFIG_HOME/git/ignore.
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 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].
@ -1095,9 +1104,8 @@ commit.status::
message. Defaults to true. message. Defaults to true.
commit.template:: commit.template::
Specify a file to use as the template for new commit messages. Specify the pathname of a file to use as the template for
"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the new commit messages.
specified user's home directory.
credential.helper:: credential.helper::
Specify an external helper to be called when a username or Specify an external helper to be called when a username or