Bug 874755

Summary: help message terminology for cli options that can be specified in multiplicity
Product: Red Hat Enterprise Linux 6 Reporter: John Sefler <jsefler>
Component: subscription-managerAssignee: Bryan Kearney <bkearney>
Status: CLOSED ERRATA QA Contact: IDM QE LIST <seceng-idm-qe-list>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 6.4CC: alikins, bkearney, mreid, skallesh
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: subscription-manager-1.1.7-1 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-02-21 09:00:02 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:    
Bug Blocks: 771481    

Description John Sefler 2012-11-08 19:00:37 UTC
Description of problem:
A few of the subscription-manager module command line options can be specified in multiplicity, but the online help messages are inconsistent and misleading:

[root@rhel-6 ~]# subscription-manager unsubscribe --help | grep -- --serial
  --serial=SERIALS      One or more Certificate serials to unsubscribe

[root@rhel-6 ~]# subscription-manager register --help | grep -A1 -- --activation
  --activationkey=ACTIVATION_KEYS
                        one or more activation keys to use for registration

[root@rhel-6 ~]# subscription-manager subscribe --help | grep -- --pool
  --pool=POOL           the id of the pool to subscribe to



I think these help descriptions would be would be more clear:

  --serial=SERIAL       certificate serial to unsubscribe (can be specified in
                        multiplicity to unsubscribe several serials)

  --activationkey=ACTIVATION_KEY
                        use to register with credentials to a pre-configured
                        set of subscriptions (can be specified in
                        multiplicity to register with several activation keys)

  --pool=POOL           the subscription pool id to subscribe to (can be
                        specified in multiplicity to subscribe to several pools)

Version-Release number of selected component (if applicable):
[root@rhel-6 ~]# rpm -q subscription-manager
subscription-manager-1.1.5-1.git.14.ae9fffd.el6.x86_64


Additional info:

Specifying an option in multiplicity means this...
  subscription-manager subscribe --pool=123 --pool=456 --pool=789

Comment 1 Matt Reid 2012-11-12 19:39:39 UTC
After discussing with BK and JSefler in irc, we'll use "(can be specified more than once)" to indicate that options can be input multiple times as part of the same command.

  --serial=SERIAL       certificate serial to remove (can be specified
                        more than once)

  --activationkey=ACTIVATION_KEY
                        use to register with credentials to a pre-configured
                        set of subscriptions (can be specified more than once)

  --pool=POOL           the id of the pool to attach (can be specified more than
                        once)

Comment 2 Adrian Likins 2012-11-12 19:53:34 UTC
commit bfefa9c25eb5f91d80c36c14f1b9803ba72f27a9
Author: Bryan Kearney <bkearney>
Date:   Mon Nov 12 14:19:15 2012 -0500

    874755: Be consistent in messaging when a command line option can be specified more than once

Comment 4 John Sefler 2012-11-15 19:12:01 UTC
[root@jsefler-6 ~]# rpm -q subscription-manager
subscription-manager-1.1.8-1.git.5.d79a09e.el6.x86_64


[root@jsefler-6 ~]# subscription-manager unsubscribe --help
Usage: subscription-manager unsubscribe [OPTIONS]

Deprecated, see remove

Options:
  -h, --help            show this help message and exit
  --proxy=PROXY_URL     proxy url in the form of proxy_hostname:proxy_port
  --proxyuser=PROXY_USER
                        user for http proxy with basic authentication
  --proxypassword=PROXY_PASSWORD
                        password for http proxy with basic authentication
  --serial=SERIALS      Certificate serial number to remove (can be specified
                        more than once)
  --all                 Remove all subscriptions from this system


EXPECTED:
  --serial=SERIALS  (DROP THE FINAL "S") see comment 1
  lowercase "Certificate serial..." to "certificate serial..." see bug 876356
  lowercase "Remove all..." to "remove all..." see bug 876356

Comment 5 John Sefler 2012-11-15 19:13:22 UTC
same fixes in comment 4 are needed in subscription-manager remove --help messages

Comment 7 Bryan Kearney 2012-11-16 15:59:43 UTC
fixed by various other string changes.

Comment 11 Adrian Likins 2012-11-19 15:20:47 UTC
commit 57fe6eb3a68006a89e24e1b96cc58f13fdcc266a
Author: Bryan Kearney <bkearney>
Date:   Mon Nov 19 10:01:02 2012 -0500

    874755: Change the text for import --certificate to be consistent with other options which can be specified more than on

Comment 13 Shwetha Kallesh 2012-12-10 06:16:15 UTC
Verified!!

[root@rhel-64-server ~]# subscription-manager version
server type: This system is currently not registered.
subscription management server: 0.7.21-1
subscription-manager: 1.1.11-1.el6
python-rhsm: 1.1.6-1.el6



[root@rhel-64-server ~]# subscription-manager subscribe --help | grep -- --pool
--pool=POOL           the id of the pool to attach (can be specified more
                        than once)


[root@rhel-64-server ~]# subscription-manager register --help | grep -A1 -- --activation
--activationkey=ACTIVATION_KEYS
                        activation key to use for registration (can be
                        specified more than once)


[root@rhel-64-server ~]# subscription-manager import --help | grep CERT -A2
  --certificate=CERTIFICATE_FILE
                        certificate file to import (can be specified more than
                        once)

[root@rhel-64-server ~]# subscription-manager unsubscribe --help
--serial=SERIAL       certificate serial number to remove (can be specified
                        more than once)

Comment 15 errata-xmlrpc 2013-02-21 09:00:02 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-2013-0350.html