docs/config: clarify include/includeIf relationship
The "includeIf" directives behave exactly like include ones, except they only kick in when the conditional is true. That was mentioned in the "conditional" section, but let's make it more clear for the whole "includes" section, since people don't necessarily read the documentation top to bottom. 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>
Jeff King committed
May 11, 2017 at 05:10 UTC
9d71d94d34fb3d3bb206ab9d5dbe08eb529ca729
1 file changed
+11
-6
Documentation/config.txt
+11
-6
@@ -79,14 +79,20 @@ escape sequences) are invalid.
79
Includes
80
~~~~~~~~
81
82
+The `include` and `includeIf` sections allow you to include config
83
+directives from another source. These sections behave identically to
84
+each other with the exception that `includeIf` sections may be ignored
85
+if their condition does not evaluate to true; see "Conditional includes"
86
+below.
87
+
88
You can include a config file from another by setting the special
83
-`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. `include.path` can be given multiple times.
89
+`include.path` (or `includeIf.*.path`) variable to the name of the file
90
+to be included. The variable takes a pathname as its value, and is
91
+subject to tilde expansion. These variables can be given multiple times.
92
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
89
-`include.path` variable is a relative path, the path is considered to
95
+variable is a relative path, the path is considered to
96
be relative to the configuration file in which the include directive
97
was found. See below for examples.
98
@@ -95,8 +101,7 @@ Conditional includes
101
102
You can include a config file from another conditionally by setting a
103
`includeIf.<condition>.path` variable to the name of the file to be
98
-included. The variable's value is treated the same way as
99
-`include.path`. `includeIf.<condition>.path` can be given multiple times.
104
+included.
105
106
The condition starts with a keyword followed by a colon and some data
107
whose format and meaning depends on the keyword. Supported keywords