Re: [PATCH] Documentation: use {asterisk} in rev-list-options.txt when needed
- From
Jeff King <peff@peff.net>
- Date
- Feb 28, 2012, 19:45 UTC
- Message-ID
- <20120228194551.GC11725@sigill.intra.peff.net>
- In-Reply-To
- <1330443348-5742-1-git-send-email-cmn@elego.de>
On Tue, Feb 28, 2012 at 04:35:48PM +0100, Carlos Martín Nieto wrote:
> Text between to '*' is emphasized in AsciiDoc which made the
s/to/two/
Show 9 quoted lines
> glob-related explanations in rev-list-options.txt very confusing, as
> the rendered text would be missing two asterisks and the text between
> them would be emphasized instead.
>
> Use '{asterisk}' where needed to make them show up as asterisks in the
> rendered text.
> [...]
> - '*', or '[', '/*' at the end is implied.
> + '{asterisk}', or '[', '/{asterisk}' at the end is implied.Ugh. I hate asciidoc more with each passing year. Readable source documents are such a wonderful idea, but the markup makes it less and less readable as we accumulate fixes like this. I wonder if this has always been a bug, or something that appeared in more recent versions of the toolchain.
Anyway, that is not a problem with your patch. :) I confirmed that the bug happens in my version of the toolchain, and your fix works (I also tried using `*`, but backtick does not suppress markup. It would be nice if there was an easy marker for "this is a literal name: no markup, tt font, etc", but I don't think that exists).
Acked-by: Jeff King <peff@peff.net>
-Peff