Re: [PATCH] Fix typos in git-remote.txt and git-symbolic-ref.txt

From: Thomas Rast <trast@student.ethz.ch>
Date: Aug 11, 2009, 07:09 UTC
Message-ID: <200908110909.33904.trast@student.ethz.ch>
In-Reply-To: <20090811005207.GE24183@headley>

Thanks for the updated version!

Štěpán Němec wrote:

Show 6 quoted lines

> 
> I did look at some of the other documentation files (and now also grepped
> the whole directory for `--' and `\--' occurences), but wasn't able to see
> any rule or consistence in the usage. Whether it is an indication of
> real inconsistence or just another example of my ignorance I do not know
> (not now, at least).

Well, as I said I'm not sure what asciidoc versions, if any, needed the backslash inside backtick quoting. However, there is precedent in

commit e1ccf53a60657930ae7892387736c8b6a91ec610
Author: Yasushi SHOJI <yashi@atmark-techno.com>
Date:   Mon Sep 12 02:29:10 2005 +0900

    [PATCH] Escape asciidoc's built-in em-dash replacement

    AsciiDoc replace '--' with em-dash (&#8212) by default. em-dash
    looks a lot like a single long dash and it's very confusing when
    we are talking about command options.

    Section 21.2.8 'Replacements' of AsciiDoc's User Guide says that a
    backslash in front of double dash prevent the replacement.  This
    patch does just that.

    Signed-off-by: Yasushi SHOJI <yashi@atmark-techno.com>
    Signed-off-by: Junio C Hamano <junkio@cox.net>

So until we know for certain that they're not needed, I'd rather not actively remove them. Admittedly, there are lots of instances of `-- in the docs too, so making sure which way is "right" and then replacing _all_ of them would probably be a nice cleanup.

-- 
Thomas Rast
trast@{inf,student}.ethz.ch