Re: [PATCH] Documentation: git-add: correct first example

From: Junio C Hamano <gitster@pobox.com>
Date: Feb 8, 2010, 20:08 UTC
Message-ID: <7v6367lccu.fsf@alter.siamese.dyndns.org>
In-Reply-To: <7vsk9bmt1h.fsf@alter.siamese.dyndns.org>

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

Show 12 quoted lines

>>  and its subdirectories:
>>  +
>>  ------------
>> -$ git add Documentation/\\*.txt
>
> This indeed results in double-backslash in the output.
>
>> +$ git add Documentation/\*.txt
>
> and this seems to fix it.
>
> Thanks.

To look for similar breakages, I ran

    git grep -n -e '\\\\' -- 'Documentation/*.txt'

and found this in git-rm.txt:

    EXAMPLES
    --------
    git rm Documentation/\\*.txt::
            Removes all `\*.txt` files from the index that are under the
            `Documentation` directory and any of its subdirectories.

What is intereseting is that this is rendered correctly. Quoting rule in AsciiDoc is mysterious...

It turns out that the breakage in "git add" documentation was a regression; the examples were written in a similar way to the one in "git rm" documentation. When 921177f (Documentation: improve "add", "pull" and "format-patch" examples, 2008-05-07) converted it to displayed text, nobody noticed that the difference in the backslash quoting rule between the enumeration header and displayed text.