Red Hat Satellite engineering is moving the tracking of its product development work on Satellite to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "Satellite project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs will be migrated starting at the end of May. If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "Satellite project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/SAT-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 798675 - Some katello subcommands do not display the required options in the help screen
Summary: Some katello subcommands do not display the required options in the help screen
Keywords:
Status: CLOSED UPSTREAM
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Content Management
Version: 6.0.0
Hardware: x86_64
OS: Linux
unspecified
medium
Target Milestone: Unspecified
Assignee: Miroslav Suchý
QA Contact: Katello QA List
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-02-29 14:51 UTC by Forrest Taylor
Modified: 2019-09-26 13:31 UTC (History)
3 users (show)

Fixed In Version: katello-cli-1.2.2-1
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-09-19 18:09:55 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
Patch to add (required) to the required options in `katello repo enable -h` (1.09 KB, application/octet-stream)
2012-02-29 14:51 UTC, Forrest Taylor
no flags Details
patch of missing "(required)" descriptions (1.20 KB, application/octet-stream)
2012-03-26 12:10 UTC, Petr Chalupa
no flags Details

Description Forrest Taylor 2012-02-29 14:51:02 UTC
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`).

Comment 1 Petr Chalupa 2012-03-26 12:10:39 UTC
Created attachment 572745 [details]
patch of missing "(required)" descriptions

Comment 2 Petr Chalupa 2012-03-26 12:18:25 UTC
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?

Comment 3 Miroslav Suchý 2012-11-13 16:25:15 UTC
https://github.com/Katello/katello/pull/1054

Comment 4 Mike McCune 2013-09-19 18:09:55 UTC
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.


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