[PATCH 3/4] docs/config: avoid the term "expand" for includes
- From
Jeff King <peff@peff.net>
- Date
- May 11, 2017, 09:13 UTC
- Message-ID
- <20170511091304.ivauge72dncv65fs@sigill.intra.peff.net>
- In-Reply-To
- <20170511090905.tvkb4bk2ddjzjip4@sigill.intra.peff.net>
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> --- I dropped the "& insert" from your suggestion, because I think it clear in the context of the earlier "include by absolute path" (and I think it reads better).
Documentation/config.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt index 929776954..70f79ac39 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"]
-- 2.13.0.447.g4d26bc97c