Bug 771756 - rhsm-icon --help usage message is misleading
Summary: rhsm-icon --help usage message is misleading
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 5
Classification: Red Hat
Component: subscription-manager
Version: 5.8
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: rc
: ---
Assignee: Bryan Kearney
QA Contact: Entitlement Bugs
URL:
Whiteboard:
Depends On:
Blocks: 771748 807971
TreeView+ depends on / blocked
 
Reported: 2012-01-04 20:50 UTC by John Sefler
Modified: 2013-01-10 10:59 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-01-08 03:47:58 UTC
Target Upstream Version:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2013:0033 0 normal SHIPPED_LIVE subscription-manager bug fix and enhancement update 2013-01-08 08:38:27 UTC

Description John Sefler 2012-01-04 20:50:38 UTC
Description of problem:
The rhsm-icon --help "Usage" statement is misleading

Version-Release number of selected component (if applicable):
[root@jsefler-onprem-5server ~]# rpm -q subscription-manager-gnome
subscription-manager-gnome-0.98.10-1.git.0.5d83904.el5


How reproducible:


Steps to Reproduce:
[root@jsefler-onprem-5server ~]# rhsm-icon --help | grep -i usage -A1
Usage:
  rhsm-icon [OPTION...] rhsm icon
                   ^^^  ^^^^ ^^^^
                   DELETE THESE CHARS

Expected results:
  rhsm-icon [OPTIONS]

Comment 1 RHEL Program Management 2012-01-09 14:56:40 UTC
This request was evaluated by Red Hat Product Management for inclusion in Red Hat Enterprise Linux 5.8 and Red Hat does not plan to fix this issue the currently developed update.

Contact your manager or support representative in case you need to escalate this bug.

Comment 3 RHEL Program Management 2012-04-02 10:50:37 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 5 James Bowes 2012-05-24 16:03:01 UTC
OPTION... is a valid way to indicate that you can supply a list of options, and it would be way too troublesome to change anyways (we'd have to format and carry around all of the options and their localizations, rather than letting glib take care of a lot of it for us). 

I'll drop "rhsm icon" from the output though!

Comment 6 John Sefler 2012-05-25 13:23:20 UTC
Expected results:
  rhsm-icon [OPTIONS]
                   ^  pluralize rather than ...

This is more consistent with our other tools.  for example:


# rhn-migrate-classic-to-rhsm --help | grep -i usage -A1
Usage: rhn-migrate-classic-to-rhsm [OPTIONS]

# subscription-manager --help | grep -i usage -A1
Usage: subscription-manager MODULE-NAME [MODULE-OPTIONS] [--help]

# subscription-manager-gui --help | grep -i usage -A1
Usage: subscription-manager-gui [options]

Comment 7 James Bowes 2012-05-25 13:42:19 UTC
But it is consistent with any other app that uses glib's option parser, and just like the --display bug, trying to change it would require use to carry around the full help text, and get it translated, etc.

Comment 8 James Bowes 2012-05-25 13:43:20 UTC
Fixed (the rhsm-icon part at least) in 1.0.3, 724ecb

Comment 9 J.C. Molet 2012-06-19 17:02:28 UTC
testing with: subscription-manager-gui-1.0.4-1.git.3.1768f90.el5

[root@jmolet-vm0 rhsm]# rhsm-icon --help
Usage:
  rhsm-icon [OPTION...] 



"rhsm icon" has been dropped from the ending of the usage string  

The ellipses after the option list are consistent with other programs:

xanadu|~| ❯ curl --help
Usage: curl [options...] <url>

xanadu|~| ❯ firefox --help
Usage: /usr/lib64/firefox-3.6/firefox [ options ... ] [URL]

though broadly there isn't any strict convention for this.

marking VERIFIED.

Comment 11 errata-xmlrpc 2013-01-08 03:47:58 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-0033.html


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