lxc manpage is incomplete
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
lxd |
Fix Released
|
Unknown
|
|||
lxd (Ubuntu) |
Fix Released
|
Wishlist
|
Unassigned |
Bug Description
Using lxd 0.20-0ubuntu4.1 on Wily.
The lxc manpage only gives me the top level commands. They give me no discoverability - I have to interactively probe the usage lines for subcommands individually. This makes the manpage pretty much useless, as I have to do the interactive probing either way.
Lack of discoverability using the probing method means that I need to type a bunch of commands in order to walk the tree of subcommand help files, instead of just reading through a manpage. If I don't walk the entire tree, I will miss what I need. For example, I tried "lxc file -h" to try and found out how to add a bind mount, not realising that it should be under "lxc config -h" instead. I had to google; instead I expect to be able to find out how to get it to do what I want through the manpages only.
git's manpages are a very good example of how to do this well, IMHO, in particular with its many subcommands.
Expected result: I can discover all functionality (or certainly all major functionality) through manpages alone.
Changed in lxd: | |
status: | Unknown → Fix Released |
Patches are welcome. We're using help2man to generate our manpages because maintaining them by hand is too much of a pain.