#410 SUDO shows up as multiple top level help items
Closed: Fixed None Opened 13 years ago by admiyo.

ipa help
Usage: ipa [global-options] COMMAND ...
...
service Services
sudocmd Sudo Commands
sudocmdgroup Groups of sudo commands
sudorule Sudo Rule
taskgroup Taskgroups
user Users

This should be a single line itme for sudo, with the others showing up from

ipa help sudo.


Each plugin is a topic, that is why it appears this way.

The problem right now is we have no way of doing any sort of association from one plugin to another one via a high-level topic.

One thing we might do is include in each file (or perhaps the top-level class) a "topic" that gets registered in the plugin system. This is then used to generate the list of topics for: ipa help topics
In addition there may be a need to get the list of commands for a given topic. For most this would not be particularly helpful (user for example) but for a topic like sudo or hbac each with 3 separate plugins supporting it this would probably be very useful.

So it might look like:

$ ipa help topics
  user Users
  group Groups
  hbac Host-based Access Control
  sudo SUDO

$ ipa help sudo
  <some block of text, from where I'm not sure>
  Related sub-topics
  sudorule
  sudocmd
  sudocmdgroup

Perhaps even display the sub-topics:

$ ipa help topics
  user Users
  group Groups
  hbac Host-based Access Control
    hbac          Host-based access control
    hbacsvc       HBAC Services
    hbacsvcgroup  HBAC Service Groups
  sudo SUDO
    sudocmd       Sudo Commands
    sudocmdgroup  Groups of sudo commands
    sudorule      Sudo Rule

This is just off the top of my head, use your imagination :-)

Fixed in following commits:

HBAC module renaming (required for correct behavior): bfc338d

Changed help: 6214af8

Initial module grouping: b6eada0

Metadata Update from @admiyo:
- Issue assigned to jzeleny
- Issue set to the milestone: FreeIPA 2.0 - 2011/01 (cleanup)

7 years ago

Login to comment on this ticket.

Metadata