git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
DSDragan Simic <dsimic@manjaro.org>
Date
Mar 21, 2024, 06:25 UTC
Message-ID
<4e816c433be4205c83a20c8a4c97a8f4@manjaro.org>
In-Reply-To
<CAPig+cToaiCzj2XwNSeStx7p7ZPn7=a2nKZBFLwX12Uj=hJ7cw@mail.gmail.com>
On 2024-03-21 07:22, Eric Sunshine wrote:
Show 49 quoted lines
> 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.
Previous: Eric SunshineNext: Junio C Hamano
Message 7 of 9 in “Fix a bug in configuration parsing, and improve tests and documentation”
  1. 0/4 Fix a bug in configuration parsing, and improve tests and documentationDragan Simic, Mar 21, 2024
  2. 1/4 config: minor addition of whitespaceDragan Simic, Mar 21, 2024
  3. 2/4 config: really keep value-internal whitespace verbatimDragan Simic, Mar 21, 2024
  4. 3/4 t1300: add more tests for whitespace and inline commentsDragan Simic, Mar 21, 2024
  5. 4/4 config.txt: describe handling of whitespace furtherDragan Simic, Mar 21, 2024
  6. Eric SunshineMar 21, 2024
  7. Dragan SimicMar 21, 2024
  8. Junio C HamanoMar 21, 2024
  9. Dragan SimicMar 22, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.