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

[John Arbash Meinel]

Jari Aalto wrote:
> Please take a moment to review all help texts to next release. Take
> for an example:
> 
>     $ bzr help checkout
>     usage: bzr checkout [BRANCH_LOCATION] [TO_LOCATION]
>     aliases: co
> 
>     Create a new checkout of an existing branch.
> 
>     If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
>     the branch found in '.'. This is useful if you have removed the working tree
>     or if it was never created - i.e. if you pushed the branch to its current
>     location using SFTP.
> 
> While the text explains it, the Synopsis reads:
> 
>     usage: bzr checkout [BRANCH_LOCATION] [TO_LOCATION]
> 
> which would suggest that both parameters are optional. In Unix manul
> page parlance (de facto) it is customary to use syntax:


Both parameters *are* optional. If you go into a directory which has a
Branch but no working tree, typing 'bzr checkout' will create a working
tree.

The formats for 'bzr checkout [BRANCH_LOCATION] [TO_LOCATION]' is
actually created by the argument parsing logic, which does know what
arguments are optional, and what arguments are required.

John
=:->

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 254 bytes
Desc: OpenPGP digital signature
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20060920/16ff9a6a/attachment.pgp