Stas Bekman reported [1] that Git config was not accepting single quotes around a filename as may have been expected by shell users. Highlight the 'name = value' syntax with its own heading. Clarify that single quotes are not special here. Also point to this paragraph in the 'include' section regarding pathnames. In addition clarify that missing include file paths are not an error, but rather an implicit 'if found' for include files. [1] https://public-inbox.org/git/ca2b192e-1722-092e-2c54-d79d21a66ba2@xxxxxxxxxx/ Reported-by: Stas Bekman <stas@xxxxxxxxxx> Signed-off-by: Philip Oakley <philipoakley@xxxxxxx> --- Documentation/config.txt | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 1264d91fa3..b65fd6138d 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -19,8 +19,8 @@ characters and `-`, and must start with an alphabetic character. Some variables may appear multiple times; we say then that the variable is multivalued. -Syntax -~~~~~~ +Config file Syntax +~~~~~~~~~~~~~~~~~~ The syntax is fairly flexible and permissive; whitespaces are mostly ignored. The '#' and ';' characters begin comments to the end of line, @@ -56,6 +56,9 @@ syntax, the subsection name is converted to lower-case and is also compared case sensitively. These subsection names follow the same restrictions as section names. +Variable name/value syntax +^^^^^^^^^^^^^^^^^^^^^^^^^^ + All the other lines (and the remainder of the line after the section header) are recognized as setting variables, in the form 'name = value' (or just 'name', which is a short-hand to say that @@ -69,7 +72,8 @@ stripped. Leading whitespaces after 'name =', the remainder of the line after the first comment character '#' or ';', and trailing whitespaces of the line are discarded unless they are enclosed in double quotes. Internal whitespaces within the value are retained -verbatim. +verbatim. Single quotes are not special and form part of the +variable's value. Inside double quotes, double quote `"` and backslash `\` characters must be escaped: use `\"` for `"` and `\\` for `\`. @@ -89,10 +93,14 @@ each other with the exception that `includeIf` sections may be ignored if their condition does not evaluate to true; see "Conditional includes" below. +Both the `include` and `includeIf` sections implicitly apply an 'if found' +condition to the given path names. + You can include a config file from another by setting the special `include.path` (or `includeIf.*.path`) variable to the name of the file to be included. The variable takes a pathname as its value, and is -subject to tilde expansion. These variables can be given multiple times. +subject to tilde expansion and the value syntax detailed above. +These variables can be given multiple times. 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 -- 2.17.1.windows.2
