Re: [PATCH] documentation: escape '~' in git revert
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Dec 2, 2010, 18:05 UTC
- Message-ID
- <7v8w08rqx3.fsf@alter.siamese.dyndns.org>
- In-Reply-To
- <1291311393-31843-1-git-send-email-sylvain.rabot@f-secure.com>
Sylvain Rabot <sylvain.rabot@f-secure.com> writes:
> backslashing '~' characters do not have any effect, quoting with +++ has.
I vaguely recall that we tried to avoid using '+++' because versions of AsciiDoc that were widely used back when the bulk of documentation was written either did not handle the construct correctly, or did not know about it at all. So I would be very hesitant to take this patch as-is.
Giving a cursory look at:
http://www.kernel.org/pub/software/scm/git/docs/git-revert.html
the first instance (HEAD~3) seems to be formatted Ok there (they run AsciiDoc 8.4.5 with xmlto 0.0.23 on F13), but it seems that we do need to do something with the second one (~5..master~2).
I think the problem is that AsciiDoc takes ~something~ as a mark-up for something. Does it work to drop the backslash before ~5 and replace ~ with {tilde}, which was invented to deal with problems like this?
Show 26 quoted lines
> Signed-off-by: Sylvain Rabot <sylvain.rabot@f-secure.com> > --- > Documentation/git-revert.txt | 4 ++-- > 1 files changed, 2 insertions(+), 2 deletions(-) > > diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt > index f40984d..9368892 100644 > --- a/Documentation/git-revert.txt > +++ b/Documentation/git-revert.txt > @@ -82,12 +82,12 @@ effect to your index in a row. > > EXAMPLES > -------- > -git revert HEAD~3:: > +git revert HEAD+++~+++3:: > > Revert the changes specified by the fourth last commit in HEAD > and create a new commit with the reverted changes. > > -git revert -n master\~5..master~2:: > +git revert -n master+++~+++5..master+++~+++2:: > > Revert the changes done by commits from the fifth last commit > in master (included) to the third last commit in master > -- > 1.7.3.2