Bug 1360489 - [RFE] Include more detailed help text when invoking hammer commands with --help
Summary: [RFE] Include more detailed help text when invoking hammer commands with --help
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat Satellite 6
Classification: Red Hat
Component: Hammer
Version: 6.1.9
Hardware: Unspecified
OS: Unspecified
medium
medium vote
Target Milestone: Unspecified
Assignee: satellite6-bugs
QA Contact: Katello QA List
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-07-26 22:49 UTC by Craig Donnelly
Modified: 2019-11-14 08:48 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-09-04 19:13:53 UTC
Target Upstream Version:


Attachments (Terms of Use)


Links
System ID Priority Status Summary Last Updated
Foreman Issue Tracker 24655 'Normal' 'New' 'Include details about the required options in the help text ' 2019-12-06 15:58:58 UTC

Description Craig Donnelly 2016-07-26 22:49:36 UTC
Description of problem:
Currently, there are many commands in hammer cli that return extremely generic help messages which do not actually help, or do not specify required options of a given command

Version-Release number of selected component (if applicable):
6.1.9

How reproducible:
100%

Steps to Reproduce:
One example would be:

hammer> content-view create
Could not create the content view:
  Error: Could not find organization, please set one of options --organization, --organization-label, --organization-id.
hammer> content-view create -h
Usage:
     content-view create [OPTIONS]

Options:
 --component-ids COMPONENT_IDS           List of component content view version ids for composite views
                                         Comma separated list of values.
 --composite                             Create a composite content view
 --description DESCRIPTION               Description for the content view
 --label LABEL                           Content view label
 --name NAME                             Name of the content view
 --organization ORGANIZATION_NAME        Organization name to search by
 --organization-id ORGANIZATION_ID       organization ID
 --organization-label ORGANIZATION_LABEL Organization label to search by
 --repositories REPOSITORY_NAMES         Comma separated list of values.
 --repository-ids REPOSITORY_IDS         repository ID
                                         Comma separated list of values.
 -h, --help                              print help
hammer> 

--organization, --organization-label, --organization-id should have descriptions that let the user know they are required to use the command.

--repositories should let us know that (truly) we need this to have a real, functional content-view.

The same situation applies to --composite and its relationship to --component-ids.

We basically need an overview of all help texts for hammer cli, or we need to link detailed documentation in this help output if we are going to choose to be blatantly non-specific.

Comment 1 Shira Maximov 2018-08-19 11:44:31 UTC
Created redmine issue https://projects.theforeman.org/issues/24655 from this bug

Comment 2 Bryan Kearney 2018-09-04 19:01:26 UTC
Thank you for your interest in Satellite 6. We have evaluated this request, and we do not expect this to be implemented in the product in the foreseeable future. We are therefore closing this out as WONTFIX. If you have any concerns about this, please feel free to contact Rich Jerrido or Bryan Kearney. Thank you.

Comment 3 Bryan Kearney 2018-09-04 19:13:53 UTC
Thank you for your interest in Satellite 6. We have evaluated this request, and we do not expect this to be implemented in the product in the foreseeable future. We are therefore closing this out as WONTFIX. If you have any concerns about this, please feel free to contact Rich Jerrido or Bryan Kearney. Thank you.


Note You need to log in before you can comment on or make changes to this bug.