Skip to content

Commit

Permalink
Documentation: quoting trouble in "git rm" discussion
Browse files Browse the repository at this point in the history
The current output (with Asciidoc 8.5.2) seems a bit broken:

	given two directories ‘d` and d2, there is a difference
	between using git rm 'd*’ and ‘git rm 'd/\*\’`, as the
	former will also remove all of directory d2.

In other words, the markup parses as

	given two directories << d` and _d2_, there is a difference
	between using _git rm 'd* >>_ and << git rm 'd/\*\ >> `.

I suspect there is an asciidoc bug involved (why is ' a candidate
closing-quote mark when it is preceded by a backslash?) but with
all the meanings of ` and ' involved I do not want to track it
down.  Better to use unambiguous {asterisk} and {apostrophe}
entities.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Jonathan Nieder authored and Junio C Hamano committed Aug 20, 2010
1 parent e860795 commit 438ded4
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions Documentation/asciidoc.conf
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ caret=&#94;
startsb=&#91;
endsb=&#93;
tilde=&#126;
apostrophe=&#39;
backtick=&#96;

ifdef::backend-docbook[]
Expand Down
3 changes: 2 additions & 1 deletion Documentation/git-rm.txt
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ a file that you have not told git about does not remove that file.

File globbing matches across directory boundaries. Thus, given
two directories `d` and `d2`, there is a difference between
using `git rm \'d\*\'` and `git rm \'d/\*\'`, as the former will
using `git rm {apostrophe}d{asterisk}{apostrophe}` and
`git rm {apostrophe}d/{asterisk}{apostrophe}`, as the former will
also remove all of directory `d2`.

REMOVING FILES THAT HAVE DISAPPEARED FROM THE FILESYSTEM
Expand Down

0 comments on commit 438ded4

Please sign in to comment.