From: Dragan Simic <dsimic@manjaro.org>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: git@vger.kernel.org, gitster@pobox.com, rsbecker@nexbridge.com,
github@seichter.de
Subject: Re: [PATCH v5 4/4] config.txt: describe handling of whitespace further
Date: Thu, 21 Mar 2024 07:25:42 +0100 [thread overview]
Message-ID: <4e816c433be4205c83a20c8a4c97a8f4@manjaro.org> (raw)
In-Reply-To: <CAPig+cToaiCzj2XwNSeStx7p7ZPn7=a2nKZBFLwX12Uj=hJ7cw@mail.gmail.com>
On 2024-03-21 07:22, Eric Sunshine wrote:
> On Thu, Mar 21, 2024 at 2:06 AM Dragan Simic <dsimic@manjaro.org>
> 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@pobox.com>
>> Helped-by: Eric Sunshine <sunshine@sunshineco.com>
>> Signed-off-by: Dragan Simic <dsimic@manjaro.org>
>> ---
>> 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.
next prev parent reply other threads:[~2024-03-21 6:25 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-21 6:06 [PATCH v5 0/4] Fix a bug in configuration parsing, and improve tests and documentation Dragan Simic
2024-03-21 6:06 ` [PATCH v5 1/4] config: minor addition of whitespace Dragan Simic
2024-03-21 6:06 ` [PATCH v5 2/4] config: really keep value-internal whitespace verbatim Dragan Simic
2024-03-21 6:06 ` [PATCH v5 3/4] t1300: add more tests for whitespace and inline comments Dragan Simic
2024-03-21 6:06 ` [PATCH v5 4/4] config.txt: describe handling of whitespace further Dragan Simic
2024-03-21 6:22 ` Eric Sunshine
2024-03-21 6:25 ` Dragan Simic [this message]
2024-03-21 22:58 ` Junio C Hamano
2024-03-22 4:50 ` Dragan Simic
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4e816c433be4205c83a20c8a4c97a8f4@manjaro.org \
--to=dsimic@manjaro.org \
--cc=git@vger.kernel.org \
--cc=github@seichter.de \
--cc=gitster@pobox.com \
--cc=rsbecker@nexbridge.com \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.