Bug 1300791

Summary:	cosmetic fix to the .TH titles in subscription-manager man pages
Product:	Red Hat Enterprise Linux 6	Reporter:	John Sefler <jsefler>
Component:	subscription-manager	Assignee:	William Poteat <wpoteat>
Status:	CLOSED ERRATA	QA Contact:	John Sefler <jsefler>
Severity:	low	Docs Contact:
Priority:	low
Version:	6.8	CC:	bcourt, csnyder, wpoteat
Target Milestone:	rc	Keywords:	Triaged
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2016-05-10 20:39:27 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:

Description John Sefler 2016-01-21 17:41:05 UTC

Description of problem:

Looking at the source code for the man pages, a dash was used to effectively remove the left and center footer of a man page which are often used for versioning information.  Rather than use a dash which makes the page appear to have extraneous characters, let's just pass an empty "" string.  Currently the footers generally look like this (notice the dashes)...

[root@jsefler-6 ~]# man subscription-manager | tail -1
-                                      -               subscription-manager(8)



Version-Release number of selected component (if applicable):
subscription-manager-1.16.8-1.el6.x86_64

How reproducible:


Steps to Reproduce:
From the git cloned subscription-manager source code....
[jsefler@jseflerT540p man]$ grep "\.TH" *.8
install-num-migrate-to-rhsm.8:.TH "install-num-migrate-to-rhsm" "8"
rct.8:.TH RCT 8 - - "RHSM Certificate Tool"
rhn-migrate-classic-to-rhsm.8:.TH "rhn-migrate-classic-to-rhsm" "8"
rhsmcertd.8:.TH rhsmcertd 8 - - "Subscription Management"
rhsm-debug.8:.TH RHSM-DEBUG 8 - - "RHSM Debug Tool"
rhsm-icon.8:.TH rhsm-icon 8
sat5to6.8:.TH "sat5to6" "8"
subscription-manager.8:.TH subscription-manager 8 - - "Subscription Management"
subscription-manager-gui.8:.TH subscription-manager-gui 8 - - "Subscription Management"



Actual results:
above

Expected results:
for each of the man pages, I would suggest changing these as follows (Before/After)...

install-num-migrate-to-rhsm.8:.TH "install-num-migrate-to-rhsm" "8"
install-num-migrate-to-rhsm.8:.TH "install-num-migrate-to-rhsm" "8" "" "" "Migration Tool"

rct.8:.TH RCT 8 - - "RHSM Certificate Tool"
rct.8:.TH RCT 8 "" "" "RHSM Certificate Tool"

rhn-migrate-classic-to-rhsm.8:.TH "rhn-migrate-classic-to-rhsm" "8"
rhn-migrate-classic-to-rhsm.8:.TH "rhn-migrate-classic-to-rhsm" "8" "" "" "Migration Tool"

rhsmcertd.8:.TH rhsmcertd 8 - - "Subscription Management"
rhsmcertd.8:.TH rhsmcertd 8 "" "" "Subscription Management"

rhsm-debug.8:.TH RHSM-DEBUG 8 - - "RHSM Debug Tool"
rhsm-debug.8:.TH RHSM-DEBUG 8 "" "" "RHSM Debug Tool"

rhsm-icon.8:.TH rhsm-icon 8
rhsm-icon.8:.TH rhsm-icon 8 "" "" "RHSM Desktop Icon"

sat5to6.8:.TH "sat5to6" "8"
sat5to6.8:.TH "sat5to6" "8" "" "" "Migration Tool"

subscription-manager.8:.TH subscription-manager 8 - - "Subscription Management"
subscription-manager.8:.TH subscription-manager 8 "" "" "Subscription Management"

subscription-manager-gui.8:.TH subscription-manager-gui 8 - - "Subscription Management"
subscription-manager-gui.8:.TH subscription-manager-gui 8 "" "" "Subscription Management"




Additional info:

Comment 1 William Poteat 2016-02-05 19:51:00 UTC

master commit 3b462b9db938a29c4c501c32cc0290dbb32e1d01

Comment 4 John Sefler 2016-03-08 17:41:11 UTC

(In reply to William Poteat from comment #1)
> master commit 3b462b9db938a29c4c501c32cc0290dbb32e1d01

I believe this is the correct commit
master commit a8997dd0c1328e86065dfae479cc45008da6489c

    1300791: Update man page footers

Comment 5 John Sefler 2016-03-08 17:52:29 UTC

Verifying Version...
[root@jsefler-6 ~]# rpm -q subscription-manager
subscription-manager-1.16.8-4.el6.x86_64


[root@jsefler-6 ~]# man rct | tail -1
                                                                        RCT(8)
[root@jsefler-6 ~]# 
[root@jsefler-6 ~]# man rhn-migrate-classic-to-rhsm | tail -1
                                                rhn-migrate-classic-to-rhsm(8)
[root@jsefler-6 ~]# 
[root@jsefler-6 ~]# man rhsmcertd | tail -1
                                                                  rhsmcertd(8)
[root@jsefler-6 ~]# 
[root@jsefler-6 ~]# man rhsm-debug | tail -1
                                                                 RHSM-DEBUG(8)
[root@jsefler-6 ~]# 
[root@jsefler-6 ~]# man rhsm-icon | tail -1
                                                                  rhsm-icon(8)
[root@jsefler-6 ~]# 
[root@jsefler-6 ~]# man subscription-manager | tail -1
                                                       subscription-manager(8)
[root@jsefler-6 ~]# 
[root@jsefler-6 ~]# man subscription-manager-gui | tail -1
                                                   subscription-manager-gui(8)


VERIFIED: The man page footers no longer have a "-" placeholder.

Comment 7 errata-xmlrpc 2016-05-10 20:39:27 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