Documentation: clarify quoting in "git rm" example

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>
This commit is contained in:
Jonathan Nieder 2010-08-20 05:30:24 -05:00 committed by Junio C Hamano
parent 3988da0636
commit c300578f12

View File

@ -136,11 +136,11 @@ git diff --name-only --diff-filter=D -z | xargs -0 git rm --cached
EXAMPLES EXAMPLES
-------- --------
git rm Documentation/\\*.txt:: git rm Documentation/\*.txt::
Removes all `\*.txt` files from the index that are under the Removes all `*.txt` files from the index that are under the
`Documentation` directory and any of its subdirectories. `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 example; this lets git, and not the shell, expand the pathnames
of files and subdirectories under the `Documentation/` directory. of files and subdirectories under the `Documentation/` directory.