Bug 878097 - option description for --org needs clarification
Summary: option description for --org needs clarification
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 5
Classification: Red Hat
Component: subscription-manager
Version: 5.10
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: beta
: 5.10
Assignee: Bryan Kearney
QA Contact: IDM QE LIST
URL:
Whiteboard:
Depends On:
Blocks: rhsm-rhel510 rhsm-2013
TreeView+ depends on / blocked
 
Reported: 2012-11-19 16:28 UTC by John Sefler
Modified: 2013-09-30 22:51 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
No description necessary
Clone Of:
Environment:
Last Closed: 2013-09-30 22:51:08 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2013:1332 0 normal SHIPPED_LIVE subscription-manager bug fix and enhancement update 2013-09-30 22:49:24 UTC

Description John Sefler 2012-11-19 16:28:39 UTC
Description of problem:

Observe the confusion...

[root@jsefler-6 ~]# subscription-manager orgs --username testuser1 --password password
+-------------------------------------------+
          testuser1 Organizations
+-------------------------------------------+

Name: 	Admin Owner
Key: 	admin

Name: 	Snow White
Key: 	snowwhite

[root@jsefler-6 ~]# subscription-manager register --help | grep ORG
  --org=ORG             register to one of multiple organizations for the user

[root@jsefler-6 ~]# subscription-manager register --username testuser1 --password password --org "Admin Owner"
Organization Admin Owner does not exist.
                         ^^^^^^^^^^^^^^ WHAT? It exists in the report above!

[root@jsefler-6 ~]# subscription-manager register --username testuser1 --password password --org "admin"
The system has been registered with id: 573db0e1-b8c3-47aa-a71c-a625f249dbb2 

^^^ Ah! The description for --org should clarify that the org *key* should be specified.


Version-Release number of selected component (if applicable):
[root@jsefler-6 ~]# rpm -q subscription-manager
subscription-manager-1.1.9-1.el6.x86_64


How reproducible:


Steps to Reproduce:
[root@jsefler-6 ~]# subscription-manager register --help | grep ORG
  
Actual results:
  --org=ORG             register to one of multiple organizations for the user


Expected results:
  --org=ORG_KEY         register to one of multiple organizations for the user
                        by specifying the organization key
        ^^^^^^^ AND/OR  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        Would like agreement from mreid on this description

Comment 1 John Sefler 2012-11-19 16:33:54 UTC
Also affects...
[root@jsefler-6 ~]# subscription-manager environments --help | grep ORG
  --org=ORG             specify organization for environment list

but may be blocked by https://bugzilla.redhat.com/show_bug.cgi?id=875153#c2

Comment 2 Bryan Kearney 2012-11-26 20:45:31 UTC
Past string freeze, pushing.

Comment 3 Matt Reid 2012-12-07 21:41:17 UTC
How about:

[root@jsefler-6 ~]# subscription-manager environments --help | grep ORG
--org=ORG_NAME        specify organization for environment list, using
                      organization name

[root@jsefler-6 ~]# subscription-manager register --help | grep ORG
--org=ORG_KEY         register to one of multiple organizations for the user,
                      using organization key

keeps things a little shorter by avoiding "by" and "using" over "specifying" saves a few characters as well.

Thoughts?

Comment 5 Bryan Kearney 2013-02-11 16:32:49 UTC
commit 017dae417368a2002b2b90fcc26773fd8736c654
Author: Bryan Kearney <bkearney>
Date:   Fri Jan 25 16:05:15 2013 -0500

    878097: Clarify that the --org option is ORG_KEY and not ORG_NAME

Comment 6 John Sefler 2013-02-12 19:09:46 UTC
Testing version...
[root@jsefler-7 ~]# rpm -q subscription-manager
subscription-manager-1.8.2-1.git.13.3fdfb73.el7.x86_64

[root@jsefler-7 ~]# subscription-manager register --help | grep ORG -A1
  --org=ORG_KEY         register to one of multiple organizations for the
                        user, using organization key
[root@jsefler-7 ~]# subscription-manager environments --help | grep ORG -A1
  --org=ORG_KEY         specify organization for environment list, using
                        organization key
[root@jsefler-7 ~]# subscription-manager service-level --help | grep ORG
  --org=ORG_KEY         specify org for service level list
[root@jsefler-7 ~]# 

For the sake of consistency, please update the org description under service-level to be...
[root@jsefler-7 ~]# subscription-manager service-level --help | grep ORG
  --org=ORG_KEY         specify organization when listing available service
                        levels, using organization key

Comment 8 Bryan Kearney 2013-03-01 22:26:35 UTC
commit a1a0ba588323a07e3355fe7b6cab82e8a4581b72
Author: Adrian Likins <alikins>
Date:   Fri Mar 1 10:21:35 2013 -0500

    878097: update service-level org key help text

Comment 9 Sharath Dwaral 2013-03-11 19:12:31 UTC
# rpm -qa | egrep "subscription-manager|python-rhsm"
subscription-manager-firstboot-1.8.4-1.el7.x86_64
python-rhsm-1.8.7-1.el7.x86_64
subscription-manager-gui-1.8.4-1.el7.x86_64
subscription-manager-migration-1.8.4-1.el7.x86_64
subscription-manager-1.8.4-1.el7.x86_64
subscription-manager-debuginfo-1.8.4-1.el7.x86_64

# subscription-manager register --help | grep ORG
  --org=ORG_KEY         register to one of multiple organizations for the
# subscription-manager environments --help | grep ORG
  --org=ORG_KEY         specify organization for environment list, using
# subscription-manager service-level --help | grep ORG
  --org=ORG_KEY         specify an organization when listing available service

VERIFIED

Comment 10 RHEL Program Management 2013-04-09 20:53:59 UTC
This request was evaluated by Red Hat Product Management for inclusion
in a Red Hat Enterprise Linux release.  Product Management has
requested further review of this request by Red Hat Engineering, for
potential inclusion in a Red Hat Enterprise Linux release for currently
deployed products.  This request is not yet committed for inclusion in
a release.

Comment 12 errata-xmlrpc 2013-09-30 22:51:08 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-1332.html


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