RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 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 "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". 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 "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-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 1290578 - subscription-manager man page contains redundant REDEEM sections
Summary: subscription-manager man page contains redundant REDEEM sections
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: subscription-manager
Version: 7.1
Hardware: All
OS: All
unspecified
low
Target Milestone: rc
: ---
Assignee: candlepin-bugs
QA Contact: John Sefler
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-12-10 20:56 UTC by Dan Yocum
Modified: 2016-01-04 20:29 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-01-04 20:29:08 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)

Description Dan Yocum 2015-12-10 20:56:56 UTC 
Description of problem:

This:

########
   REDEEM OPTIONS
       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.

       --email=EMAIL
              Gives the email account to send the redemption notification message to.

       --locale=LOCALE
              Sets the locale to use for the message. If none is given, then it defaults to the local system's locale.

       --org=ORG
              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 --email=admin --org="IT Dept"
##########


RHEL7.1
Comment 1 John Sefler 2015-12-11 15:34:02 UTC 
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]"
NAME
SYNOPSIS
DESCRIPTION
COMMANDS AND OPTIONS
   COMMON OPTIONS
   REGISTER OPTIONS
   UNREGISTER OPTIONS
   ATTACH OPTIONS
   AUTO-ATTACH OPTIONS
   REMOVE OPTIONS
   RELEASE OPTIONS
   IMPORT OPTIONS
   REDEEM OPTIONS                                       <============
   LIST OPTIONS
   REFRESH OPTIONS
   ENVIRONMENTS OPTIONS
   REPOS OPTIONS
   ORGS OPTIONS
   PLUGIN OPTIONS
   REPO-OVERRIDE OPTIONS
   IDENTITY OPTIONS
   FACTS OPTIONS
   CLEAN OPTIONS
   CONFIG OPTIONS
   VERSION OPTIONS
   STATUS OPTIONS
   DEPRECATED COMMANDS
USAGE
   REGISTERING AND UNREGISTERING MACHINES
   LISTING, ATTACHING, AND REMOVING SUBSCRIPTIONS FOR PRODUCTS
   REDEEMING EXISTING SUBSCRIPTIONS                     <============
   VIEWING LOCAL SUBSCRIPTION & CONTENT PROVIDER INFORMATION
   CHANGING SUBSCRIPTION MANAGER CONFIGURATION
   UPDATING FACTS
   SUBSCRIPTIONS AND KICKSTART
NETWORK INFORMATION
FILES
AUTHORS
Comment 2 Dan Yocum 2015-12-11 16:02:14 UTC 
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.
Note You need to log in before you can comment on or make changes to this bug.