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

[man pages] fix some formatting issues with the new man pages.

Browse Source
This commit is contained in:
Joe Thornber 2017-09-20 13:53:59 +01:00
parent dd8848f088
commit 5814fea96a
17 changed files with 64 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Makefile.in
View File

@ -255,13 +255,7 @@ TOOLS:=\
era_check \ era_check \
era_dump \ era_dump \
era_invalidate \ era_invalidate \
era_restore \ era_restore
ifeq ("@DEVTOOLS", "yes")
thin_show_duplicates \
thin_ll_dump \
thin_generate_metadata \
thin_scan
endif
MANPAGES:=$(patsubst %,man8/%.8,$(TOOLS)) MANPAGES:=$(patsubst %,man8/%.8,$(TOOLS))

2
man8/cache_check.txt
View File

@ -11,9 +11,9 @@ DESCRIPTION
This tool cannot be run on live metadata. This tool cannot be run on live metadata.
OPTIONS OPTIONS
-q, --quiet Suppress output messages, return only exit code.
-h, --help Print help and exit. -h, --help Print help and exit.
-V, --version Output version information and exit. -V, --version Output version information and exit.
-q, --quiet Suppress output messages, return only exit code.
--super-block-only Only check the superblock. --super-block-only Only check the superblock.
--skip-hints Skip checking of the policy hint values metadata. --skip-hints Skip checking of the policy hint values metadata.
--skip-discards Skip checking of the discard bits in the metadata. --skip-discards Skip checking of the discard bits in the metadata.

4
man8/cache_dump.txt
View File

@ -17,7 +17,7 @@ OPTIONS
-h, --help Print help and exit. -h, --help Print help and exit.
-V, --version Print version information and exit. -V, --version Print version information and exit.
-r, --repair Repair the metadata whilst dumping it. -r, --repair Repair the metadata whilst dumping it.
-o {xml file> Specify an output file for the xml, rather than printing to stdout. -o {xml file} Specify an output file for the xml, rather than printing to stdout.
EXAMPLES EXAMPLES
Dumps the cache metadata on logical volume /dev/vg/metadata to standard Dumps the cache metadata on logical volume /dev/vg/metadata to standard
@ -26,7 +26,7 @@ EXAMPLES
$ cache_dump /dev/vg/metadata $ cache_dump /dev/vg/metadata
Dumps the cache metadata on logical volume /dev/vg/metadata whilst repairing Dumps the cache metadata on logical volume /dev/vg/metadata whilst repairing
it to standard output in XML format: .sp it to standard output in XML format:
$ cache_dump --repair /dev/vg/metadata $ cache_dump --repair /dev/vg/metadata

1
man8/cache_metadata_size.txt
View File

@ -21,6 +21,7 @@ OPTIONS
EXAMPLE EXAMPLE
$ cache_metadata_size --nr-blocks 10240 $ cache_metadata_size --nr-blocks 10240
$ cache_metadata_size --block-size 128 --device-size 1024000 $ cache_metadata_size --block-size 128 --device-size 1024000
SEE ALSO SEE ALSO

2
man8/cache_restore.txt
View File

@ -30,7 +30,7 @@ DEBUGGING OPTIONS
--omit-clean-shutdown Don't set the clean shutdown flag. --omit-clean-shutdown Don't set the clean shutdown flag.
EXAMPLE EXAMPLE
Restores the XML formatted cache metadata on file .B metadata to logical Restores the XML formatted cache metadata on file metadata to logical
volume /dev/vg/metadata for further processing by the respective volume /dev/vg/metadata for further processing by the respective
device-mapper target: device-mapper target:

2
man8/era_restore.txt
View File

@ -6,7 +6,7 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
era_restore restores era metadata created by the respective device-mapper era_restore restores era metadata created by the respective device-mapper
target dumped into an XML formatted (see .BR era_dump(8)) file, which target dumped into an XML formatted (see era_dump(8)) file, which
optionally can be preprocessed before the restore to another device or optionally can be preprocessed before the restore to another device or
file. If restored to a metadata device, the metadata can be processed by file. If restored to a metadata device, the metadata can be processed by
the device-mapper target. the device-mapper target.

2
man8/thin_dump.txt
View File

@ -62,7 +62,7 @@ DIAGNOSTICS
thin_dump returns an exit code of 0 for success or 1 for error. thin_dump returns an exit code of 0 for success or 1 for error.
SEE ALSO SEE ALSO
thin_check(8) .B thin_repair(8) .B thin_restore(8) .B thin_rmap(8) .B thin_metadata_size(8) thin_check(8), thin_repair(8), thin_restore(8), thin_rmap(8), thin_metadata_size(8)
AUTHOR AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com> Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com>