[PATCH] Improve visibility of "--version" option

[Julian Foad <ju...@btopenworld.com>]

A few users have commented that they haven't been able to discover the 
"--version" option.  This patch lists it in the main "help" output, where it 
should be.

I added a line under "usage" in each of five "svn*" programs.  (The other two 
already list all their option switches.)  In four cases "--version" outputs a 
list of FS or RA modules and I added another line mentioning that.

I considered using the option-description line generated from the option table, 
but it doesn't fit well into the style of this help display.  I also considered 
other changes to the help, such as mentioning "--help" in a similar way to 
"--version", but decided to keep to the one purpose.

Any comments on the patch before I commit it?

Basically the change looks something like this:

OLD:
> $ svn help help
> help (?, h): Describe the usage of this program or its subcommands.
> usage: help [SUBCOMMAND...]
> 
> Valid options:
>   --version                : print client version info
>   -q [--quiet]             : print as little as possible
>   --config-dir arg         : read user configuration files from directory ARG

NEW:
> $ svn help
> usage: svn <subcommand> [options] [args]
>        svn --version [--quiet]
> Subversion command-line client, version 1.5.0-dev.
> Type 'svn help <subcommand>' for help on a specific subcommand.
> Type 'svn --version' to see the program version and RA modules.
> 
> Most subcommands take file and/or directory arguments, recursing
[...]


- Julian

Re: [PATCH] Improve visibility of "--version" option

[Julian Foad <ju...@btopenworld.com>]

Garrett Rooney wrote:
> In concept this seems fine to me, and the code seems ok, although I
> haven't actually tested it.  Making the option more visible makes a
> lot of sense to me.

Thanks.  It failed the "getopt" tests that want the help output to stay exactly 
the same, but I changed the text there to match, and removed the test for "svn 
help --version" because there's no good reason to support it.  (I suppose 
somebody will be relying on it, but ... tough luck. :-) )

Committed in r20301.

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Re: [PATCH] Improve visibility of "--version" option

[Garrett Rooney <ro...@electricjellyfish.net>]

On 6/26/06, Julian Foad <ju...@btopenworld.com> wrote:
> A few users have commented that they haven't been able to discover the
> "--version" option.  This patch lists it in the main "help" output, where it
> should be.
>
> I added a line under "usage" in each of five "svn*" programs.  (The other two
> already list all their option switches.)  In four cases "--version" outputs a
> list of FS or RA modules and I added another line mentioning that.
>
> I considered using the option-description line generated from the option table,
> but it doesn't fit well into the style of this help display.  I also considered
> other changes to the help, such as mentioning "--help" in a similar way to
> "--version", but decided to keep to the one purpose.
>
> Any comments on the patch before I commit it?

In concept this seems fine to me, and the code seems ok, although I
haven't actually tested it.  Making the option more visible makes a
lot of sense to me.

-garrett

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org