Re: [PATCH 3/3] doc: git-config: escape erroneous adoc markup

[Junio C Hamano <gitster@pobox.com>]

Junio C Hamano <gitster@pobox.com> writes:

> Thanks.  
>
> What we see in
> https://git-scm.com/docs/git-config#Documentation/git-config.txt---commentmessage
> is rather embarrasing.  This would be a vast improvement ;-)
>
>> diff --git a/Documentation/git-config.adoc b/Documentation/git-config.adoc
>> index 8439ce97df..708e88cdeb 100644
>> --- a/Documentation/git-config.adoc
>> +++ b/Documentation/git-config.adoc
>> @@ -119,10 +119,10 @@ OPTIONS
>>  	Append a comment at the end of new or modified lines.
>>  +
>>  If _<message>_ begins with one or more whitespaces followed
>> -by "#", it is used as-is.  If it begins with "#", a space is
>> +by "\#", it is used as-is.  If it begins with "#", a space is
>>  prepended before it is used.  Otherwise, a string " # " (a

With this change, I wonder if this '#' on the next line gets paired
as the closing element that corresponds to the second one on the
previous line, which is not quoted hence can be taken as the opening
element?  Even if the one on the second line does not get taken as a
closing element now, if a future change adds some word with '#' that
does, the second "#" on the line left unquoted by this patch would
then require quoting, no?  IOW, would it be better to do this

>> -by "#", it is used as-is.  If it begins with "#", a space is
>> +by "\#", it is used as-is.  If it begins with "\#", a space is

so that we do not have to worry about "special cases" where it
becomes unnecessary to quote "#"s?


>>  space followed by a hash followed by a space) is prepended
>> -to it.  And the resulting string is placed immediately after
>> +to it.  The resulting string is placed immediately after
>>  the value defined for the variable.  The _<message>_ must
>>  not contain linefeed characters (no multi-line comments are
>>  permitted).