threads / patch / 22571

patchDocumentation: git-add: correct first example

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

## tl;dr

3 messages between Feb 8, 2010 and Feb 8, 2010. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Greg Bacon· Feb 8, 2010, 17:35 UTC · lore

The first example for git-add covers recursive adding of patterns but contains an extra backslash. If copied verbatim, the command fails with

fatal: pathspec 'Documentation/\*.txt' did not match any files
This patch corrects the problem and adds an equivalent invocation.
Signed-off-by: Greg Bacon <gbacon@dbresearch.net>
---
 Documentation/git-add.txt |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)
Show changes to Documentation/git-add.txt +3 −2
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index f74fcf3..93e8f57 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -149,11 +149,12 @@ those in info/exclude.  See linkgit:gitrepository-layout[5].
 EXAMPLES
 --------
 
-* Adds content from all `\*.txt` files under `Documentation` directory
+* Adds content from all `*.txt` files under `Documentation` directory
 and its subdirectories:
 +
 ------------
-$ git add Documentation/\\*.txt
+$ git add Documentation/\*.txt
+$ git add 'Documentation/*.txt'  # same thing
 ------------
 +
 Note that the asterisk `\*` is quoted from the shell in this

-- 
1.6.5.5
Junio C Hamano· Feb 8, 2010, 19:22 UTC · re: Greg Bacon · lore

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

Greg Bacon <gbacon@dbresearch.net> writes:
> The first example for git-add covers recursive adding of patterns but
> contains an extra backslash.
Correct.
Show 15 quoted lines
> Signed-off-by: Greg Bacon <gbacon@dbresearch.net>
> ---
>  Documentation/git-add.txt |    5 +++--
>  1 files changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
> index f74fcf3..93e8f57 100644
> --- a/Documentation/git-add.txt
> +++ b/Documentation/git-add.txt
> @@ -149,11 +149,12 @@ those in info/exclude.  See linkgit:gitrepository-layout[5].
>  EXAMPLES
>  --------
>  
> -* Adds content from all `\*.txt` files under `Documentation` directory
> +* Adds content from all `*.txt` files under `Documentation` directory
For this, both
    http://www.kernel.org/pub/software/scm/git/docs/git-add.html
and output from
    git help add
in my local build seem to be rendered correctly by AsciiDoc.
>  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.
Junio C Hamano· Feb 8, 2010, 20:08 UTC · re: Junio C Hamano · lore

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

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.

← back to recent threads