Skip to content

Commit dca83ab

Browse files
committed
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 <[email protected]>
1 parent e465796 commit dca83ab

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

Documentation/config.txt

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,16 @@ Includes
8181

8282
You can include one config file from another by setting the special
8383
`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
8488
included file is expanded immediately, as if its contents had been
8589
found at the location of the include directive. If the value of the
8690
`include.path` variable is a relative path, the path is considered to be
8791
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+
9194

9295
Example
9396
~~~~~~~
@@ -169,6 +172,13 @@ thing on the same output line (e.g. opening parenthesis before the
169172
list of branch names in `log --decorate` output) is set to be
170173
painted with `bold` or some other attribute.
171174

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+
172182

173183
Variables
174184
~~~~~~~~~
@@ -584,11 +594,10 @@ be delta compressed, but larger binary media files won't be.
584594
Common unit suffixes of 'k', 'm', or 'g' are supported.
585595

586596
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.
592601
If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
593602
is used instead. See linkgit:gitignore[5].
594603

@@ -1095,9 +1104,8 @@ commit.status::
10951104
message. Defaults to true.
10961105

10971106
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.
11011109

11021110
credential.helper::
11031111
Specify an external helper to be called when a username or

0 commit comments

Comments
 (0)