[PATCH] help: 'hg help' supports subtopics (issue2804)

Martin Geisler mg at aragost.com
Mon May 16 09:22:28 CDT 2011


yun lee <yun.lee.bj at gmail.com> writes:

> 2011/5/14 Martin Geisler <mg at lazybytes.net>:
>> Yes, the idea is that we can have as much documentation as we want for
>> each configuration value.
>>
>> But let us backtrack a little: let us start by making
>>
>>  $ hg help alias
>>
>> show what you see on
>>
>>  http://www.selenic.com/mercurial/hgrc.5.html#alias
>>
>> In other words, let us take the parts of your patch that adds the
>> sub-topic functionality. That will be patch nr 1.
>
> Yes, Martin. I would love to, but I still feel puzzled. For  patch nr1,
> 1.) Use "##" format?
> 2.) Put the concrete description in *.txt?

Ehm, yeah, I see that what I wrote is confusing :-) I don't think we
should implement the '##' comment format first -- we should add the
sub-topic functionality since that will be useful later.

So first add sub-topic functionality, then move the hgrc.5.txt content
to sub-topics (as .txt files). Later we can move help from .txt files
into source code comments that are extracted at build time.

>> since we've tried to teach ourselves and users to talk about config
>> settings as "section.name", not "config.section.name". So we could
>> add a flag to 'hg help', just like it now has flags to show the
>> module help string when a command exist with the same name as an
>> extension.
>
> Could you give an example for it, please?

This changesets adds the --command flag to 'hg help' and tests it:

  http://selenic.com/hg/rev/005a540e9aee

So 'hg help multirevs' show the help topic, and 'hg help -c multirevs'
show the help for the command added by the extension.

-- 
Martin Geisler

aragost Trifork
Professional Mercurial support
http://mercurial.aragost.com/kick-start/


More information about the Mercurial-devel mailing list