bzr <cmd> help -- Synopsis syntax should follow de facto conventions

Martin Pool mbp at canonical.com
Fri Sep 22 02:14:36 BST 2006


On 21 Sep 2006, John Arbash Meinel <john at arbash-meinel.com> wrote:
> Daniel Silverstone wrote:
> 
> ...
> 
> > In normal manpage parlance:
> > 
> > usage: bzr checkout [BRANCH_LOCATION [TO_LOCATION]]
> > 
> > D.
> > 
> 
> Well, all of our optional parameters are this way. As in they are still
> 100% positional, and I don't know of any core commands that change
> position meaning. (I believe at one time I wrote a plugin that did, but
> I didn't really like it).

I think they are all filled from left to write.  In a sense the current
display is unambiguous, but showing nested braces is probably clearer.

> So we could rewrite the help generator to always use nested braces. I'm
> not sure if that helps a lot, but we can discuss it a bit.

I think that would be good.

-- 
Martin




More information about the bazaar mailing list