Bug 1484767

Summary:	The man pages of lvmthin should be file system type agnostic
Product:	Red Hat Enterprise Linux 7	Reporter:	Jesús Serrano Sánchez-Toscano <jserrano>
Component:	lvm2	Assignee:	LVM and device-mapper development team <lvm-team>
lvm2 sub component:	Manual pages and Documentation	QA Contact:	cluster-qe <cluster-qe>
Status:	CLOSED ERRATA	Docs Contact:
Severity:	low
Priority:	medium	CC:	agk, cmarthal, heinzm, jbrassow, lnykryn, mcsontos, msnitzer, prajnoha, prockai, teigland, zkabelac
Version:	7.4
Target Milestone:	rc
Target Release:	---
Hardware:	Unspecified
OS:	Linux
Whiteboard:
Fixed In Version:	lvm2-2.02.175-1.el7	Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2018-04-10 15:20:44 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 Jesús Serrano Sánchez-Toscano 2017-08-24 10:04:46 UTC

Description of problem:
The man pages of 'lvmthin' might lead to misunderstanding when suggesting to check and repair a file system because it mentions "fsck". While this might be intended in some cases as an abbreviation, in other cases it's mentioned as a command. However, in the case a XFS file system is used, it will be needed to use a different command (xfs_repair). 

Version-Release number of selected component (if applicable):
lvm2-2.02.171-8.el7.x86_64

Actual results:
# man lvmthin | grep -n fsck
304:       fsck on a file system.
595:       result in file system corruption for non-journaled file systems that may require fsck.  When a thin  pool  returns  errors
606:       in corruption that may require fsck (the specific consequences depend on the thin LV user.)
661:       4. Check and repair file system with fsck.


Expected results:
Instead of mentioning "fsck" it would be better to use something like "to check and repair the file system with the appropriate tool", since mentioning just "fsck" may lead you to think of using only the command "fsck" whereas it's not possible to use it against a XFS file system. The procedures described there should be file system type agnostic.

Additional info:
N/A

Comment 2 David Teigland 2017-08-24 15:26:23 UTC

updated in git

Comment 3 Jonathan Earl Brassow 2017-10-10 21:49:40 UTC

(In reply to David Teigland from comment #2)
> updated in git

commit 043ff47b0579bffaa63cb023d8850b0e749eb9ce
Author: David Teigland <teigland>
Date:   Thu Aug 24 10:25:01 2017 -0500

    man lvmthin: change fsck references

    to more generic terms like repair.

Comment 7 Corey Marthaler 2017-10-16 22:29:38 UTC

Fix verified in the latest rpms

lvm2-2.02.175-2.el7    BUILT: Fri Oct 13 13:31:22 CEST 2017
lvm2-libs-2.02.175-2.el7    BUILT: Fri Oct 13 13:31:22 CEST 2017
lvm2-cluster-2.02.175-2.el7    BUILT: Fri Oct 13 13:31:22 CEST 2017
device-mapper-1.02.144-2.el7    BUILT: Fri Oct 13 13:31:22 CEST 2017
device-mapper-libs-1.02.144-2.el7    BUILT: Fri Oct 13 13:31:22 CEST 2017
device-mapper-event-1.02.144-2.el7    BUILT: Fri Oct 13 13:31:22 CEST 2017
device-mapper-event-libs-1.02.144-2.el7    BUILT: Fri Oct 13 13:31:22 CEST 2017
device-mapper-persistent-data-0.7.0-0.1.rc6.el7    BUILT: Mon Mar 27 17:15:46 CEST 2017



[root@host-079 ~]# man lvmthin | grep -n fsck
296:       If thin pool metadata is damaged, it may be repairable.  Checking and repairing thin pool metadata is analagous to running fsck/repair on a file system.


Examples from comment #0
If thin pool metadata is damaged, it may be repairable.  Checking and repairing thin pool metadata is analagous to running fsck/repair on a file system.
[...]
This can result in file system corruption for non-journaled file systems that may require repair. 
[...]
In the case of a file system, this can result in corruption that may require fs repair (the specific consequences depend on the thin LV user.)
[...]
4. Check and repair file system.

Comment 10 errata-xmlrpc 2018-04-10 15:20:44 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://access.redhat.com/errata/RHEA-2018:0853