Bug#693082: dmsetup.8: Warnings from "groff": Some formatting corrections for the manual
Bjarni Ingi Gislason
bjarniig at rhi.hi.is
Mon Nov 12 21:06:17 UTC 2012
Package: dmsetup
Version: 2:1.02.39-1ubuntu4.1
Severity: minor
Tags: patch
Warnings from "GROFF_ENCODING=utf8 groff -b -ww -mandoc -z ..."
groff: dmsetup.8: /usr/share/groff/1.20.1/tmac/an-old.tmac:478: backtrace
groff: dmsetup.8: /usr/share/groff/1.20.1/tmac/an-old.tmac:395: backtrace: macro `TP'
groff: dmsetup.8: /usr/share/groff/1.20.1/tmac/an-old.tmac:478: backtrace: macro `IP'
<groff: dmsetup.8>:197: warning: numeric expression expected (got `c')
Changed some hyphens to minus (dash)
Protected some full stops (.) and single quotes (apostrophe) (') with "\&"
Removed space at end of line
One spelling correction (ouput)
#
Output from "nroff" should (usually) have only the left margin
adjusted (".ad l"). Otherwise the space between words can be too long.
Output for a manual should (usually) have the right margin ragged
(".ad l"), as it is not (usually) intended for a book or other
professional printing medium.
#
Each sentence should begin in a new line.
a) The space between sentences is different between formatters.
b) Changes in one line do then not affect others, and do therefore not
appear as changed in the output of "diff".
#
Sometimes a small change in space between a roman and an italic
character is needed (use ".RI" or ".IR" macros).
#
Remove spaces at end of lines.
#
Protect the last full stop (period) in abbreviations or ellipses
(with \&) if it is not at the end of a sentence.
#
Protect the full stop (period) at the beginning of text (word) or
ellipsis.
#
Protect a single quote (', apostrophe) (with \&) at the start of the
quoted text.
##
-- System Information:
Debian Release: squeeze/sid
APT prefers lucid-updates
APT policy: (500, 'lucid-updates'), (500, 'lucid-security'), (500, 'lucid')
Architecture: amd64 (x86_64)
Kernel: Linux 2.6.35-25-generic (SMP w/4 CPU cores)
Locale: LANG=is_IS.ISO-8859-1, LC_CTYPE=is_IS.ISO-8859-1 (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Versions of packages dmsetup depends on:
ii initramfs-tools 0.92bubuntu78 tools for generating an initramfs
ii libc6 2.11.1-0ubuntu7.11 Embedded GNU C Library: Shared lib
ii libdevmapper1.02 2:1.02.39-1ubuntu4.1 The Linux Kernel Device Mapper use
ii udev 151-12.3 rule-based device node and kernel
ii util-linux 2.17.2-0ubuntu1.10.04.2 Miscellaneous system utilities
dmsetup recommends no packages.
dmsetup suggests no packages.
-- no debconf information
Patch is in the attachment
--
Bjarni I. Gislason
-------------- next part --------------
--- dmsetup.8 2012-11-12 20:32:52.283663520 +0000
+++ dmsetup.8.new 2012-11-12 20:52:51.983995652 +0000
@@ -4,31 +4,31 @@
.SH SYNOPSIS
.ad l
.B dmsetup help
-.I [-c|-C|--columns]
+.I [\-c|\-C|\-\-columns]
.br
-.B dmsetup create
-.I device_name [-u uuid] [--notable | --table <table> | table_file]
+.B dmsetup create
+.I device_name [\-u uuid] [\-\-notable | \-\-table <table> | table_file]
.br
.B dmsetup remove
-.I [-f|--force] device_name
+.I [\-f|\-\-force] device_name
.br
.B dmsetup remove_all
-.I [-f|--force]
+.I [\-f|\-\-force]
.br
.B dmsetup suspend
-.I [--nolockfs] [--noflush] device_name
+.I [\-\-nolockfs] [\-\-noflush] device_name
.br
.B dmsetup resume
.I device_name
.br
.B dmsetup load
-.I device_name [--table <table> | table_file]
+.I device_name [\-\-table <table> | table_file]
.br
.B dmsetup clear
.I device_name
.br
.B dmsetup reload
-.I device_name [--table <table> | table_file]
+.I device_name [\-\-table <table> | table_file]
.br
.B dmsetup rename
.I device_name new_name
@@ -37,24 +37,24 @@
.I device_name sector message
.br
.B dmsetup ls
-.I [--target target_type] [--exec command] [--tree [-o options]]
+.I [\-\-target target_type] [\-\-exec command] [\-\-tree [-o options]]
.br
-.B dmsetup info
+.B dmsetup info
.I [device_name]
.br
-.B dmsetup info -c|-C|--columns
-.I [--noheadings] [--separator separator] [-o fields] [-O|--sort sort_fields]
+.B dmsetup info \-c|\-C|\-\-columns
+.I [\-\-noheadings] [\-\-separator separator] [\-o fields] [\-O|\-\-sort sort_fields]
.I [device_name]
.br
.B dmsetup deps
.I [device_name]
.br
.B dmsetup status
-.I [--target target_type]
+.I [\-\-target target_type]
.I [device_name]
.br
.B dmsetup table
-.I [--target target_type]
+.I [\-\-target target_type]
.I [device_name]
.br
.B dmsetup wait
@@ -89,82 +89,82 @@
.B devmap_name
.I major minor
.br
-.B devmap_name
+.B devmap_name
.I major:minor
.ad b
.SH DESCRIPTION
-dmsetup manages logical devices that use the device-mapper driver.
+dmsetup manages logical devices that use the device-mapper driver.
Devices are created by loading a table that specifies a target for
each sector (512 bytes) in the logical device.
-The first argument to dmsetup is a command.
+The first argument to dmsetup is a command.
The second argument is the logical device name or uuid.
Invoking the command as \fBdevmap_name\fP is equivalent to
.br
-\fBdmsetup info -c --noheadings -j \fImajor\fB -m \fIminor\fP.
+\fBdmsetup info \-c \-\-noheadings \-j \fImajor\fB \-m \fIminor\fP.
.SH OPTIONS
-.IP \fB-c|-C|--columns
+.IP \fB\-c|\-C|\-\-columns
.br
Display output in columns rather than as Field: Value lines.
-.IP \fB-j|--major\ \fImajor
+.IP \fB\-j|\-\-major\ \fImajor
.br
Specify the major number.
-.IP \fB-m|--minor\ \fIminor
+.IP \fB\-m|\-\-minor\ \fIminor
.br
Specify the minor number.
-.IP \fB-n|--noheadings
+.IP \fB\-n|\-\-noheadings
.br
Suppress the headings line when using columnar output.
-.IP \fB--noopencount
+.IP \fB\-\-noopencount
.br
Tell the kernel not to supply the open reference count for the device.
-.IP \fB--notable
+.IP \fB\-\-notable
.br
When creating a device, don't load any table.
-.IP \fB--noudevsync
+.IP \fB\-\-noudevsync
Do not synchronise with udev when creating, renaming or removing devices.
.br
-.IP \fB-o|--options
+.IP \fB\-o|\-\-options
.br
Specify which fields to display.
-.IP \fB-r|--readonly
+.IP \fB\-r|\-\-readonly
.br
Set the table being loaded read-only.
-.IP \fB--readahead\ [+]<sectors>|auto|none
-.br
+.IP \fB\-\-readahead\ [+]<sectors>|auto|none
+.br
Specify read ahead size in units of sectors.
The default value is "auto" which allows the kernel to choose
a suitable value automatically. The + prefix lets you
specify a minimum value which will not be used if it is
smaller than the value chosen by the kernel.
"None" is equivalent to specifying zero.
-.IP \fB--table\ <table>
+.IP \fB\-\-table\ <table>
.br
Specify a one-line table directly on the command line.
-.IP \fB-u|--uuid
+.IP \fB\-u|\-\-uuid
.br
Specify the uuid.
-.IP \fB-y|--yes
+.IP \fB\-y|\-\-yes
.br
Answer yes to all prompts automatically.
-.IP \fB-v|--verbose\ [-v|--verbose]
+.IP \fB\-v|\-\-verbose\ [\-v|\-\-verbose]
.br
Produce additional output.
-.IP \fB--version
+.IP \fB\-\-version
.br
Display the library and kernel driver version.
.SH COMMANDS
.IP \fBcreate
-.I device_name [-u uuid] [--notable | --table <table> | table_file]
+.I device_name [\-u uuid] [\-\-notable | \-\-table <table> | table_file]
.br
Creates a device with the given name.
If table_file or <table> is supplied, the table is loaded and made live.
-Otherwise a table is read from standard input unless --notable is used.
+Otherwise a table is read from standard input unless \-\-notable is used.
The optional uuid can be used in place of
-device_name in subsequent dmsetup commands.
+device_name in subsequent dmsetup commands.
If successful a device will appear as
-/dev/device-mapper/<device-name>.
+/dev/device-mapper/<device-name>.
See below for information on the table format.
.IP \fBdeps
.I [device_name]
@@ -172,7 +172,7 @@
Outputs a list of (major, minor) pairs for devices referenced by the
live table for the specified device.
.IP \fBhelp
-.I [-c|-C|--columns]
+.I [\-c|\-C|\-\-columns]
.br
Outputs a summary of the commands available, optionally including
the list of report fields.
@@ -194,33 +194,33 @@
Number of targets in the live table
.br
UUID
-.IP \fBinfo -c|-C|--columns
-.I [--noheadings] [--separator separator] [-o fields] [-O|--sort sort_fields]
+.IP "\fBinfo \-c|\-C|\-\-columns"
+.I [\-\-noheadings] [\-\-separator separator] [\-o fields] [\-O|\-\-sort sort_fields]
.I [device_name]
.br
Output you can customise.
Fields are comma-separated and chosen from the following list:
name, major, minor, attr, open, segments, events, uuid.
Attributes are: (L)ive, (I)nactive, (s)uspended, (r)ead-only, read-(w)rite.
-Precede the list with '+' to append
+Precede the list with \&'+' to append
to the default selection of columns instead of replacing it.
-Precede any sort_field with - for a reverse sort on that column.
+Precede any sort_field with \- for a reverse sort on that column.
.IP \fBls
-.I [--target target_type]
-.I [--exec command]
-.I [--tree [-o options]]
+.I [\-\-target target_type]
+.I [\-\-exec command]
+.I [\-\-tree [-o options]]
.br
List device names. Optionally only list devices that have at least
one target of the specified type. Optionally execute a command for
each device. The device name is appended to the supplied command.
---tree displays dependencies between devices as a tree.
+\-\-tree displays dependencies between devices as a tree.
It accepts a comma-separate list of options.
Some specify the information displayed against each node:
device/nodevice; active, open, rw, uuid.
Others specify how the tree is displayed:
ascii, utf, vt100; compact, inverted, notrunc.
.IP \fBload|reload
-.I device_name [--table <table> | table_file]
+.I device_name [\-\-table <table> | table_file]
.br
Loads <table> or table_file into the inactive table slot for device_name.
If neither is supplied, reads a table from standard input.
@@ -232,29 +232,29 @@
.I [device_name]
.br
Ensure that the node in /dev/mapper for device_name is correct.
-If no device_name is supplied, ensure that all nodes in /dev/mapper
+If no device_name is supplied, ensure that all nodes in /dev/mapper
correspond to mapped devices currently loaded by the device-mapper kernel
driver, adding, changing or removing nodes as necessary.
.IP \fBremove
-.I [-f|--force] device_name
+.I [\-f|\-\-force] device_name
.br
Removes a device. It will no longer be visible to dmsetup.
Open devices cannot be removed except with older kernels
that contain a version of device-mapper prior to 4.8.0.
-In this case the device will be deleted when its open_count
+In this case the device will be deleted when its open_count
drops to zero. From version 4.8.0 onwards, if a device can't
be removed because an uninterruptible process is waiting for
-I/O to return from it, adding --force will replace the table
-with one that fails all I/O, which might allow the
+I/O to return from it, adding \-\-force will replace the table
+with one that fails all I/O, which might allow the
process to be killed.
.IP \fBremove_all
-.I [-f|--force]
+.I [\-f|\-\-force]
.br
-Attempts to remove all device definitions i.e. reset the driver.
+Attempts to remove all device definitions i.e.\& reset the driver.
Use with care! From version 4.8.0 onwards, if devices can't
be removed because uninterruptible processes are waiting for
-I/O to return from them, adding --force will replace the table
-with one that fails all I/O, which might allow the
+I/O to return from them, adding \-\-force will replace the table
+with one that fails all I/O, which might allow the
process to be killed. This also runs \fBmknodes\fP afterwards.
.IP \fBrename
.I device_name new_name
@@ -263,7 +263,7 @@
.IP \fBresume
.I device_name
.br
-Un-suspends a device.
+Un-suspends a device.
If an inactive table has been loaded, it becomes live.
Postponed I/O then gets re-queued for processing.
.IP \fBsetgeometry
@@ -277,31 +277,31 @@
Splits given device name into subsystem constituents.
Default subsystem is LVM.
.IP \fBstatus
-.I [--target target_type]
+.I [\-\-target target_type]
.I [device_name]
.br
Outputs status information for each of the device's targets.
-With --target, only information relating to the specified target type
+With \-\-target, only information relating to the specified target type
is displayed.
.IP \fBsuspend
-.I [--nolockfs] [--noflush]
+.I [\-\-nolockfs] [\-\-noflush]
.I device_name
.br
Suspends a device. Any I/O that has already been mapped by the device
but has not yet completed will be flushed. Any further I/O to that
device will be postponed for as long as the device is suspended.
-If there's a filesystem on the device which supports the operation,
-an attempt will be made to sync it first unless --nolockfs is specified.
+If there's a filesystem on the device which supports the operation,
+an attempt will be made to sync it first unless \-\-nolockfs is specified.
Some targets such as recent (October 2006) versions of multipath may support
-the --noflush option. This lets outstanding I/O that has not yet reached the
+the \-\-noflush option. This lets outstanding I/O that has not yet reached the
device to remain unflushed.
.IP \fBtable
-.I [--target target_type]
+.I [\-\-target target_type]
.I [device_name]
.br
Outputs the current table for the device in a format that can be fed
back in using the create or load commands.
-With --target, only information relating to the specified target type
+With \-\-target, only information relating to the specified target type
is displayed.
.IP \fBtargets
.br
@@ -312,7 +312,7 @@
.br
Parses given cookie value and extracts any udev control flags encoded.
The output is in environment key format that is suitable for use in udev
-rules. If the flag has its symbolic name assigned then the ouput is
+rules. If the flag has its symbolic name assigned then the output is
DM_UDEV_FLAG_<flag_name>='1', DM_UDEV_FLAG<flag_position>='1' otherwise.
Subsystem udev flags don't have symbolic names assigned and these ones are
always reported as DM_SUBSYSTEM_UDEV_FLAG<flag_position>='1'. There are
@@ -338,9 +338,9 @@
.I [event_nr]
.br
Sleeps until the event counter for device_name exceeds event_nr.
-Use -v to see the event number returned.
+Use \-v to see the event number returned.
To wait until the next event is triggered, use \fBinfo\fP to find
-the last event number.
+the last event number.
.SH TABLE FORMAT
Each line of the table specifies a single target and is of the form:
.br
@@ -348,7 +348,7 @@
.br
.br
-There are currently three simple target types available together
+There are currently three simple target types available together
with more complex optional ones that implement snapshots and mirrors.
.IP \fBlinear
@@ -361,7 +361,7 @@
.br
Creates a striped area.
.br
-e.g. striped 2 32 /dev/hda1 0 /dev/hdb1 0
+e.g.\& striped 2 32 /dev/hda1 0 /dev/hdb1 0
will map the first chunk (16k) as follows:
.br
LV chunk 1 -> hda1, chunk 1
@@ -389,7 +389,7 @@
1028160 3903762 linear /dev/hdb 0
-# A table to stripe across the two disks,
+# A table to stripe across the two disks,
.br
# and add the spare space from
.br
More information about the pkg-lvm-maintainers
mailing list