Project

General

Profile

Feature #24655

Include details about the required options in the help text

Added by Shira Maximov about 1 year ago. Updated about 1 year ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
Other commands
Target version:
-
Difficulty:
Triaged:
No
Bugzilla link:
Pull request:
Team Backlog:
Fixed in Releases:
Found in Releases:

Description

Cloned from https://bugzilla.redhat.com/show_bug.cgi?id=1360489

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.


Related issues

Related to Hammer CLI - Feature #21635: Extensible commands in hammerClosed

History

#1 Updated by Shira Maximov about 1 year ago

#2 Updated by Shira Maximov about 1 year ago

  • Subject changed from Include more detailed help text when invoking hammer commands with --help to Include details about the required options in the help text

Also available in: Atom PDF