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

Re: On the size of the command set

From: Benjamin Pflugmann <benjamin-svn-dev_at_pflugmann.de>
Date: 2004-10-02 15:50:41 CEST

On Sat 2004-09-25 at 07:58:55 +0100, Max Bowsher wrote:
> Perhaps we should think about categorizing our svn help output, to help
> maintain it's readability as we increase the number of commands?

Since I pondered about this independently, I thought I'd make a start.
The excerpt below is the the output of "svn help" (from the 1.0.1
client, but the help output shouldn't have changed too much) with some
grouping added by me. The names of the groups IMHO suck, so please pay
more intention to the grouping itself. Whether you think the groups
themselves resp. the items assigned to them make sense.

Note, that one could easily get rid of the "Mass operations" and/or
"Working-copy maintenance" groups by putting them into the "misc"
group, if they are not worth their own group.

We could add a redundant "most used"/"basics" group at the start,
which would contain something like: add, commit, diff, help, update,
log, status.

I'd also add a (very) short description to the commands (regardless of
grouped or sorted output).

Ah, and if we decide to put the help into groups, we should consider
if we want to add a "--sorted" switch to get the current, sorted
output. Indeed, we may want to give the new output only when
"--grouped" (sp?) is added, depending on compatibility rules: Though I
doubt that some other tool depends on the command line help output,
it's not unthinkable, especially if it just get passed through to a

And now to the subject of discussion:

usage: svn <subcommand> [options] [args]
Type "svn help <subcommand>" for help on a specific subcommand.
Subversion is a tool for version control.
Most subcommands take file and/or directory arguments, recursing
on the directories. If no arguments are supplied to such a
command, it will recurse on the current directory (inclusive) by
Available subcommands:

   copy (cp)
   delete (del, remove, rm)
   move (mv, rename, ren)

   commit (ci)
   update (up)

   blame (praise, annotate, ann)
   diff (di)
   list (ls)
   status (stat, st)

Mass operations:
   checkout (co)

Working-copy maintenance:
   switch (sw)

Handling Properties:
   propdel (pdel, pd)
   propedit (pedit, pe)
   propget (pget, pg)
   proplist (plist, pl)
   propset (pset, ps)

   help (?, h)
For additional information, see http://subversion.tigris.org/



To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Sat Oct 2 15:50:57 2004

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.