| Summary: | Some katello subcommands do not display the required options in the help screen | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Product: | Red Hat Satellite | Reporter: | Forrest Taylor <ftaylor> | ||||||
| Component: | Content Management | Assignee: | Miroslav Suchý <msuchy> | ||||||
| Status: | CLOSED UPSTREAM | QA Contact: | Katello QA List <katello-qa-list> | ||||||
| Severity: | medium | Docs Contact: | |||||||
| Priority: | unspecified | ||||||||
| Version: | 6.0.0 | CC: | mmccune, msuchy, pchalupa | ||||||
| Target Milestone: | Unspecified | Keywords: | Triaged | ||||||
| Target Release: | Unused | ||||||||
| Hardware: | x86_64 | ||||||||
| OS: | Linux | ||||||||
| Whiteboard: | |||||||||
| Fixed In Version: | katello-cli-1.2.2-1 | Doc Type: | Bug Fix | ||||||
| Doc Text: | Story Points: | --- | |||||||
| Clone Of: | Environment: | ||||||||
| Last Closed: | 2013-09-19 18:09:55 UTC | Type: | --- | ||||||
| Regression: | --- | Mount Type: | --- | ||||||
| Documentation: | --- | CRM: | |||||||
| Verified Versions: | Category: | --- | |||||||
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |||||||
| Cloudforms Team: | --- | Target Upstream Version: | |||||||
| Attachments: |
|
||||||||
Created attachment 572745 [details]
patch of missing "(required)" descriptions
It looks like that in case of `katello repo enable` and `katello package list` a repository can be specified by --id or by --name, --org, --product.
def check_options(self):
if not self.has_option('id'):
self.require_option('name')
self.require_option('org')
self.require_option('product')
I found 6 other similar cases.
How should these options be documented? And should it be documented?
These bugs have been resolved in upstream projects for a period of months so I'm mass-closing them as CLOSED:UPSTREAM. If this is a mistake feel free to re-open. |
Created attachment 566563 [details] Patch to add (required) to the required options in `katello repo enable -h` When running katello from the command-line, some subcommand help screens do not show the required options. For instance, `katello org create -h` shows: --name=NAME organization name eg: foo.example.com (required) The (required) at the end shows that --name is a required option. However, `katello repo enable -h` does not show any required options. For instance, --name is required, but it shows: --name=NAME repository name Each of the required options should be appended with (required). --name, --org and --product are all required for `katello repo enable`. I have included a patch to fix this issue. There are several other places where this needs to be addressed as well (e.g., `katello package list`).