After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 698237 - [enh] nmcli help improvements: add "help" for second level commands
[enh] nmcli help improvements: add "help" for second level commands
Status: RESOLVED FIXED
Product: NetworkManager
Classification: Platform
Component: nmcli
git master
Other Linux
: Normal normal
: ---
Assigned To: NetworkManager maintainer(s)
NetworkManager maintainer(s)
Depends on:
Blocks: tracker-nmcli
 
 
Reported: 2013-04-17 20:09 UTC by Dan Winship
Modified: 2014-01-09 09:27 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Dan Winship 2013-04-17 20:09:55 UTC
"nmcli con help" prints out a LOT of stuff. It would be better if the "connectin add" (TYPO ALERT) options weren't listed by default. It could just say "type 'nmcli connection add help' to see the full list of options for each connection type."

Related to that, it seems weird to me that "nmcli dev wifi help" doesn't work.
Comment 1 Pavel Simerda 2013-04-23 14:38:14 UTC
Minor doc issue: In 'cli-enhance', the help has been moved to 'nmcli connection add help' but 'nmcli connection help' doesn't suggest that.
Comment 2 Jiri Klimes 2013-04-24 08:41:08 UTC
We used to have help for main commands only (because there were not many subcommand/arguments).

'nmcli connection add' have a lot of arguments. So now we have
'nmcli connection add help' per https://bugzilla.redhat.com/show_bug.cgi?id=953459

We could add "nmcli dev wifi help" too, if there's a consensus that it is useful.
In any case, 'device wifi' description is available in common 'device' description.
Comment 3 Dan Winship 2013-05-02 15:59:39 UTC
NM bugzilla reorganization... sorry for the bug spam.
Comment 4 Jiri Klimes 2013-11-25 09:44:52 UTC
It appears that "help" for the second level commands is useful. So we would add:
nmcli general logging help
nmcli connection up help
nmcli device disconnect help
...

in addition to already implemented first level command help:
nmcli general help
nmcli connection help
nmcli radio help
Comment 5 Jiri Klimes 2014-01-07 13:16:55 UTC
"help" for second level commands is available for review in jk/bgo698237-nmcli-help branch.
Comment 6 Dan Williams 2014-01-08 15:51:42 UTC
usage_connection_show(): detailes -> details

usage_device_wimax(): "List available WiMAX NSP." -> "List available WiMAX NSPs."

usage_general_hostname(): I would simplify the second sentence to "When you pass a hostname, NetworkManager will set it as the new persistent system hostname."

The rest looks good.
Comment 7 Jiri Klimes 2014-01-09 09:27:02 UTC
e44bb5e cli: add 'help' for second level commands (bgo #698237) (rh #1034119)