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 1145828 - man page for rhn-migrate-classic-to-rhsm no longer matches the CLI --help info
Summary: man page for rhn-migrate-classic-to-rhsm no longer matches the CLI --help info
Keywords:
Status: CLOSED DUPLICATE of bug 1122530
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: subscription-manager
Version: 7.1
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: rc
: ---
Assignee: Chris "Ceiu" Rog
QA Contact: John Sefler
URL:
Whiteboard:
Depends On:
Blocks: rhsm-rhel71
TreeView+ depends on / blocked
 
Reported: 2014-09-23 22:26 UTC by John Sefler
Modified: 2015-01-16 14:59 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-01-16 14:59:42 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2015:0502 0 normal SHIPPED_LIVE subscription-manager bug fix and enhancement update 2015-03-05 16:20:39 UTC

Description John Sefler 2014-09-23 22:26:18 UTC
Description of problem:
Shown below are the current rhn-migrate-classic-to-rhsm command line options.  Some of them have been renamed and some removed since the prior version of subscription-manager-migration-1.12.  Consequently the man page for rhn-migrate-classic-to-rhsm needs to be corrected.

[root@jsefler-7 ~]# rhn-migrate-classic-to-rhsm --help
Usage: rhn-migrate-classic-to-rhsm [OPTIONS]

Options:
  -h, --help            show this help message and exit
  -n, --no-auto         don't execute the auto-attach option while registering
                        with subscription manager
  -s SERVICE_LEVEL, --service-level=SERVICE_LEVEL
                        service level to follow when attaching subscriptions,
                        for no service level use --servicelevel=""
  --no-proxy            don't use legacy proxy settings with destination
                        server
  --org=ORG             organization to register to
  --environment=ENVIRONMENT
                        environment to register to
  -f, --force           ignore channels not available on destination server
  --legacy-user=LEGACY_USER
                        specify the user name on the legacy server
  --legacy-password=LEGACY_PASSWORD
                        specify the password on the legacy server
  --destination-url=DESTINATION_URL
                        specify the subscription management server to migrate
                        to
  --destination-user=DESTINATION_USER
                        specify the user name on the destination server
  --destination-password=DESTINATION_PASSWORD
                        specify the password on the destination server

Version-Release number of selected component (if applicable):
[root@jsefler-7 ~]# rpm -q subscription-manager-migration
subscription-manager-migration-1.13.2-1.git.6.818c13b.el7.x86_64
[root@jsefler-7 ~]# man -P cat rhn-migrate-classic-to-rhsm | tail -1
Version 0.7                            January 7, 2013         rhn-migrate-classic-to-rhsm(8)


How reproducible:


Steps to Reproduce:
[root@jsefler-7 ~]# man -P cat rhn-migrate-classic-to-rhsm

> man page not shown



Actual results:


Expected results:
Several things are wrong with the man page including...
1. The SYNOPSIS is wrong
2. no more --gui option; it has been removed
3. --servicelevel option was renamed to --service-level (IN MY OPINION THIS SHOULD STAY --servicelevel FOR CONSISTENCY WITH subscription-manager); MOREOVER the CLI description still references to 'use --servicelevel=""' as well as all of the discussions in the man page
4. --serverurl option has been renamed to --destination-url  (NOTE: --serverurl was originally chosen to compliment the --serverurl option to in subscription-manager register)
5. --legacy-user has no description in the man page
5. --legacy-password has no description in the man page
6. --destination-user has no description in the man page
7. --destination-password has no description in the man page
8. all of the examples used in the man page contain outdated message strings.


Additional info:

Comment 2 John Sefler 2014-09-24 15:05:32 UTC
(In reply to John Sefler from comment #0)
> 3. --servicelevel option was renamed to --service-level (IN MY OPINION THIS SHOULD STAY --servicelevel FOR CONSISTENCY WITH subscription-manager);
> MOREOVER the CLI description still references to 'use --servicelevel=""' as
> well as all of the discussions in the man page

If the decision is made to keep the newly renamed --service-level containing the hyphen, then I suggest that we also change the subscription-manager --servicelevel option to --service-level for consistency.

Comment 3 Chris "Ceiu" Rog 2014-10-17 16:18:46 UTC
commit add5a9b746f9f2af147a7e4622b897a46b5ef132
Author: Chris Rog <crog>
Date:   Fri Oct 3 14:40:26 2014 -0400

    1122530: Improved grammar and abbreviation usage.
    
    Made some changes to the man pages and some displayed strings to improve
    the grammar and reduce the usage of select abbreviations and terms.
    
    Additionally, the man pages for the rhn-migrate-classic-to-rhsm and
    sat5to6.8 have been updated to reflect changes to the options and
    functionality (bug 1145828).

Comment 5 John Sefler 2014-11-26 20:36:39 UTC
Testing Version...
[root@jsefler-os7 ~]# rpm -q subscription-manager-migration
subscription-manager-migration-1.13.9-1.el7.x86_64
[root@jsefler-os7 ~]# man -P cat rhn-migrate-classic-to-rhsm | tail -1
Version 0.7                      January 7, 2013  rhn-migrate-classic-to-rhsm(8)

FAILEDQA: The man page version and date were not updated. We really should start doing that every time a change is made to the man pages.

Comment 6 Adrian Likins 2014-12-03 16:06:17 UTC
(In reply to John Sefler from comment #5)
> Testing Version...
> [root@jsefler-os7 ~]# rpm -q subscription-manager-migration
> subscription-manager-migration-1.13.9-1.el7.x86_64
> [root@jsefler-os7 ~]# man -P cat rhn-migrate-classic-to-rhsm | tail -1
> Version 0.7                      January 7, 2013 
> rhn-migrate-classic-to-rhsm(8)
> 
> FAILEDQA: The man page version and date were not updated. We really should
> start doing that every time a change is made to the man pages.

Why? I don't understand why the man pages have their own versions. I would vote for removing it. And as a distant second option, populating it automatically, but why bother.

Comment 7 John Sefler 2014-12-08 16:59:11 UTC
I have to agree with Adrian. Since the subscription-manager man pages are provided by the subscription-manager package, the man page effectively inherits its version from the package.  The version and date printed on the man page just adds confusion and is technically meaningless.  If we really need to report a version and date in the man page, it should come from the subscription-manager package build.  I do not see a date and version on the man page for yum.

I vote to remove date/version from the header/footer of all the rhsm man pages.

Comment 8 Chris "Ceiu" Rog 2014-12-11 17:06:54 UTC
commit 5094c9ff71eaec4ce5b6fbcf10431614bb7e9012
Author: Chris Rog <crog>
Date:   Mon Dec 8 11:48:10 2014 -0500

    1122530: Removed/updated more obsoleted documentation, dates and versions
    
    - Additionally, some minor grammar corrections have been made.

Comment 10 William Poteat 2015-01-16 14:59:42 UTC
Fixed as part of another bug as per Comment 8

*** This bug has been marked as a duplicate of bug 1122530 ***


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