[RFC] Concise vs comprehensive help - do we need both?

Marius Gedminas marius at pov.lt
Sat Jan 31 19:25:02 GMT 2009


On Sat, Jan 31, 2009 at 07:04:51PM +1100, Ben Finney wrote:
> Ian Clatworthy <ian.clatworthy at internode.on.net> writes:
> 
> > I'd be just as happy not adding -? and making -h be concise help
> > while "bzr help xxx" gave the full story. Would that be better?
> 
> I would expect ‘-h’ and ‘--help’ to be synonymous, and to default to
> concise help.
> 
> Multi-page verbosity should not be something associated with a
> commonly-used option like ‘--help’, but rather something that
> indicates it's verbose, such as ‘--help --verbose’ or ‘--help --long’.

This makes most sense to me, especially if the short help page mentions
the existence of the long one.

  $ bzr help merge
  Purpose: ...
  Usage: ...
  Options:
    ...

  See bzr help -v merge for more details and examples.

Marius Gedminas
-- 
Some people around here wouldn't recognize
subtlety if it hit them on the head.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20090131/a2be40f2/attachment.pgp 


More information about the bazaar mailing list