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

Re: Emphasizing commonly-used commands in 'svn help' output.

From: Jonathan Gilbert <o2w9gs702_at_sneakemail.com>
Date: 2005-07-11 23:26:50 CEST

At 12:26 PM 11/07/2005 -0500, Karl Fogel wrote:
>By default, 'svn help' would only show the commonly-used commands that
>a new user would be most likely to want to see in help output. It
>would end with instructions to use 'svn help -v' to see the full list
>of commands.

Perhaps it would also be beneficial to organize the subcommands by into
categories. To amortize the additional lines for the section headings,
multiple columns could be used. It shouldn't be hard to get main.c to
display the commands in this manner. A new field could be used to indicate
which category a command is in, and then they could be either maintained in
order, sorted by section, or main.c could simply brute-force the sort (a
selection sort :-) when it needs to do it. The number of commands may be
large, but it isn't so large that such a sort would take noticeable time ;-)

Something like this:

   $ svn help
   usage: svn <subcommand> [options] [args]
   Subversion command-line client, version 1.3.0-dev.
   Type 'svn help <subcommand>' for help on a specific subcommand.
   
   Most subcommands take file and/or directory arguments, recursing
   on the directories. If no arguments are supplied to such a
   command, it recurses on the current directory (inclusive) by default.
   
   The most commonly-used subcommands are:
      Getting files from the repository:
        checkout (co) takeover (to) revert
        update (up)
      Sending files to the repository:
        add commit import
      Managing files in the repository:
        copy (cp) delete (del, remove, rm)
        mkdir move (mv, rename, ren)
      Comparing files with the repository:
        diff (di) log merge
        status (stat, st)
      Working with properties:
        propdel (pdel, pd) propedit (pedit, pe)
        propget (pget, pg) proplist (plist, pl)
        propset (pset, ps)
   
   For a complete list of subcommands, run 'svn help -v'.

   Subversion is a tool for version control.
   For additional information, see http://subversion.tigris.org/
   $

Since the main thrust is to list the commands a new user would be
interested in, I think organizing them like this would be beneficial,
rather than just dumping them all mixed together in alphabetical order.

Jonathan Gilbert

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Mon Jul 11 23:26:35 2005

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