Bug 1283866

Summary: man 8 mkfs.gfs2 contains example with wrong command
Product: Red Hat Enterprise Linux 7 Reporter: Robin Hack <rhack>
Component: gfs2-utilsAssignee: Andrew Price <anprice>
Status: CLOSED ERRATA QA Contact: cluster-qe <cluster-qe>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 7.3CC: cluster-maint, gfs2-maint, ivlnka, jpayne
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: gfs2-utils-3.1.9-1.el7 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-11-04 06:30:48 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: 1271674    
Bug Blocks:    
Attachments:
Description Flags
Updated man page none

Description Robin Hack 2015-11-20 06:59:03 UTC
Hi. I found small bug (or feature? :)) in man pages of gfs2-utils package.

Description of problem:
Text and example section contains gfs2_mkfs command which I'm not able to find when gfs2-utils were installed

Version-Release number of selected component (if applicable):
gfs2-utils-3.1.8-6.el7

How reproducible:
always

Steps to Reproduce:
1. man 8 gfs2_mkfs | grep gfs2_mkfs
2.
3.

Actual results:
gfs2_mkfs in text

Expected results:
mkfs.gfs2 in text

Additional info:

Comment 2 Andrew Price 2015-11-20 12:25:06 UTC
(In reply to Robin Hack from comment #0)
> Hi. I found small bug (or feature? :)) in man pages of gfs2-utils package.

Definitely a bug, thanks :) The gfs2-utils man pages could benefit from some TLC in general.

Comment 4 Andrew Price 2016-02-22 17:47:26 UTC
Created attachment 1129425 [details]
Updated man page

I've submitted a patch upstream to improve the mkfs.gfs2 man page. Attached is the full changed file, which can be viewed with man -l path/to/mkfs.gfs2.8

Please let me know if you spot anything I've missed or further improvements that could be made.

Comment 6 Andrew Price 2016-03-22 14:54:26 UTC
The new manpage is upstream now, so this will get fixed with the package rebase.

Comment 7 Mike McCune 2016-03-28 22:15:42 UTC
This bug was accidentally moved from POST to MODIFIED via an error in automation, please see mmccune with any questions

Comment 10 Justin Payne 2016-07-26 16:08:42 UTC
Verified in gfs2-utils-3.1.9-3.el7:

[root@host-008 ~]# rpm -q gfs2-utils
gfs2-utils-3.1.9-3.el7.x86_64

[root@host-008 ~]# man 8 mkfs.gfs2 | grep gfs2_mkfs |wc -l
0

Comment 12 errata-xmlrpc 2016-11-04 06:30:48 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-2438.html