[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: [PATCH] Fix descriptions on SYNOPSIS in manpages.

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: 2006-08-14 23:19:23 CEST

Kobayashi Noritada wrote:
> [[[
> Fix descriptions on SYNOPSIS in manpages.
> * subversion/svnadmin/svnadmin.1
> * subversion/svnlook/svnlook.1
> (SYNOPSIS): Delete "[args]" since it is described as "/path/to/repos".
> * subversion/svnsync/svnsync.1
> (SYNOPSIS): Delete "[args]" since it is described as "dest-url".

If the man-page needed to be fixed then the output of "svnsync --help" would
have needed to be fixed too, although it is slightly different:

            svnsync command dest-url [options] [args]

     $ svnsync --help
     general usage: svnsync SUBCOMMAND DEST_URL [ARGS & OPTIONS ...]

But [args] is used for some subcommands:

     $ svnsync --help init
     initialize (init): usage: svnsync initialize DEST_URL SOURCE_URL

So [args] represents SOURCE_URL for that subcommand.

Similarly for "svnadmin" and "svnlook", [args] is needed.

> * subversion/svndumpfilter/svndumpfilter.1
> (SYNOPSIS): Clarify "[args]" as "prefixes".

> .TP
> -\fBsvndumpfilter\fP \fIcommand\fP [\fIoptions\fP & \fIargs\fP]
> +\fBsvndumpfilter\fP \fIcommand\fP \fIprefixes\fP [\fIargs\fP]

Here your patch changes the wrong part of the help. The clarification you
intended to make is sort of OK - the [args] must be prefixes for the only two
subcommands that are currently defined ("include" and "exclude") except for
"help" - but it doesn't seem to me that it is really useful to change it here.
  (And, like the programs above, if you change the man page in this way you
ought to change the "svndumpfilter --help" text as well.)

So I don't think we should change any of this.

- Julian

To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Mon Aug 14 23:18:47 2006

This is an archived mail posted to the Subversion Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.