[PATCH] expand and clarify help for update

[Christian Boos]

Adrian Buehlmann wrote:
> On 30.10.2008 09:34, Dirkjan Ochtman wrote:
>   
>> Adrian Buehlmann <adrian <at> cadifra.com> writes:
>>     
>>> # HG changeset patch
>>> # User Adrian Buehlmann <adrian <at> cadifra.com>
>>> # Date 1225322906 -3600
>>> # Node ID 94bae0c425ba312c560c7cbe889554ab5bfbbd30
>>> # Parent  1493d1e05ca3034a104afca2f49aec2783be3df6
>>> expand and clarify help for update
>>>       
>> Like Giorgios, I think it's nice what you're trying to do here, but I don't
>> think making it this long is very effective. Trying to describe every little
>> corner case of update's behavior

>>  just means people won't read it all or get
>> scared of using it. Let's instead give people an idea of what the purpose is
>> (and what other commands could be used instead) and what the options are.
>>     
>
> Ok. I'll drop working on this. Please ignore that patch.
>   

Well, having more in-depth documentation readily available wouldn't hurt.
Could we imagine "escalating" things to the web?

So we start from the one-liner help:

    hg help
    ...
     status       show changed files in the working directory

We go on to the command-line help:

    hg help status

    aliases: st

    show changed files in the working directory

        Show status of files in the repository. If names are given, only
        files that match are shown. Files that are clean or ignored or
        ....
        See also http://www.selenic.com/mercurial/wiki/index.cgi/Update

    options:
     ....

And there we reach a Wiki page with examples, other links etc.

    ...
    ..
   
    See also: http://hgbook.red-bean.com/hgbookch2.html#x6-520002.8.2

We might end up reaching the hg book. i.e. maximum zoom details before 
diving into the code itself ;-)
Or alternatively we could shortcut the wiki link and directly point from 
the command line help to the hgbook, for more detailed explanations?

-- Christian