Skip to content

Commit a076df2

Browse files
peffgitster
authored andcommitted
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 <[email protected]> Reviewed-by: Ævar Arnfjörð Bjarmason <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 994cd6c commit a076df2

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Documentation/config.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ You can include a config file from another by setting the special
9090
to be included. The variable takes a pathname as its value, and is
9191
subject to tilde expansion. These variables can be given multiple times.
9292

93-
The included file is expanded immediately, as if its contents had been
94-
found at the location of the include directive. If the value of the
93+
The contents of the included file are inserted immediately, as if they
94+
had been found at the location of the include directive. If the value of the
9595
variable is a relative path, the path is considered to
9696
be relative to the configuration file in which the include directive
9797
was found. See below for examples.
@@ -172,8 +172,8 @@ Example
172172

173173
[include]
174174
path = /path/to/foo.inc ; include by absolute path
175-
path = foo ; expand "foo" relative to the current file
176-
path = ~/foo ; expand "foo" in your `$HOME` directory
175+
path = foo ; find "foo" relative to the current file
176+
path = ~/foo ; find "foo" in your `$HOME` directory
177177

178178
; include if $GIT_DIR is /path/to/foo/.git
179179
[includeIf "gitdir:/path/to/foo/.git"]

0 commit comments

Comments
 (0)