[PATCH] show value requirement and multiple occurrence of option in online help

[FUJIWARA Katsunori]

Hi, Matt.

At Tue, 23 Jun 2009 15:30:05 -0500,
Matt Mackall wrote:

> > # HG changeset patch
> > # User FUJIWARA Katsunori <foozy at lares.dti.ne.jp>
> > # Date 1244298538 -32400
> > # Node ID 7a618bc09e4c61599cc8fcb98ac9f4c248e2c47e
> > # Parent  b5e9ed63913b2d953eb7f6fd704b5e356fa53642
> > show value requirement and multiple occurrence of option in online help
> > 
> > this helps users to know what kind of option is:
> 
> I like the idea of this patch, but I think we might want to tweak the
> output a bit. Bring this up again once 1.3 is released, please.

I listed suggestions from ML members up.

(1) My first proposal was:

    -f --force        force push
    -e --ssh VAL      specify ssh command to use
    -r --rev VAL ...  a specific revision up to which you would like to push


(2) Martin Geisler suggested:

    -f --force        force push
    -e --ssh VALUE    specify ssh command to use
    -r --rev VALUE... a specific revision up to which you would like to push

This suggesntion features:

  * remove space before "..."
  * use "VALUE" instead of "VAL"


(3) and John Coomes suggested:

    -R --repository VAL    repository root directory or symbolic path name
    -q --quiet             suppress output
    -v --verbose           enable additional output
       --config VAL        [+] set/override config option
    -I --include VAL       [+] include names matching the given patterns

or a variation:

    -R --repository VAL    repository root directory or symbolic path name
    -q --quiet             suppress output
    -v --verbose           enable additional output
       --config VAL [+]    set/override config option
    -I --include VAL [+]   include names matching the given patterns

with a one-line note shown below at the bottom of help message:

    [+] multiple occurrences of this option are additive

This suggestion features:

  * use "[+]" because "..." is ambiguous: 
      "-I a -I b -I c" and "-I a b c"


(4) so, my patch was:

    -f --force          force push
    -e --ssh VALUE      specify ssh command to use
    -r --rev VALUE [+]  a specific revision up to which you would like to push


Please comment about it !

====
FUJIWARA Katsunori(foozy at lares.dti.ne.jp/fujiwara at ascade.co.jp)