Code

Documentation: clarify quoting in "git rm" example
authorJonathan Nieder <jrnieder@gmail.com>
Fri, 20 Aug 2010 10:30:24 +0000 (05:30 -0500)
committerJunio C Hamano <gitster@pobox.com>
Fri, 20 Aug 2010 21:16:21 +0000 (14:16 -0700)
Intended output:

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

Note that the asterisk * is quoted from the shell in
this example; this lets git, and not the shell, expand
the pathnames of files and subdirectories under the
Documentation/ directory.

Without this change, there are too many backslashes output.
Tested with asciidoc 8.5.2.

Reported-by: Frédéric Brière <fbriere@fbriere.net>
Cc: Carl Worth <cworth@cworth.org>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-rm.txt

index d146751caacc163d3f905fba726c2475baa4098e..71e3d9fc23ab6f1c181c47ebb7c9483950a9e9a6 100644 (file)
@@ -136,11 +136,11 @@ git diff --name-only --diff-filter=D -z | xargs -0 git rm --cached
 
 EXAMPLES
 --------
-git rm Documentation/\\*.txt::
-       Removes all `\*.txt` files from the index that are under the
+git rm Documentation/\*.txt::
+       Removes all `*.txt` files from the index that are under the
        `Documentation` directory and any of its subdirectories.
 +
-Note that the asterisk `\*` is quoted from the shell in this
+Note that the asterisk `*` is quoted from the shell in this
 example; this lets git, and not the shell, expand the pathnames
 of files and subdirectories under the `Documentation/` directory.