On 2024-03-21 07:22, Eric Sunshine wrote:
On Thu, Mar 21, 2024 at 2:06 AM Dragan Simic <dsimic@xxxxxxxxxxx>
wrote:
Make it more clear what the whitespace characters are in the context
of git
configuration files, and significantly improve the description of the
leading
and trailing whitespace handling, especially how it works out together
with
the presence of inline comments.
Helped-by: Junio C Hamano <gitster@xxxxxxxxx>
Helped-by: Eric Sunshine <sunshine@xxxxxxxxxxxxxx>
Signed-off-by: Dragan Simic <dsimic@xxxxxxxxxxx>
---
Changes in v5:
- Rewrote the description of whitespace character handling
again,
to eliminate ambiguity, as suggested by Eric Sunshine [3][4]
- Extended the improvements to the following paragraph as
well, to
tie it all together, and to make it less ambiguous how to
include
leading and trailing whitespace characters into
configuration
option values, if desired so
diff --git a/Documentation/config.txt b/Documentation/config.txt
@@ -63,16 +64,17 @@ the variable is the boolean "true").
+Whitespace characters surrounding `name`, `=` and `value` are
discarded.
+Internal whitespace characters within 'value' are retained verbatim.
+Comments starting with either `#` or `;` and extending to the end of
line
+are discarded. A line that defines a value can be continued to the
next
+line by ending it with a backslash (`\`); the backslash and the
end-of-line
+characters are discarded.
+
+If `value` needs to contain leading or trailing whitespace
characters,
+it must be enclosed in double quotation marks (`"`). Inside double
quotation
+marks, double quote (`"`) and backslash (`\`) characters must be
escaped:
+use `\"` for `"` and `\\` for `\`.
Thanks. I find this discussion clearer than v4.
I don't have any further review comments on v5.
Great, thanks! I really appreciate your prompt and detailed reviews.
