Help issues

[Aaron Bentley]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

James Blackwell wrote:
> Sure, so long as when you get back to a prompt you can see the previous
> prompt. Thats important so that its clear that nothing has scrolled off
> the screen.


> I suspect we disagree on what signifies prominance.

Yes, I'm pretty certain we disagree here.

> If top-is-prominent, then we should consider moving the first three lines
> to the bottom: 
> ====
> Bazaar-NG -- a free distributed version-control tool
> http://bazaar-ng.org/

You may have a point.  They don't care about our egos.  Look at the CVS
help, for example.

It's good to know CVS is "a tool for version control" while bzr is "a
free distributed version-control tool". :-)

>>> bzr help [command]   - Get lengthy help for a specific command.
>>> bzr help commands    - Get list of all builtin commands.
>>>
>>> bzr help [plugin]    - Get help for a specific plugin.
>>> bzr help plugins     - Get list all all plugins.
>>
>>This is inaccurate.  Help lists all commands, not just builtins.  Or
>>were you planning to change that?
>>
>>This lists plugins, where bzrtools is one plugin.  Is this what you intend?
> 
> 
> I'm a bit of a purist in this department. I like to know what comes with
> standard, and what is bolted on. Thus I generally prefer the official list
> of commands is just official commands and that added on commands are list
> as added on.

Here's my thought: we need help sections.  Any given command can go in
multiple sections.  Each command should declare which sections it
belongs to.  (e.g. 'init' might go in the 'startup' and
'branch-manipulation' sections.)  Bzrtools commands will declare that
they go in the bzrtools section, but they will also declare other
sections as appropriate.  Single-command plugins won't declare sections,
because, e.g., it's pretty clear that the gannotate plugin adds the
gannotate command.

All commands will be listed in the general section by default, but
commands added by a plugin will be marked specially.  We can have
various filters.

> I was hellaconfused when I installed bzrtools plugin and couldn't figure
> out the new commands.

Actually, that bugs me too.  You would think I'd know which commands
were in my own package... :-)

Aaron
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)
Comment: Using GnuPG with Thunderbird - http://enigmail.mozdev.org

iD8DBQFD47bG0F+nu1YWqI0RAtw6AJ4jm/yvySVsD1wgmrk3Q1/Sd9cyRgCghVQ3
tMkmzM50KerWnW5XZI6Cw0o=
=V+oI
-----END PGP SIGNATURE-----