Skip to content

Commit fd87e70

Browse files
committed
Merge branch 'jc/config-pathname-type'
Consolidate description of tilde-expansion that is done to configuration variables that take pathname to a single place. * jc/config-pathname-type: config: describe 'pathname' value type
2 parents 459000e + dca83ab commit fd87e70

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
~~~~~~~~~
@@ -593,11 +603,10 @@ be delta compressed, but larger binary media files won't be.
593603
Common unit suffixes of 'k', 'm', or 'g' are supported.
594604

595605
core.excludesFile::
596-
In addition to '.gitignore' (per-directory) and
597-
'.git/info/exclude', Git looks into this file for patterns
598-
of files which are not meant to be tracked. "`~/`" is expanded
599-
to the value of `$HOME` and "`~user/`" to the specified user's
600-
home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
606+
Specifies the pathname to the file that contains patterns to
607+
describe paths that are not meant to be tracked, in addition
608+
to '.gitignore' (per-directory) and '.git/info/exclude'.
609+
Defaults to $XDG_CONFIG_HOME/git/ignore.
601610
If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
602611
is used instead. See linkgit:gitignore[5].
603612

@@ -1123,9 +1132,8 @@ commit.status::
11231132
message. Defaults to true.
11241133

11251134
commit.template::
1126-
Specify a file to use as the template for new commit messages.
1127-
"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1128-
specified user's home directory.
1135+
Specify the pathname of a file to use as the template for
1136+
new commit messages.
11291137

11301138
credential.helper::
11311139
Specify an external helper to be called when a username or

0 commit comments

Comments
 (0)