Insights from bzr newbie coming from git

[Wouter van Heyst]

On Thu, Nov 30, 2006 at 10:32:29AM -0600, John Arbash Meinel wrote:
> Wouter van Heyst wrote:
> > On Thu, Nov 30, 2006 at 09:06:34AM -0600, Matthew D. Fuller wrote:
> >> On Thu, Nov 30, 2006 at 05:01:29PM +0200 I heard the voice of
> >> Marius Kruger, and lo! it spake thus:
> >>> maybe add the following to all the commands taking revision
> >>> arguments: see also: `bzr help revisionspec`
> >> .From a glance at a few of the revspec-using commands, the help for -r
> >> seems to have no description already.  perhaps just adding a "See help
> >> revisionspec" desc for them would do the trick (saying 'bzr' seems
> >> redundant).
> > 
> > Doh, that is the obvious place to point at the revisionspec topic. Can't
> > believe I missed that!
> > 
> > Still, I'm not entirely satisfied with the attached patch, comments
> > welcome.
> > 
> > `bzr help merge` (and the rest) now sports:
> > 
> >   -r ARG, --revision=ARG
> >                         See the revisionspec help topic for a list of valid
> >                         arguments
> > 
> > Wouter van Heyst
> 
> 
> I think:
> 
>   -r ARG, --revision=ARG
>                         See 'help revisionspec' for details

I like this one, looks clear enough that people will do `bzr help
revisionspec` (and be flooded by the details). With merge, '-h, --help
show help message' is right below -r so that helps too. Branch has the
-h line _above_ -r, what's up with that?

Having this, it becomes really important to get the revisionspec help
just right, and currently I think it starts rather confusing. That -r#
works is not clear enough and gets mentioned too late. The
revno:3:/path/to/branch doesn't help either. 

New users looking for what they can specify should see the common case
first, backed up by relevant examples.

Wouter van Heyst
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 307 bytes
Desc: Digital signature
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20061130/668ee99a/attachment.pgp