hg command reference?

Martin Geisler mg at lazybytes.net
Wed Apr 21 03:04:26 CDT 2010


Matt Mackall <mpm at selenic.com> writes:

> On Tue, 2010-04-20 at 09:42 -0700, Jens Alfke wrote:
>> On Apr 20, 2010, at 12:52 AM, Nicolas Dumazet wrote:
>> 
>> > Our wiki definitely needs maintenance, though!
>> 
>> I had a feeling somebody would say that :)
>
> Actually, the place to do this is probably in the code itself. We now
> have a very nice formatter in place that will generate, text, html,
> etc. and the ability to add various sections that can be optionally be
> displayed. For instance, compare:
>
> hg help add
> hg help add -v
>
> If we want to automatically generate a web page per command from the
> latest verbose help text, we can probably do that pretty easily.

Yes, that should be no problem -- we have good control over the
docstrings, by which I mean that we know how to find them and we can
manipulate them however we want.

With the support for optional sections that got into Mercurial 1.5 we
can easily include sections in the docstrings that are for HTML (and
manpage) output only. Those sections will be able to use the full
reStructuredText syntax and not just the limited subset supported by
minirst.

-- 
Martin Geisler

Fast and powerful revision control: http://mercurial.selenic.com/


More information about the Mercurial mailing list