Re: [Gnu-arch-users] "Newbie-ized help"

[Cameron Patrick]

James Blackwell wrote:

> > [...splitting help into categories...]

> If you're willing to write it, I'm willing to look at it. 
> 
> cmd-help.c is ready for a rewrite anyways. :) 

I've had a shot at doing this.  Comments welcome.  It's in the
address@hidden/tla--help--1.2 branch of my archive.

I'm about to go out so don't have time to say too much about it.
Output from various help commands is below...

Cameron.



$ ./tla help
usage: tla COMMAND [options ...]
tla is Tom Lord's Arch, a distributed revision control system.

  -h, --help, -H   Display a help message and exit.
  -V, --version    Display a release identifier string
                   and exit.

For a list of available commands, use `tla help CATEGORY', where CATEGORY
is one of:

     starting : Setting up arch for the first time
       common : Most commonly used arch commands
      merging : Commands for branching and merging
     archives : Creating, modifying and mirroring arch archives
    libraries : Configuring and manipulating revision libraries
          all : All tla sub-commands

$ ./tla help common
Most commonly used arch commands
--------------------------------


 * Starting a new project

  init-tree : initialize a new project tree
     import : archive a full-source base-0 revision


 * Checking out a project

        get : construct a project tree for a revision
     update : update a project tree to reflect recent archived changes


 * Making changes

     commit : archive a changeset-based revision
        add : add an explicit inventory id
         rm : remove a file (or dir, or symlink) and its explicit inventory tag 
(if any)
         mv : move a file (or dir, or symlink) and its explicit inventory tag 
(if any)
       undo : undo and save changes in a project tree
       redo : redo changes in project tree


 * Looking at a project tree

    changes : report about local changes in a project tree
  tree-lint : audit a source tree
       logs : list patch logs for a version in a project tree
  inventory : inventory a source tree

Use `tla help' to see the list of available help categories, tla command -h for
help on `command', or tla command -H for detailed help.