diff options
| author |  Jeff King <peff@peff.net> | 2017-05-11 05:13:04 -0400 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2017-05-12 10:06:58 +0900 |
| commit | a076df2813a4f1c93b22ca586865b32b3e3a08a7 (patch) | |
| tree | fde96489f8ab74cd80895951685a11cfdc609fe5 | |
| parent | docs/config: give a relative includeIf example (diff) | |
| download | tgif-a076df2813a4f1c93b22ca586865b32b3e3a08a7.tar.xz | |
docs/config: avoid the term "expand" for includes
Using the word "expand" to refer to including the contents
of another config file isn't really accurate, since it's a
verbatim insertion. And it can cause confusion with the
expanding of the path itself via things like "~".
Let's clarify when we are referring to the contents versus
the filename, and use appropriate verbs in each case.
Signed-off-by: Jeff King <peff@peff.net>
Reviewed-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/config.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt index cc6d79e537..be75f70055 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -90,8 +90,8 @@ You can include a config file from another by setting the special to be included. The variable takes a pathname as its value, and is subject to tilde expansion. These variables can be given multiple times. -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 +The contents of the included file are inserted immediately, as if they +had been found at the location of the include directive. If the value of the variable is a relative path, the path is considered to be relative to the configuration file in which the include directive was found. See below for examples. @@ -172,8 +172,8 @@ 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 ; find "foo" relative to the current file + path = ~/foo ; find "foo" in your `$HOME` directory ; include if $GIT_DIR is /path/to/foo/.git [includeIf "gitdir:/path/to/foo/.git"] |