Quick start and Usage docs

Faheem Mitha faheem at email.unc.edu
Thu May 11 14:14:14 CDT 2006


On Thu, 11 May 2006 14:54:04 -0400, Sébastien Pierre
<sebastien at xprima.com> wrote:

> Hi all,
>
> I just finished the draft version of the usage document, which is
> complementary to the quick start. You can get 100dpi PNG versions of
> both here :
>
> - Quick start: http://tinyurl.com/gvd5p
> - Usage      : http://tinyurl.com/pobq4
>
> As always, feedback welcome.

Looks good. Comments following apply to usage guide.

I think tip in your examples is the default, so not necessary. Eg. "hg
merge tip", "hg update tip" etc.

I'd make update and merge take arbitrary rev args, anyway. You don't
always want to update and merge with tip. You could mention somewhere
that the default to revision arguments is tip, as one would expect.

Also, you could mention that you only need to type enough letters in
the command to disambiguate it, so eg "hg up" will work instead of "hg
update".

                                                            Faheem.



More information about the Mercurial mailing list