mrc0mmand / rpms / lvm2

Forked from rpms/lvm2 2 years ago
Clone

Blame SOURCES/lvm2-2_02_106-various-man-page-cleanups.patch

4c7ee1
 man/lvchange.8.in  |  6 +++---
4c7ee1
 man/lvconvert.8.in | 36 +++++++++++++++++++++++-------------
4c7ee1
 man/lvcreate.8.in  |  8 ++++----
4c7ee1
 man/lvmetad.8.in   | 11 ++++-------
4c7ee1
 4 files changed, 34 insertions(+), 27 deletions(-)
4c7ee1
4c7ee1
diff --git a/man/lvchange.8.in b/man/lvchange.8.in
4c7ee1
index 64231c8..5de75e0 100644
4c7ee1
--- a/man/lvchange.8.in
4c7ee1
+++ b/man/lvchange.8.in
4c7ee1
@@ -41,7 +41,7 @@ lvchange \- change attributes of a logical volume
4c7ee1
 .RB [ \-\-[raid]writebehind
4c7ee1
 .IR IOCount ]
4c7ee1
 .RB [ \-\-[raid]writemostly
4c7ee1
-.IR PhysicalVolume[:{t|n|y}] ]
4c7ee1
+.IR PhysicalVolume [ : { t | n | y }]]
4c7ee1
 .RB [ \-\-sysinit ]
4c7ee1
 .RB [ \-\-noudevsync ]
4c7ee1
 .RB [ \-M | \-\-persistent
4c7ee1
@@ -166,7 +166,7 @@ If \fIrepair\fP is used, the discrepancies will be corrected as they are
4c7ee1
 encountered.  The 'lvs' command can be used to show the number of
4c7ee1
 discrepancies found or repaired.
4c7ee1
 .TP
4c7ee1
-.BR \-\-[raid]writebehind " IOCount"
4c7ee1
+.BR \-\-[raid]writebehind " " \fIIOCount
4c7ee1
 Specify the maximum number of outstanding writes that are allowed to
4c7ee1
 devices in a RAID1 logical volume that are marked as \fIwrite-mostly\fP.
4c7ee1
 Once this value is exceeded, writes become synchronous (i.e. all writes
4c7ee1
@@ -174,7 +174,7 @@ to the constituent devices must complete before the array signals the
4c7ee1
 write has completed).  Setting the value to zero clears the preference
4c7ee1
 and allows the system to choose the value arbitrarily.
4c7ee1
 .TP
4c7ee1
-.BR \-\-[raid]writemostly " PhysicalVolume[:{t|y|n}]"
4c7ee1
+.IR \fB\-\-[raid]writemostly " " PhysicalVolume [ : { t | y | n }]
4c7ee1
 Mark a device in a RAID1 logical volume as \fIwrite-mostly\fP.  All reads
4c7ee1
 to these drives will be avoided unless absolutely necessary.  This keeps
4c7ee1
 the number of I/Os to the drive to a minimum.  The default behavior is to
4c7ee1
diff --git a/man/lvconvert.8.in b/man/lvconvert.8.in
4c7ee1
index 190e221..fe6525b 100644
4c7ee1
--- a/man/lvconvert.8.in
4c7ee1
+++ b/man/lvconvert.8.in
4c7ee1
@@ -91,11 +91,11 @@ lvconvert \- convert a logical volume from linear to mirror or snapshot
4c7ee1
 .IR ChunkSize [ bBsSkKmMgG ]]
4c7ee1
 .RB [ \-\-discards
4c7ee1
 .RI { ignore | nopassdown | passdown }]
