Bug 1034771

Summary: [ovirt-hosted-engine-setup] hosted-engine $command --help or teach --help to show all options
Product: Red Hat Enterprise Virtualization Manager Reporter: Jiri Belka <jbelka>
Component: ovirt-hosted-engine-setupAssignee: Adam Litke <alitke>
Status: CLOSED ERRATA QA Contact: movciari
Severity: medium Docs Contact:
Priority: unspecified    
Version: 3.3.0CC: alitke, dfediuck, didi, iheim, oschreib, pstehlik, sbonazzo, scohen
Target Milestone: ---Keywords: EasyFix, Triaged
Target Release: 3.3.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: integration
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2014-01-21 16:55:36 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On: 1038626, 1046019    
Bug Blocks:    

Description Jiri Belka 2013-11-26 13:35:00 UTC
Description of problem:
hosted-engine $command --help or teach --help to show all options.

# hosted-engine --deploy --help
Usage: /usr/share/ovirt-hosted-engine-setup/scripts/ovirt-hosted-engine-setup
        --config-append=file
                Load extra configuration files.
        --generate-answer=file
                Generate answer file.

is bizzare syntax. no sane command line application uses such syntax, especially comment is... how would one know it should be written like this?

* '--deploy' is an option

So either teach --help to show all possible option and inform user that it is a kind of "suboption" of another option (lol), or better change "commands" into command syntax like git does it.

* git --help commit ...or... git commit --help

thus

* hosted-engine --help ...or... hosted-engine deploy --help / hosted-engine --help deploy


Version-Release number of selected component (if applicable):
is24.2

How reproducible:
100%

Steps to Reproduce:
1. how would you know there's "config-append" option for hosted-engine (??) [no source reading please!]
2.
3.

Actual results:
--help hides all options and/or --help usage/hosted-engine's options are syntactically bizzare

Expected results:
sane style

Additional info:

Comment 1 Adam Litke 2013-12-05 14:55:28 UTC
patch merged on master branch: 02c0cf0961076d1416829dcb1ef600a72a90192b

Comment 2 Sandro Bonazzola 2013-12-06 12:35:34 UTC
patch merged also on 1.0 branch.
proposing as blocker for inclusion in 3.3.0.

Comment 3 Adam Litke 2013-12-06 13:10:48 UTC
Merged upstream as 02c0cf0961076d1416829dcb1ef600a72a90192b

Comment 5 Sandro Bonazzola 2013-12-23 08:39:42 UTC
*** Bug 1046019 has been marked as a duplicate of this bug. ***

Comment 6 errata-xmlrpc 2014-01-21 16:55:36 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

http://rhn.redhat.com/errata/RHBA-2014-0083.html