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 1192574 - typos and poor grammar in subscription-manager-gui man page
Summary: typos and poor grammar in subscription-manager-gui man page
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 6
Classification: Red Hat
Component: subscription-manager
Version: 6.8
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: rc
: ---
Assignee: William Poteat
QA Contact: John Sefler
URL:
Whiteboard:
Depends On:
Blocks: rhsm-rhel68
TreeView+ depends on / blocked
 
Reported: 2015-02-13 18:21 UTC by John Sefler
Modified: 2016-05-10 20:36 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-05-10 20:36:23 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2016:0797 0 normal SHIPPED_LIVE python-rhsm and subscription-manager bug fix and enhancement update 2017-01-06 16:31:50 UTC

Description John Sefler 2015-02-13 18:21:16 UTC
Description of problem:
There are a few typos and grammar improvements that can be made in the subscription-manager man page.  See the comments that follow for each.

Version-Release number of selected component (if applicable):
[root@jsefler-os7 ~]# rpm -q subscription-manager-gui
subscription-manager-gui-1.13.19-1.el7.x86_64

Comment 1 John Sefler 2015-02-13 18:26:01 UTC
[root@jsefler-os7 ~]# man subscription-manager-gui | grep DESCRIPTION -A12
DESCRIPTION
       subscription-manager-gui opens the local client  tool  to  manage  sub‐
       scriptions  and installed products on Red Hat Enterprise Linux systems.
       The same tasks that can be performed by  invoking  subscription-manager
       can  be performed in the GUI, including registering systems with a sub‐
       scription management service, applying and removing subscriptions,  and
       viewing the subscription status of installed products.


       The Subscription Manager UI can also be opened by selecting the Red Hat
       Subscription Manager item from the Applications > System Tools menu  in
       RHEL 5.x or the System > Administration menu in RHEL 6.x.

Change this last paragraph to include RHEL 7.x as follows...

       The Subscription Manager UI can also be opened by selecting the Red Hat
       Subscription Manager item from the Applications > System Tools menu  in
       RHEL 5.x and RHEL7.x or the System > Administration menu in RHEL 6.x.
                ^^^^^^^^^^^
                ADD HERE

Comment 2 John Sefler 2015-02-13 18:38:28 UTC
[root@jsefler-os7 ~]# man subscription-manager-gui | head -1
subscription-manager-gui(8)  System Manager's Manual  subscription-manager-gui(8)
                             ^^^^^^^^^^^^^^^^^^^^^^^
                   change to Subscription Management

Comment 3 John Sefler 2015-02-13 20:01:10 UTC
[root@jsefler-os7 ~]# man subscription-manager-gui | grep REFERENCES -A5
REFERENCES
       For procedures and tasks that can be performed in the Subscription Man‐
       ager UI, check the Gnome help files (by pressing <F1>) or refer to  the
       RHEL Subscription Management Guide at <https://access.redhat.com/knowl‐
       edge/docs/en-US/Red_Hat_Subscription_Management/1.0/html/Subscrip‐
       tion_Management_Guide/index.html>.


The link referenced above from the the subscription-manager-gui man page is no longer found at https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1.0/html/Subscription_Management_Guide/index.html
The document appears to have moved to...
https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/index.html

Comment 4 John Sefler 2015-02-24 16:27:12 UTC
Deferring to RHEL6.7 for resolution

Comment 5 Chris "Ceiu" Rog 2015-06-04 14:59:26 UTC
commit 589bf7debe8702d147f3a69f61f34c44ab47ef63
Author: Chris Rog <crog>
Date:   Thu Apr 9 10:29:28 2015 -0400

    1192574: Fixed typos and grammar issues in subman GUI man page

Comment 8 Shwetha Kallesh 2015-12-09 09:39:22 UTC
Marking bug as failed_qa because the space between the headings is missing, whereas the description and refernces have been changed 


[root@pogo-cn1100-01 ~]# man subscription-manager-gui | head -1
subscription-manager-gui(8) Subscription Managementsubscription-manager-gui(8)

                                                  ^^^ need a space here in between 2 words

-------------------------------------------------------------------------------
Description has been changed 

[root@pogo-cn1100-01 ~]# man subscription-manager-gui | grep "Subscription Manager UI" -A12
       The Subscription Manager UI can also be opened by selecting the Red Hat
       Subscription Manager item from the Applications > System Tools menu  in
       RHEL 5.x and RHEL 7.x, or the System > Administration menu in RHEL 6.x.

---------------------------------------------------------------------------------
Link reference has been changed 


REFERENCES
       For  procedures  and  tasks  that can be performed in the Subscription Manager UI, check the Gnome help files (by pressing <F1>) or refer to the
       RHEL Subscription Management Guide at <https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/index.html>.

--------------------------------------------------------------------------------

Comment 9 John Sefler 2016-01-21 17:08:43 UTC
Regarding the objection on comment 8...

I found that the rendering of the exact same subscription-manager-gui man page (/usr/share/man/man8/subscription-manager-gui.8.gz) on RHEL6 and RHEL7 behaves slightly different with respect to the rendering of .TH and is therefore a bug in the version of groff installed on RHEL6.

On RHEL6, the .TH appears to render as a fixed width in the terminal and since there are limited characters in the page width, the title runs into the name of the program as shown here...

[root@jsefler-6 ~]# man subscription-manager-gui | head -1
subscription-manager-gui(8) Subscription Managementsubscription-manager-gui(8)

[root@jsefler-6 ~]# rpm -qa | grep groff
groff-1.18.1.4-21.el6.x86_64


Where as on RHEL7, the .TH will expand to the witch of the terminal.  Hence a wider terminal will allow the .TH line to render with the title centered between the name of the program justified on the left and the right as shown here...

[root@jsefler-7 ~]# man subscription-manager-gui | head -1
subscription-manager-gui(8)   Subscription Management  subscription-manager-gui(8)

[root@jsefler-7 ~]# rpm -qa | grep groff
groff-base-1.22.2-8.el7.x86_64



Moving this bug to VERIFIED as the original issues were fixed.  The .TH formatting issue would be a groff bug on RHEL6 that appears to already have been fixed on RHEL7.

Comment 11 errata-xmlrpc 2016-05-10 20:36:23 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://rhn.redhat.com/errata/RHBA-2016-0797.html


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