Red Hat Bugzilla – Bug 1290578
subscription-manager man page contains redundant REDEEM sections
Last modified: 2016-01-04 15:29:08 EST
Description of problem:
The redeem command is used for systems that are purchased from third-party vendors that include a subscription. The redemption process essentially auto-attaches the preselected subscription that the
vendor supplied to the system.
Gives the email account to send the redemption notification message to.
Sets the locale to use for the message. If none is given, then it defaults to the local system's locale.
Identifies the organization which issued the subscription being redeemed.
Is similar to this:
REDEEMING EXISTING SUBSCRIPTIONS
Sometimes, a system may come preconfigured with products and subscriptions. Rather than attaching a pool and claiming a subscription, this system simply needs to redeem its existing subscriptions.
After registration, subscriptions on preconfigured systems can be claimed using the redeem command, which essentially auto-attaches the system to its preexisting subscriptions.
subscription-manager redeem --firstname.lastname@example.org --org="IT Dept"
The REDEEM OPTIONS that you referenced in comment 0 is found under COMMANDS AND OPTIONS where the intent is to describe every command line option of the module which it does.
The REDEEMING EXISTING SUBSCRIPTIONS that you referenced in comment 0 is found under the USAGE section which was designed by Deon to provide a more detailed conceptual understanding of how/when to use various commands.
In my opinion this man page is reasonably designed and informative. Therefore the sections that describe subscription redemption are complimentary rather than redundant.
Unless there is an additional explanation or clarification that you want to include in the man page, I think this bug should be CLOSED NOTABUG.
Here is the structure of the man page...
[root@jsefler-7 ~]# man -P cat subscription-manager | egrep "^[A-Z]|^ [A-Z]"
COMMANDS AND OPTIONS
REDEEM OPTIONS <============
REGISTERING AND UNREGISTERING MACHINES
LISTING, ATTACHING, AND REMOVING SUBSCRIPTIONS FOR PRODUCTS
REDEEMING EXISTING SUBSCRIPTIONS <============
VIEWING LOCAL SUBSCRIPTION & CONTENT PROVIDER INFORMATION
CHANGING SUBSCRIPTION MANAGER CONFIGURATION
SUBSCRIPTIONS AND KICKSTART
I find it superfluous - the second REDEEM section lists the same options as the first section - but, if you're really adamant about keeping it, I'm ok with ignoring it.