Re: [PATCH] Documentation: use {asterisk} in rev-list-options.txt when needed
- From
Carlos Martín Nieto <cmn@elego.de>
- Date
- Feb 28, 2012, 20:20 UTC
- Message-ID
- <1330460423.691.15.camel@centaur.lab.cmartin.tk>
- In-Reply-To
- <20120228194551.GC11725@sigill.intra.peff.net>
On Tue, 2012-02-28 at 14:45 -0500, Jeff King wrote:
Show 5 quoted lines
> 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/
Oops. Thanks. Can you squash that in, Junio?
Show 16 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.The generated documentation in the 'html' branch shows the wrong formatting as well even for 1.7.0 when the --glob feature and its explanation was first introduced. So either nobody reads the documentation or very few people actually care about --glob and use the --remotes and friends, where that part of the explanation isn't that interesting.
cmn