man: typography

With to use .TP where it's easy and doesn't change layout
(since .HP is marked as deprecated) - but .TP is not always perfetc match.

Avoid submitting empty lines to troff and replace them mostly with .P
and use '.' at line start to preserve 'visual' presence of empty line
while editing man page manually when there is no extra space needed.

Fix some markup.

Add some missing SEE ALSO section.

Drop some white-space at end-of-lines.

Improve hyphenation logic so we do not split options.

Use '.IP numbers' only with first one the row (others in row
automatically derive this value)

Use automatic enumeration for .SH titles.

Guidelines in-use:
https://man7.org/linux/man-pages/man7/groff.7.html
https://www.gnu.org/software/groff/manual/html_node/Man-usage.html
https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html

1 files changed, 25 insertions, 29 deletions

diff --git a/man/lvm.8_main b/man/lvm.8_main
index b221761e3..44961f7cf 100644
--- a/man/lvm.8_main
+++ b/man/lvm.8_main
@@ -11,7 +11,6 @@ lvm \(em LVM2 tools
 .
 .SH DESCRIPTION
 .
-
 The Logical Volume Manager (LVM) provides tools to create virtual block
 devices from physical devices.  Virtual devices may be easier to manage
 than physical devices, and can have capabilities beyond what the physical
@@ -22,7 +21,6 @@ applications.  Each block of data in an LV is stored on one or more PV in
 the VG, according to algorithms implemented by Device Mapper (DM) in the
 kernel.
 .P
-
 The lvm command, and other commands listed below, are the command-line
 tools for LVM.  A separate manual page describes each command in detail.
 .P
@@ -40,7 +38,7 @@ On invocation, \fBlvm\fP requires that only the standard file descriptors
 stdin, stdout and stderr are available.  If others are found, they
 get closed and messages are issued warning about the leak.
 This warning can be suppressed by setting the environment variable
-.B LVM_SUPPRESS_FD_WARNINGS\fP.
+.BR LVM_SUPPRESS_FD_WARNINGS .
 .P
 Where commands take VG or LV names as arguments, the full path name is
 optional.  An LV called "lvol0" in a VG called "vg0" can be specified
@@ -67,7 +65,7 @@ The following commands are built into lvm without links
 normally being created in the filesystem for them.
 .sp
 .PD 0
-.TP 14
+.TP 16
 .B config
 The same as \fBlvmconfig\fP(8) below.
 .TP
@@ -112,7 +110,7 @@ Display version information.
 The following commands implement the core LVM functionality.
 .sp
 .PD 0
-.TP 14
+.TP 16
 .B pvchange
 Change attributes of a Physical Volume.
 .TP
@@ -296,19 +294,18 @@ original VG, LV and internal layer names.
 .
 .SH UNIQUE NAMES
 .
-
 VG names should be unique.  vgcreate will produce an error if the
 specified VG name matches an existing VG name.  However, there are cases
 where different VGs with the same name can appear to LVM, e.g. after
 moving disks or changing filters.
-
+.P
 When VGs with the same name exist, commands operating on all VGs will
 include all of the VGs with the same name.  If the ambiguous VG name is
 specified on the command line, the command will produce an error.  The
 error states that multiple VGs exist with the specified name.  To process
 one of the VGs specifically, the --select option should be used with the
-UUID of the intended VG: '--select vg_uuid=<uuid>'.
-
+UUID of the intended VG: --select vg_uuid=<uuid>
+.P
 An exception is if all but one of the VGs with the shared name is foreign
 (see
 .BR lvmsystemid (7).)
@@ -317,18 +314,17 @@ VG and is processed.
 .P
 LV names are unique within a VG.  The name of an historical LV cannot be
 reused until the historical LV has itself been removed or renamed.
-
 .
 .SH ALLOCATION
 .
 When an operation needs to allocate Physical Extents for one or more
 Logical Volumes, the tools proceed as follows:
-
+.P
 First of all, they generate the complete set of unallocated Physical Extents
 in the Volume Group.  If any ranges of Physical Extents are supplied at
 the end of the command line, only unallocated Physical Extents within
 those ranges on the specified Physical Volumes are considered.
-
+.P
 Then they try each allocation policy in turn, starting with the strictest
 policy (\fBcontiguous\fP) and ending with the allocation policy specified
 using \fB--alloc\fP or set as the default for the particular Logical
@@ -337,14 +333,14 @@ lowest-numbered Logical Extent of the empty Logical Volume space that
 needs to be filled, they allocate as much space as possible according to
 the restrictions imposed by the policy.  If more space is needed,
 they move on to the next policy.
-
+.P
 The restrictions are as follows:
-
+.P
 \fBContiguous\fP requires that the physical location of any Logical
 Extent that is not the first Logical Extent of a Logical Volume is
 adjacent to the physical location of the Logical Extent immediately
 preceding it.
-
+.P
 \fBCling\fP requires that the Physical Volume used for any Logical
 Extent to be added to an existing Logical Volume is already in use by at
 least one Logical Extent earlier in that Logical Volume.  If the
@@ -353,31 +349,31 @@ Physical Volumes are considered to match if any of the listed tags is
 present on both Physical Volumes.  This allows groups of Physical
 Volumes with similar properties (such as their physical location) to be
 tagged and treated as equivalent for allocation purposes.
-
+.P
 When a Logical Volume is striped or mirrored, the above restrictions are
 applied independently to each stripe or mirror image (leg) that needs
 space.
-
+.P
 \fBNormal\fP will not choose a Physical Extent that shares the same Physical
 Volume as a Logical Extent already allocated to a parallel Logical
 Volume (i.e. a different stripe or mirror image/leg) at the same offset
 within that parallel Logical Volume.
-
+.P
 When allocating a mirror log at the same time as Logical Volumes to hold
 the mirror data, Normal will first try to select different Physical
 Volumes for the log and the data.  If that's not possible and the
 .B allocation/mirror_logs_require_separate_pvs
 configuration parameter is set to 0, it will then allow the log
 to share Physical Volume(s) with part of the data.
-
+.P
 When allocating thin pool metadata, similar considerations to those of a
 mirror log in the last paragraph apply based on the value of the
 .B allocation/thin_pool_metadata_require_separate_pvs
 configuration parameter.
-
+.P
 If you rely upon any layout behaviour beyond that documented here, be
 aware that it might change in future versions of the code.
-
+.P
 For example, if you supply on the command line two empty Physical
 Volumes that have an identical number of free Physical Extents available for
 allocation, the current code considers using each of them in the order
@@ -387,7 +383,7 @@ for a particular Logical Volume, then you should build it up through a
 sequence of \fBlvcreate\fP(8) and \fBlvconvert\fP(8) steps such that the
 restrictions described above applied to each step leave the tools no
 discretion over the layout.
-
+.P
 To view the way the allocation process currently works in any specific
 case, read the debug logging output, for example by adding \fB-vvvv\fP to
 a command.
@@ -501,7 +497,7 @@ Prepends source file name and code line number with libdm debugging.
 .BR lvm (8),
 .BR lvm.conf (5),
 .BR lvmconfig (8),
-
+.P
 .BR pvchange (8),
 .BR pvck (8),
 .BR pvcreate (8),
@@ -511,7 +507,7 @@ Prepends source file name and code line number with libdm debugging.
 .BR pvresize (8),
 .BR pvs (8),
 .BR pvscan (8),
-
+.P
 .BR vgcfgbackup (8),
 .BR vgcfgrestore (8),
 .BR vgchange (8),
@@ -531,7 +527,7 @@ Prepends source file name and code line number with libdm debugging.
 .BR vgs (8),
 .BR vgscan (8),
 .BR vgsplit (8),
-
+.P
 .BR lvcreate (8),
 .BR lvchange (8),
 .BR lvconvert (8),
@@ -543,26 +539,26 @@ Prepends source file name and code line number with libdm debugging.
 .BR lvresize (8),
 .BR lvs (8),
 .BR lvscan (8),
-
+.P
 .BR lvm-fullreport (8),
 .BR lvm-lvpoll (8),
 .BR lvm2-activation-generator (8),
 .BR blkdeactivate (8),
 .BR lvmdump (8),
-
+.P
 .BR dmeventd (8),
 .BR lvmpolld (8),
 .BR lvmlockd (8),
 .BR lvmlockctl (8),
 .BR cmirrord (8),
 .BR lvmdbusd (8),
-
+.P
 .BR lvmsystemid (7),
 .BR lvmreport (7),
 .BR lvmraid (7),
 .BR lvmthin (7),
 .BR lvmcache (7),
-
+.P
 .BR dmsetup (8),
 .BR dmstats (8),
 .BR readline (3)