config: describe 'pathname' value type
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>
Junio C Hamano committed
Apr 29, 2016 at 10:43 UTC
dca83abde26eefab17ac0a11b1440f0a16b7fc72
1 file changed
+19
-11
Documentation/config.txt
+19
-11
@@ -81,13 +81,16 @@ Includes
81
82
You can include one config file from another by setting the special
83
`include.path` variable to the name of the file to be included. The
84
+variable takes a pathname as its value, and is subject to tilde
85
+expansion.
86
+
87
+The
88
included file is expanded immediately, as if its contents had been
89
found at the location of the include directive. If the value of the
90
`include.path` variable is a relative path, the path is considered to be
91
relative to the configuration file in which the include directive was
88
-found. The value of `include.path` is subject to tilde expansion: `~/`
89
-is expanded to the value of `$HOME`, and `~user/` to the specified
90
-user's home directory. See below for examples.
92
+found. See below for examples.
93
+
94
95
Example
96
~~~~~~~
@@ -169,6 +172,13 @@ thing on the same output line (e.g. opening parenthesis before the
172
list of branch names in `log --decorate` output) is set to be
173
painted with `bold` or some other attribute.
174
175
+pathname::
176
+ A variable that takes a pathname value can be given a
177
+ string that begins with "`~/`" or "`~user/`", and the usual
178
+ tilde expansion happens to such a string: `~/`
179
+ is expanded to the value of `$HOME`, and `~user/` to the
180
+ specified user's home directory.
181
+
182
183
Variables
184
~~~~~~~~~
@@ -584,11 +594,10 @@ be delta compressed, but larger binary media files won't be.
594
Common unit suffixes of 'k', 'm', or 'g' are supported.
595
596
core.excludesFile::
587
- In addition to '.gitignore' (per-directory) and
588
- '.git/info/exclude', Git looks into this file for patterns
589
- of files which are not meant to be tracked. "`~/`" is expanded
590
- to the value of `$HOME` and "`~user/`" to the specified user's
591
- home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
597
+ Specifies the pathname to the file that contains patterns to
598
+ describe paths that are not meant to be tracked, in addition
599
+ 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
602
is used instead. See linkgit:gitignore[5].
603
@@ -1095,9 +1104,8 @@ commit.status::
1104
message. Defaults to true.
1105
1106
commit.template::
1098
- Specify a file to use as the template for new commit messages.
1099
- "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1100
- specified user's home directory.
1107
+ Specify the pathname of a file to use as the template for
1108
+ new commit messages.
1109
1110
credential.helper::
1111
Specify an external helper to be called when a username or