Bug 1039914
| Summary: | Wrong command option given in the Man page of rhsm-debug command | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 7 | Reporter: | Rehana <redakkan> |
| Component: | subscription-manager | Assignee: | Adrian Likins <alikins> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | John Sefler <jsefler> |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 7.0 | CC: | alikins, bkearney, ckozak, dlackey, fsharath |
| 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: | 2014-06-13 09:23:38 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: | 863175 | ||
master commit 77752678383866dea8b4d2701cae695e7b14aac1 Version:
# subscription-manager version
server type: Red Hat Subscription Management
subscription management server: 0.9.2-1
subscription-manager: 1.10.11-1.el7
python-rhsm: 1.10.11-1.el7
Verification:
rct(8) Certificate Information rct(8)
NAME
rhsm-debug - Compiles information about system's entitlements, products, and identity used by Red Hat Subscription Manager.
SYNOPSIS
rhsm-debug system [--destination /path] /path/to/system-debug.zip
DESCRIPTION
COMMANDS
compile
OPTIONS
EXAMPLES
BUGS
This tool is part of Red Hat Subscription Manager. To file bugs against this command-line tool, go to <https://bugzilla.redhat.com>, and select Red Hat > Red Hat Enterprise Linux > subscription-man‐
ager.
AUTHORS
William Poteat<wpoteat>. The rhsm-debug tool was written by William Poteat.
COPYRIGHT
Copyright (c) 2012 Red Hat, Inc. This is licensed under the GNU General Public License, version 2 (GPLv2). A copy of this license is available at http://www.gnu.org/licenses/old-
licenses/gpl-2.0.txt.
version 1.3 May 23, 2013 rct(8)
Incorrect Header and footer. Also COMMANDS and OPTIONS are incomplete
QA FAILED.. Moving back to ASSIGNED
commit c047fba9da624d7d6c5351db97f55ec4ed893ed5
Author: Bryan Kearney <bkearney>
Date: Wed Jan 29 13:06:42 2014 -0500
1039914: Update the rhsm-debug man page
Testing Version...
[root@jsefler-7 ~]# subscription-manager version
server type: Red Hat Subscription Management
subscription management server: Unknown
subscription-manager: 1.10.14-2.el7
python-rhsm: 1.10.12-1.el7
[root@jsefler-7 ~]# man -P cat rhsm-debug
rhsm-debug(8) Certificate Information Tool rhsm-debug(8)
NAME
rhsm-debug - Compiles information about system's enti‐
tlements, products, and identity used by Red Hat Sub‐
scription Manager.
SYNOPSIS
rhsm-debug module [options]
DESCRIPTION
rhsm-debug compiles information about system's enti‐
tlements, products, and identity used by Red Hat Sub‐
scription Manager.
COMMANDS AND OPTIONS
rhsm-debug has specific options available for each
module, depending on what operation is being per‐
formed. The currently supported modules are:
1. system
COMMON OPTIONS
-h, --help
Prints the specific help information for the
given command.
--proxy=PROXY
Uses an HTTP proxy. The PROXY name has the for‐
mat hostname:port.
--proxyuser=PROXYUSERNAME
Gives the username to use to authenticate to
the HTTP proxy.
--proxypass=PROXYPASSWORD
Gives the password to use to authenticate to
the HTTP proxy.
SYSTEM OPTIONS
The system command pulls in debug information off of
the current system
--destination=DESTINATION
The directory to place the resulting debug
data. The default is /tmp.
--no-archive
Generates an uncompressed directory intead of a
gzipped file.
--sos Eliminiates the information that has already
been collected by the SOS report process.
BUGS
This tool is part of Red Hat Subscription Manager. To
file bugs against this command-line tool, go to
<https://bugzilla.redhat.com>, and select Red Hat >
Red Hat Enterprise Linux > subscription-manager.
AUTHORS
William Poteat<wpoteat>. The rhsm-debug
tool was written by William Poteat.
COPYRIGHT
Copyright (c) 2012 Red Hat, Inc. This is licensed
under the GNU General Public License, version 2
(GPLv2). A copy of this license is available at
http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
version 1.3 May 23, 2013 rhsm-debug(8)
^^^^^^^^^^^ ^^^^^^^^^^^^
FAILED: This man page did not exist on May 23, 2013
FAILED: Option --proxypass should be --proxypassword
FAILED: --sos "Eliminiates the information" should be "Excludes data files"
commit 89d66fdb086ba33cab9b35a54c3e92925b7d6827
Author: Adrian Likins <alikins>
Date: Wed Feb 19 11:09:46 2014 -0500
1039913: rhsm-debug updates and fixes
(yeah, the bug id in there is wrong. sigh)
Verifying Version...
[root@jsefler-7 ~]# subscription-manager version
server type: Red Hat Subscription Management
subscription management server: Unknown
subscription-manager: 1.10.14-3.el7
python-rhsm: 1.10.12-1.el7
[root@jsefler-7 ~]# man -P cat rhsm-debug
rhsm-debug(8) Certificate Information Tool rhsm-debug(8)
NAME
rhsm-debug - Compiles information about system's
entitlements, products, and identity used by Red Hat
Subscription Manager.
SYNOPSIS
rhsm-debug module [options]
DESCRIPTION
rhsm-debug compiles information about system's enti‐
tlements, products, and identity used by Red Hat
Subscription Manager.
COMMANDS AND OPTIONS
rhsm-debug has specific options available for each
module, depending on what operation is being per‐
formed. The currently supported modules are:
1. system
COMMON OPTIONS
-h, --help
Prints the specific help information for the
given command.
--proxy=PROXY
Uses an HTTP proxy. The PROXY name has the
format hostname:port.
--proxyuser=PROXYUSERNAME
Gives the username to use to authenticate to
the HTTP proxy.
--proxypassword=PROXYPASSWORD
Gives the password to use to authenticate to
the HTTP proxy.
SYSTEM OPTIONS
The system command pulls in debug information off of
the current system
--destination=DESTINATION
The directory to place the resulting debug
data. The default is /tmp.
--no-archive
Generates an uncompressed directory intead of
a gzipped file.
--sos Excludes data files that are also collected
by the sosreport tool.
BUGS
This tool is part of Red Hat Subscription Manager.
To file bugs against this command-line tool, go to
<https://bugzilla.redhat.com>, and select Red Hat >
Red Hat Enterprise Linux > subscription-manager.
AUTHORS
William Poteat<wpoteat>. The rhsm-debug
tool was written by William Poteat.
COPYRIGHT
Copyright (c) 2012 Red Hat, Inc. This is licensed
under the GNU General Public License, version 2
(GPLv2). A copy of this license is available at
http://www.gnu.org/licenses/old-
licenses/gpl-2.0.txt.
version 1.3 May 23, 2013 rhsm-debug(8)
[root@jsefler-7 ~]#
FAILED: This man page still did not exist on May 23, 2013. I guess we are ignoring this minor typo for now.
VERIFIED: Option --proxypass was properly changed to --proxypassword
VERIFIED: --sos "Eliminiates the information" now says "Excludes data files" which is technically more accurate.
VERIFIED: header and footer correctly state the correct tool name rhsm-debug
VERIFIED: the correct command "system" is now listed
VERIFIED: all command system options are listed.
This request was resolved in Red Hat Enterprise Linux 7.0. Contact your manager or support representative in case you have further questions about the request. |
Description of problem: Version-Release number of selected component (if applicable): subscription management server: 0.8.33-1 subscription-manager: 1.10.8-1.el7 python-rhsm: 1.10.8-1.el7 How reproducible: 2/2 Steps to Reproduce: 1.execute man rhsm-debug Actual results: rct(8) Certificate Information Tool rct(8) -----(1) NAME rhsm-debug - Compiles information about consumer's entitlements, products, and identity used by Red Hat Subscription Manager. SYNOPSIS rhsm-debug compile [--destination /path] /path/to/system-debug.zip DESCRIPTION COMMANDS compile ----(2) OPTIONS EXAMPLES <snip> (1) in the man page of rhsm-debug its displaying "rct()" on the certification information tool header (2) command/sysnopsis section displayed "complie" while the rhsm-debug help command gave the module option as "system" rhsm-debug --help Usage: rhsm-debug MODULE-NAME [MODULE-OPTIONS] [--help] Other Modules: system None Expected results: (1) Should display rhsm-debug on the certification information tool header (2) should display the correct module detail in the man page Additional info: