[RFC] disambiguating help topics.

[Robert Collins]

Currently 'bzr help' can have several things that qualify.

For example, if I add a command (perhaps from a plugin) called 'topics',
I can't get at the help for it.

I think we should do two things to address this. We should make sure
that everything that help can report on has a namespace of some sort
within which is must be unique. E.g. directly registered things cannot
be shadowed - they are fine. commands can be shadowed - they should be
also have help available at 'commands/command-name' (or perhaps 'command
command-name'). Help on plugins, which I am adding should be available
at 'help PLUGINNAME' but also 'help plugins/PLUGINNAME' (or 'help
plugins PLUGINNAME' perhaps). I personally prefer the / separator but am
happy with separate words too if someone has a stronger preference than
mine :).

Secondly, whever a requested help topic is ambiguous, 'bzr help THING'
should automatically add 'see also:' entries for the alternatives. Using
my example above:

$ bzr help topics
...
...
See also: commands/topics
...


Cheers,
Rob

-- 
GPG key available at: <http://www.robertcollins.net/keys.txt>.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20070419/24d3e54d/attachment.pgp