4c7ee1
-.RB [[ \-\-poolmetadata
4c7ee1
-.IR ThinPoolMetadataLogicalVolume { Name | Path }]
4c7ee1
+.RB [{ \-\-poolmetadata
4c7ee1
+.IR ThinPoolMetadataLogicalVolume { Name | Path }
4c7ee1
 |
4c7ee1
-.RB [ \-\-poolmetadatasize
4c7ee1
-.IR ThinPoolMetadataSize [ bBsSkKmMgG ]]
4c7ee1
+.B \-\-poolmetadatasize
4c7ee1
+.IR ThinPoolMetadataSize [ bBsSkKmMgG ]}]
4c7ee1
 .RB [ \-r | \-\-readahead
4c7ee1
 .RI { ReadAheadSectors | auto | none }]
4c7ee1
 .RB [ \-\-stripes
4c7ee1
@@ -113,24 +113,24 @@ lvconvert \- convert a logical volume from linear to mirror or snapshot
4c7ee1
 .RB [ \-v | \-\-verbose ]
4c7ee1
 .RB [ \-\-version ]
4c7ee1
 .sp
4c7ee1
-.B lvconvert \-\-type cache-pool
4c7ee1
+.B lvconvert \-\-type \fIcache-pool
4c7ee1
 .RB [ \-c | \-\-chunksize
4c7ee1
 .IR ChunkSize [ bBsSkKmMgG ]]
4c7ee1
 .RB [ \-\-cachemode
4c7ee1
 .RI { writeback | writethrough }]
4c7ee1
-.RB [[ \-\-poolmetadata
4c7ee1
-.IR CachePoolMetadataLogicalVolume { Name | Path }]
4c7ee1
+.RB [{ \-\-poolmetadata
4c7ee1
+.IR CachePoolMetadataLogicalVolume { Name | Path }
4c7ee1
 |
4c7ee1
-.RB [ \-\-poolmetadatasize
4c7ee1
-.IR CachePoolMetadataSize [ bBsSkKmMgG ]]
4c7ee1
+.B \-\-poolmetadatasize
4c7ee1
+.IR CachePoolMetadataSize [ bBsSkKmMgG ]}]
4c7ee1
 .IR LogicalVolume [ Path ]
4c7ee1
 .RI [ PhysicalVolume [ Path ][ :PE [ -PE ]]...]
4c7ee1
 .RB [ \-h | \-? | \-\-help ]
4c7ee1
 .RB [ \-v | \-\-verbose ]
4c7ee1
 .RB [ \-\-version ]
4c7ee1
 .sp
4c7ee1
-.B lvconvert \-\-type cache
4c7ee1
-.RB \-\-cachepool
4c7ee1
+.B lvconvert \-\-type \fIcache
4c7ee1
+.B \-\-cachepool
4c7ee1
 .IR CachePoolLV { Name | Path }
4c7ee1
 .IR LogicalVolume [ Path ]
4c7ee1
 .RB [ \-h | \-? | \-\-help ]
4c7ee1
@@ -333,14 +333,23 @@ a suitable value automatically.
4c7ee1
 "None" is equivalent to specifying zero.
4c7ee1
 .TP
4c7ee1
 .B \-\-repair
4c7ee1
-Repair a mirror after suffering a disk failure. The mirror will be brought back
4c7ee1
-into a consistent state.  By default, the original number of mirrors will be
4c7ee1
+Repair a mirror after suffering a disk failure or try to fix thin pool metadata.
4c7ee1
+
4c7ee1
+The mirror will be brought back into a consistent state.
4c7ee1
+By default, the original number of mirrors will be
4c7ee1
 restored if possible.  Specify \fB\-y\fP on the command line to skip
4c7ee1
 the prompts. Use \fB\-f\fP if you do not want any replacement.
4c7ee1
 Additionally, you may use \fB\-\-use\-policies\fP to use the device
4c7ee1
 replacement policy specified in \fBlvm.conf\fP(5),
4c7ee1
 viz. activation/mirror_log_fault_policy or
4c7ee1
 activation/mirror_device_fault_policy.
4c7ee1
+
4c7ee1
+Thin pool repair automates the use of \fBthin_repair\fP(8) tool.
4c7ee1
+Only inactive thin pool volumes can be repaired.
4c7ee1
+There is no validation of metadata between kernel and lvm2.
4c7ee1
+This requires further manual work.
4c7ee1
+After successfull repair the old unmodified metadata are still
4c7ee1
+available in \fB<pool>_tmeta<n>\fP LV.
4c7ee1
 .TP
4c7ee1
 .B \-\-replace \fIPhysicalVolume
4c7ee1
 Remove the specified device (\fIPhysicalVolume\fP) and replace it with one
4c7ee1
@@ -498,4 +507,5 @@ cache pool LV.
4c7ee1
 .BR lvscan (8),
4c7ee1
 .BR vgcreate (8),
4c7ee1
 .BR thin_dump (8),
4c7ee1
+.BR thin_repair (8)
4c7ee1
 .BR thin_restore (8)
4c7ee1
diff --git a/man/lvcreate.8.in b/man/lvcreate.8.in
4c7ee1
index 325baad..445af80 100644
4c7ee1
--- a/man/lvcreate.8.in
4c7ee1
+++ b/man/lvcreate.8.in
4c7ee1
@@ -60,7 +60,7 @@ lvcreate \- create a logical volume in an existing volume group
4c7ee1
 .RB [ \-t | \-\-test ]
4c7ee1
 .RB [ \-T | \-\-thin
4c7ee1
 .RB [ \-\-cachemode
4c7ee1
-.IR { writeback | writethrough }
4c7ee1
+.RI { writeback | writethrough }
4c7ee1
 .RB [ \-c | \-\-chunksize
4c7ee1
 .IR ChunkSize [ bBsSkKmMgG ]]
4c7ee1
 .RB [ \-\-discards
4c7ee1
@@ -145,7 +145,7 @@ be overridden. If the clustered locking is enabled,
4c7ee1
 .IR \fB\-a { a | l } y
4c7ee1
 will activate only on the local node.
4c7ee1
 .TP
4c7ee1
-.IR \fB\-k ", " \fB\-\-setactivationskip " " { y | n }
4c7ee1
+.IR \fB\-k ", " \fB\-\-setactivationskip "  {" y | n }
4c7ee1
 Controls whether Logical Volumes are persistently flagged to be skipped during
4c7ee1
 activation. By default, thin snapshot volumes are flagged for activation skip.
4c7ee1
 To activate such volumes, an extra \fB\-K/\-\-ignoreactivationskip\fP option must
4c7ee1
@@ -155,11 +155,11 @@ detach the flag for existing volumes. To see whether the flag is attached,
4c7ee1
 use \fBlvs\fP command where the state of the flag is reported within
4c7ee1
 \fBlv_attr\fP bits.
4c7ee1
 .TP
4c7ee1
-.IR \fB\-K ", " \fB\-\-ignoreactivationskip
4c7ee1
+.BR \-K ", " \-\-ignoreactivationskip
4c7ee1
 Ignore the flag to skip Logical Volumes during activation.
4c7ee1
 
4c7ee1
 .TP
4c7ee1
-.BR \-\-cachemode " " { writeback | writethrough }
4c7ee1
+.IR \fB\-\-cachemode " " { writeback | writethrough }
4c7ee1
 Specifying a cache mode determines when the writes to a cache LV
4c7ee1
 are considered complete.  When \fIwriteback\fP is specified, a write is
4c7ee1
 considered complete as soon as it is stored in the cache pool LV.
4c7ee1
diff --git a/man/lvmetad.8.in b/man/lvmetad.8.in
4c7ee1
index 4956a3f..444c7c0 100644
4c7ee1
--- a/man/lvmetad.8.in
4c7ee1
+++ b/man/lvmetad.8.in
4c7ee1
@@ -4,14 +4,11 @@ lvmetad \- LVM metadata cache daemon
4c7ee1
 .SH SYNOPSIS
4c7ee1
 .B lvmetad
4c7ee1
 .RB [ \-l
4c7ee1
-.RI {all|wire|debug}
4c7ee1
-.RB ]
4c7ee1
+.RI { all | wire | debug }]
4c7ee1
 .RB [ \-p
4c7ee1
-.RI pidfile_path
4c7ee1
-.RB ]
4c7ee1
+.IR pidfile_path ]
4c7ee1
 .RB [ \-s
4c7ee1
-.RI socket_path
4c7ee1
-.RB ]
4c7ee1
+.IR socket_path ]
4c7ee1
 .RB [ \-f ]
4c7ee1
 .RB [ \-h ]
4c7ee1
 .RB [ \-V ]
4c7ee1
@@ -34,7 +31,7 @@ Don't fork, but run in the foreground.
4c7ee1
 .BR \-h ", " \-?
4c7ee1
 Show help information.
4c7ee1
 .TP
4c7ee1
-.BR \-l " {" \fIall | \fIwire | \fIdebug }
4c7ee1
+.IR \fB\-l " {" all | wire | debug }
4c7ee1
 Select the type of log messages to generate.
4c7ee1
 Messages are logged by syslog.  
4c7ee1
 Additionally, when -f is given they are also sent to standard error.