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 v4 4/4] config.txt: describe handling of whitespace further
Date: Thu, 21 Mar 2024 06:16:01 +0100 [thread overview]
Message-ID: <9a5217f7f7a35768a3eb45060fb3e4f4@manjaro.org> (raw)
In-Reply-To: <CAPig+cSYhYBa0NsvJCOYo4JsWzLJT9rU++U1QKA3jRB6Cptbhw@mail.gmail.com>
On 2024-03-21 06:11, Eric Sunshine wrote:
> On Thu, Mar 21, 2024 at 12:17 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>
>> Signed-off-by: Dragan Simic <dsimic@manjaro.org>
>> ---
>> diff --git a/Documentation/config.txt b/Documentation/config.txt
>> @@ -63,13 +64,15 @@ the variable is the boolean "true").
>> A line that defines a value can be continued to the next line by
>> +ending it with a `\`; the backslash and the end-of-line are stripped.
>> +Leading whitespace characters before 'name =' are discarded.
>> +The portion of the line after the first comment character, including
>> +the comment character itself, is discarded. Unless enclosed in
>> double
>> +quotation marks (`"`), any leading or trailing whitespace characters
>> +surrounding 'value' are discarded. Internal whitespace characters
>> +within 'value' are retained verbatim.
>
> I find this statement confusing and ambiguous:
>
> Unless enclosed in double quotation marks (`"`), any leading or
> trailing whitespace characters surrounding 'value' are discarded.
>
> since it might imply that the shown <SP> and <TAB> whitespace is
> retained outside the quotes, as well:
>
> key =<SP><TAB>" string "<SP>
>
> It should be possible to rephrase it to be more definite, while
> dropping the final sentence altogether. Perhaps:
>
> Whitespace surrounding `name`, `=` and `value` is ignored. If
> `value` is surrounding by double quotation marks (`"`), all
> characters within the quoted string are retained verbatim,
> including whitespace. 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 `\`;
> the backslash and the end-of-line are stripped.
Looking good to me, thanks. I'll include it into the v5, with
a small grammar issue fixed.
next prev parent reply other threads:[~2024-03-21 5:16 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-21 4:17 [PATCH v4 0/4] Fix a bug in configuration parsing, and improve tests and documentation Dragan Simic
2024-03-21 4:17 ` [PATCH v4 1/4] config: minor addition of whitespace Dragan Simic
2024-03-21 4:17 ` [PATCH v4 2/4] config: really keep value-internal whitespace verbatim Dragan Simic
2024-03-21 4:17 ` [PATCH v4 3/4] t1300: add more tests for whitespace and inline comments Dragan Simic
2024-03-21 4:55 ` Eric Sunshine
2024-03-21 5:01 ` Dragan Simic
2024-03-21 4:17 ` [PATCH v4 4/4] config.txt: describe handling of whitespace further Dragan Simic
2024-03-21 5:11 ` Eric Sunshine
2024-03-21 5:16 ` Dragan Simic [this message]
2024-03-21 5:21 ` Eric Sunshine
2024-03-21 5:31 ` Dragan Simic
2024-03-21 7:32 ` Junio C Hamano
2024-03-21 4:50 ` [PATCH v4 0/4] Fix a bug in configuration parsing, and improve tests and documentation Eric Sunshine
2024-03-21 4:58 ` 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=9a5217f7f7a35768a3eb45060fb3e4f4@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.