Bug 1145828
| Summary: | man page for rhn-migrate-classic-to-rhsm no longer matches the CLI --help info | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 7 | Reporter: | John Sefler <jsefler> |
| Component: | subscription-manager | Assignee: | Chris "Ceiu" Rog <crog> |
| Status: | CLOSED DUPLICATE | QA Contact: | John Sefler <jsefler> |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 7.1 | CC: | alikins, crog, jsefler, ovasik, wpoteat |
| Target Milestone: | rc | ||
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2015-01-16 14:59:42 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
| Bug Depends On: | |||
| Bug Blocks: | 1005618 | ||
(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. 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).
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. (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. 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. 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.
Fixed as part of another bug as per Comment 8 *** This bug has been marked as a duplicate of bug 1122530 *** |
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: