Bug 635975
| Summary: | help for wallaby utility | ||
|---|---|---|---|
| Product: | Red Hat Enterprise MRG | Reporter: | Lubos Trilety <ltrilety> |
| Component: | wallaby-utils | Assignee: | Will Benton <willb> |
| Status: | CLOSED DUPLICATE | QA Contact: | Petr Matousek <pematous> |
| Severity: | medium | Docs Contact: | |
| Priority: | low | ||
| Version: | 1.3 | CC: | matt, pematous |
| Target Milestone: | 1.3.2 | ||
| Target Release: | --- | ||
| Hardware: | All | ||
| OS: | Linux | ||
| Whiteboard: | |||
| Fixed In Version: | 0.9.21-1 | Doc Type: | Bug Fix |
| Doc Text: |
C: The "wallaby" command itself did not have on-line help; furthermore, on-line help for subcommands required a broker connection.
C: This is confusing for users, who expect command-line tools to be self-documenting.
F: These cases are now handled generally as a result of internal improvements to the wallaby shell.
R: These commands are now self-documenting and do not require a broker connection. Furthermore, "wallaby help commands" provides a brief summary of each available subcommand.
|
Story Points: | --- |
| Clone Of: | Environment: | ||
| Last Closed: | 2011-01-11 16:52:11 UTC | Type: | --- |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
This is fixed as part of the new wallaby-shell-command API and will be packaged in 0.9.21.
Technical note added. If any revisions are required, please edit the "Technical Notes" field
accordingly. All revisions will be proofread by the Engineering Content Services team.
New Contents:
C: The "wallaby" command itself did not have on-line help; furthermore, on-line help for subcommands required a broker connection.
C: This is confusing for users, who expect command-line tools to be self-documenting.
F: These cases are now handled generally as a result of internal improvements to the wallaby shell.
R: These commands are now self-documenting and do not require a broker connection. Furthermore, "wallaby help commands" provides a brief summary of each available subcommand.
The wallaby utility still prints the error message when there is no command and '-h' option is used. No error message should appear. Return code of the "wallaby -h" command is equal to 1. The return code should be equal to 0. Version-Release number of selected component: wallaby-utils-0.10.0-2.el5 ASSIGNED *** This bug has been marked as a duplicate of bug 668799 *** |
Description of problem: Help for some of the wallaby utility commands contains short description (e.g. 'wallaby inventory -h'), for others there is no such description (e.g. 'wallaby make-snapshot -h'). Unification of all these help messages will be really appreciated. Moreover list of available commands is badly placed in error message (fatal: ...) instead of help/usage. Version-Release number of selected component (if applicable): wallaby-utils-0.9.18-2.el5 How reproducible: 100% Steps to Reproduce: 1. run 'wallaby -h' # wallaby -h fatal: you must specify a command (list-snapshots, load-snapshot, console, add-param, feature-import, make-snapshot, apropos, activate, modify-param, dump, load, inventory) Usage: wallaby [options] command [command-args] -h, --help shows this message -H, --host HOSTNAME qpid broker host (default localhost) -p, --port NUM qpid broker port (default 5672) -U, --user NAME qpid username -P, --password PASS qpid password -M, --auth-mechanism PASS authentication mechanism (ANONYMOUS, PLAIN, GSSAPI) 2. run 'wallaby make-snapshot -h' and 'wallaby inventory -h' # wallaby make-snapshot -h Console Connection Established... Usage: wallaby make-snapshot SNAPSHOT-NAME -h, --help displays this message # wallaby inventory -h Console Connection Established... Usage: wallaby inventory [options] Inventory of nodes that are managed by wallaby. -h, --help displays this message -s, --sort KEY sort by key (name, checkin) -a, --all show all nodes (default) -o, --only KIND show only KIND nodes (provisioned, unprovisioned) Actual results: 1. wallaby utility prints error message fatal: you must specify a command (list-snapshots, load-snapshot, console, add-param, feature-import, make-snapshot, apropos, activate, modify-param, dump, load, inventory) 2. first help message contains usage and list of possible options, second help contains a short description about given command on top of that Expected results: 1. the wallaby utility doesn't print error message when there is no command and '-h' option is used it will be better if the list of commands will be part of help/usage not part of error message 2. both helps contain short description about given command Additional info: