Re: [PATCH v3 4/4] config.txt: describe handling of whitespace further

From: Dragan Simic <dsimic@manjaro.org>
Date: Mar 20, 2024, 07:23 UTC
Message-ID: <c4f0e7311edce5d4ed4a55f290de9eaf@manjaro.org>
In-Reply-To: <xmqqttl1js1o.fsf@gitster.g>

On 2024-03-20 08:12, Junio C Hamano wrote:

Show 12 quoted lines

> Dragan Simic <dsimic@manjaro.org> writes:
> 
>>  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 after 'name =', the remainder of the
>>  line after the first comment character '#' or ';', and trailing
>> +whitespace characters of the line are discarded unless they are 
>> enclosed
>> +in double quotes.
> 
> Can we directly tighten the "trailing..." part, instead of having to
> add an extra long sentence ...

Makes sense, to make it less convoluted.

Show 7 quoted lines

>> +The discarding of the trailing whitespace characters
>> +applies regardless of the discarding of the portion of the line after
>> +the first comment character.
> 
> ... like this as an attempt to clarify?
> 
>     Leading whitespace characters before and after 'name =', and the

Hmm, "leading whitespace" and "after" don't go very well together. Such a construct seems a bit confusing, because it implies there's something else after, which the leading whitespace refers to, which may or may not be easily understandable to the users.

I'll think about how to rephrase this a bit better.

Show 9 quoted lines

>     remainder of the line after the first comment character '#' or
>     ';', are removed, and then trailing whitespace characters at the
>     end of the line are discarded.
> 
> By the way, if a run of whitespace characters are enclosed in double
> quotes, they cannot be trailing at the end of the line, as the
> closing double quote is not a whitespace character, so it is out of
> place to talk about quoted string in the context of trailing blank
> removal.  The unquoting would want to be discussed separately.

I'll think about this as well.

>>  Inside double quotes, double quote `"` and backslash `\` characters
>>  must be escaped: use `\"` for `"` and `\\` for `\`.
> 
> Thanks for working on this topic.

Thank you for your highly detailed reviews!