emo
/
thin-provisioning-tools
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update man pages to forbid running on live metadata

This commit is contained in:
Joe Thornber 2015-08-13 13:39:20 +01:00
parent 8fab56680c
commit 32e92ce897
14 changed files with 31 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
man8/cache_check.8
View File

@ -15,6 +15,8 @@ the device-mapper cache target on a
or
.I file.
This tool cannot be run on live metadata.
.SH OPTIONS
.IP "\fB\-q, \-\-quiet\fP"
Suppress output messages, return only exit code.

2
man8/cache_dump.8
View File

@ -23,6 +23,8 @@ in order to put it back onto a metadata
(to process by the device-mapper target) or
.I file.
This tool cannot be run on live metadata.
.IP "\fB\-r, \-\-repair\fP".
Repair the metadata whilst dumping it.

2
man8/cache_repair.8
View File

@ -26,6 +26,8 @@ If written to a metadata
, the metadata can be processed
by the device-mapper target.
This tool cannot be run on live metadata.
.IP "\fB\-i, \-\-input\fP \fI{device|file}\fP"
Input file or device with binary metadata.

2
man8/cache_restore.8
View File

@ -24,6 +24,8 @@ If restored to a metadata
.I device
, the metadata can be processed by the device-mapper target.
This tool cannot be run on live metadata.
.IP "\fB\-i, \-\-input\fP \fI{device|file}\fP"
Input file or device with metadata.

2
man8/era_check.8
View File

@ -15,6 +15,8 @@ the device-mapper era target on a
or
.I file.
This tool cannot be run on live metadata.
.SH OPTIONS
.IP "\fB\-q, \-\-quiet\fP"
Suppress output messages, return only exit code.

2
man8/era_dump.8
View File

@ -23,6 +23,8 @@ in order to put it back onto a metadata
(to process by the device-mapper target) or
.I file.
This tool cannot be run on live metadata.
.IP "\fB\-r, \-\-repair\fP".
Repair the metadata whilst dumping it.

2
man8/era_invalidate.8
View File

@ -11,6 +11,8 @@ era_invalidate \- Provide a list of blocks that have changed since a particular
.B era_invalidate
Examines era metadata and lists blocks that may have changed since a given era.
This tool cannot be run on live metadata.
.SH OPTIONS
.IP "\fB\-h, \-\-help\fP"
Print help and exit.

2
man8/thin_check.8
View File

@ -15,6 +15,8 @@ the device-mapper thin provisioning target on a
or
.I file.
This tool cannot be run on live metadata.
.SH OPTIONS
.IP "\fB\-q, \-\-quiet\fP"
Suppress output messages, return only exit code.

3
man8/thin_delta.8
View File

@ -10,7 +10,8 @@ thin_delta \- Print the differences in the mappings between two thin devices.
.SH DESCRIPTION
.B thin_delta
allows you to compare the mappings in two thin volumes (snapshots allow common blocks between thin volumes).
.
This tool cannot be run on live metadata unless the \fB\-\-metadata\-snap\fP option is used.
.SH OPTIONS
.IP "\fB\-\-thin1, \-\-snap1\fP"

4
man8/thin_dump.8
View File

@ -24,13 +24,15 @@ in order to put it back onto a metadata
(to process by the device-mapper target) or
.I file.
This tool cannot be run on live metadata unless the \fB\-\-metadata\-snap\fP option is used.
.IP "\fB\-f, \-\-format\fP \fI{xml|human_readable}\fP".
Print output in XML or human readable format.
.IP "\fB\-r, \-\-repair\fP".
Repair the metadata whilst dumping it.
.IP "\fB\-m, \-\-metadata_snap\fP [block#]".
.IP "\fB\-m, \-\-metadata\-snap\fP [block#]".
Dump metadata snapshot created by device-mapper thin provisioning target.
If block is not provided, access the default metadata snapshot created by
the thin provisioning device-mapper target, else try the one at block#.

2
man8/thin_repair.8
View File

@ -26,6 +26,8 @@ If written to a metadata
, the metadata can be processed
by the device-mapper target.
This tool cannot be run on live metadata.
.IP "\fB\-i, \-\-input\fP \fI{device|file}\fP"
Input file or device with binary metadata.

2
man8/thin_restore.8
View File

@ -24,6 +24,8 @@ If restored to a metadata
.I device
, the metadata can be processed by the device-mapper target.
This tool cannot be run on live metadata.
.IP "\fB\-q, \-\-quiet\fP"
Suppress output messages, return only exit code.

4
man8/thin_rmap.8
View File

@ -16,6 +16,8 @@ or
between a region of thin provisioned pool blocks
and the associated thin provisioned devices.
This tool cannot be run on live metadata.
.IP "\fB\\-\-region\fP \fI<block range>\fP".
output reverse map
@ -29,7 +31,7 @@ Output version information and exit.
output reverse map for pool blocks 5..45 (denotes blocks 5 to 44 inclusive, but not block 45)
.sp
.B thin_rmap --region 5..45 /dev/vg/pool
.B thin_rmap --region 5..45 /dev/pool-metadata
.SH DIAGNOSTICS
.B thin_rmap

6
man8/thin_trim.8
View File

@ -9,9 +9,9 @@ thin_trim \- Issue discard requests for free pool space (offline tool).
.SH DESCRIPTION
.B thin_trim
sends discard requests to the pool device for unprovisioned areas. It is an offline tool,
.B do not run it while the pool is active
.
sends discard requests to the pool device for unprovisioned areas.
This tool cannot be run on live metadata.
.SH OPTIONS
.IP "\fB\-\-pool-inactive\fP"