Bug#586957: lvm2: miscellaneous improvements for the lvm(8) manpage
Christoph Anton Mitterer
calestyo at scientia.net
Wed Jun 23 22:47:49 UTC 2010
Package: lvm2
Version: 2.02.66-2
Severity: wishlist
Tags: patch
Hi.
Attached would be several patches, that (IMHO) improve the lvm(8) manpage:
1) lvm.8.empty_LV.patch
It seems that the current "Where a list of VGs is required but is left empty, a
list of all VGs will be substituted." is also true for LVs (checked it with
lvdisplay, which seems to lists all LVs).
If this is true, add the patch, to reflect this in the documentation
2) lvm.8.non-implemented-commands.patch
Aligned the "style" how in the two sections (built-in commands and commands)
unimplemented commands are documented. Just cosmetic of course.
I guess the current style of the commands section is better, built-in
commands list the unimplemented one just as the implemented commands.
Also removed pvdata from the list of unimplemented commands, as this seems
to be an unimplemented built-in command.
3) lvm.8.reordering+pvcreate.patch
It seems that right now, neither built-in commands nor commands are ordered
alphabetically.
The patch orders them in a (IMHO) better way, especially:
First VG-, then PV-, then LV-, then "general"-commands.
In each section I also made some grouping, e.g. commands that do display stuff,
create/remove/rename, resize/extend, etc.
Please check, that (when copy&pasting around) I did not accidentally drop one ;)
Another thing done by the patch: For pvcreate it's hinted (by "etc") that not
only disks and partitions can serve as PV. (e.g. md devices, or dm-crypt, etc.)
4) lvm.8.misc.patch
- Some (IMHO) typos,... please check whether I'm really correct everywhere
(especially the large->larger change).
- Also clarifies, that @ is only used
when referencing tags, not when setting them (i.e. that it's just part of the
string name).
- For the allowed characters in VG/LV names and tags, use the same ordering
in both places they're listed.
Two issues are open, which I do however not know:
1) Should we explicitly mention, that VG/LV names as well as tags are case-
sensitive (or is A-Z a-z) enough.
2) Regarding --alloc
"The cling policy places new extents on the same physical volume as existing
extents in the same stripe of the Logical Volume."
At least I do not understand this:
AFAIK: "For metadata in LVM2 format, the stripe size may be a larger power
of 2 but must not exceed the physical extent size."
So it's always that _one_ extent can be divided in one or more stripes, but
_not_ that _one_ stripe can have several extents, right?
But then I don't understand the cling policy description, which no longer makes
sense to me.
Cheers,
Chris.
-------------- next part --------------
--- lvm.8 2010-06-23 16:25:44.099108000 +0200
+++ lvm.8 2010-06-23 16:28:42.675357517 +0200
@@ -24,8 +24,8 @@
.LP
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
-as "vg0/lvol0". Where a list of VGs is required but is left empty,
-a list of all VGs will be substituted. Where a list of LVs is required
+as "vg0/lvol0". Where a list of VGs or LVs is required but left empty,
+a list of all VGs or LVs will be substituted. Where a list of LVs is required
but a VG is given, a list of all the LVs in that VG will be substituted.
So "lvdisplay vg0" will display all the LVs in "vg0".
Tags can also be used - see \fBaddtag\fP below.
-------------- next part --------------
--- lvm.8 2010-06-24 00:34:43.702027000 +0200
+++ 1 2010-06-24 00:36:10.377776836 +0200
@@ -175,7 +175,7 @@
If you set this to \fBn\fP, no attempt will be made to contact the driver.
.TP
\fB-A | --autobackup\fP { \fBy\fP | \fBn\fP }
-Whether or not to metadata should be backed up automatically after a change.
+Whether or not metadata should be backed up automatically after a change.
You are strongly advised not to disable this!
See
.B vgcfgbackup (8).
@@ -188,7 +188,7 @@
\fBdmsetup (8)\fP to set this up to return I/O errors when accessed,
or create it as a large block device of nulls. Metadata may not be
changed with this option. To insert a replacement physical volume
-of the same or large size use \fBpvcreate -u\fP to set the uuid to
+of the same or larger size use \fBpvcreate -u\fP to set the uuid to
match the original followed by \fBvgcfgrestore (8)\fP.
.TP
\fB-M | --metadatatype type\fP
@@ -208,7 +208,7 @@
A tag is a word that can be used to group LVM2 objects of the same type
together.
Tags can be given on the command line in place of PV, VG or LV
-arguments. Tags should be prefixed with @ to avoid ambiguity.
+arguments. Tags should be prefixed with @ when referenced to avoid ambiguity.
Each tag is expanded by replacing it with all objects possessing
that tag which are of the type expected by its position on the command line.
PVs can only possess tags while they are part of a Volume Group:
@@ -266,7 +266,7 @@
Not set by default.
.SH VALID NAMES
The following characters are valid for VG and LV names:
-\fBa-z A-Z 0-9 + _ . -\fP
+\fBA-Z a-z 0-9 _ + . -\fP
.LP
VG and LV names cannot begin with a hyphen.
There are also various reserved names that are used internally by lvm that can not be used as LV or VG names.
-------------- next part --------------
--- lvm.8 2010-06-23 16:25:44.099108000 +0200
+++ lvm.8 2010-06-23 16:57:07.394112635 +0200
@@ -41,105 +41,104 @@
The following commands are built into lvm without links normally
being created in the filesystem for them.
.TP
-\fBdumpconfig\fP \(em Display the configuration information after
-loading \fBlvm.conf\fP (5) and any other configuration files.
+\fBdumpconfig\fP \(em Display the configuration information after loading \fBlvm.conf\fP (5) and any other configuration files.
.TP
\fBformats\fP \(em Display recognised metadata formats.
.TP
-\fBhelp\fP \(em Display the help text.
-.TP
\fBpvdata\fP \(em Not implemented in LVM2.
.TP
\fBsegtypes\fP \(em Display recognised logical volume segment types.
.TP
+\fBhelp\fP \(em Display the help text.
+.TP
\fBversion\fP \(em Display version information.
.LP
.SH COMMANDS
The following commands implement the core LVM functionality.
.TP
-\fBpvchange\fP \(em Change attributes of a physical volume.
-.TP
-\fBpvck\fP \(em Check physical volume metadata.
-.TP
-\fBpvcreate\fP \(em Initialize a disk or partition for use by LVM.
-.TP
-\fBpvdisplay\fP \(em Display attributes of a physical volume.
+\fBvgs\fP \(em Report information about volume groups.
.TP
-\fBpvmove\fP \(em Move physical extents.
+\fBvgdisplay\fP \(em Display attributes of volume groups.
.TP
-\fBpvremove\fP \(em Remove a physical volume.
+\fBvgscan\fP \(em Scan all disks for volume groups and rebuild caches.
.TP
-\fBpvresize\fP \(em Resize a disk or partition in use by LVM2.
+\fBvgcreate\fP \(em Create a volume group.
.TP
-\fBpvs\fP \(em Report information about physical volumes.
+\fBvgremove\fP \(em Remove a volume group.
.TP
-\fBpvscan\fP \(em Scan all disks for physical volumes.
+\fBvgrename\fP \(em Rename a volume group.
.TP
-\fBvgcfgbackup\fP \(em Backup volume group descriptor area.
+\fBvgchange\fP \(em Change attributes of a volume group.
.TP
-\fBvgcfgrestore\fP \(em Restore volume group descriptor area.
+\fBvgextend\fP \(em Add physical volumes to a volume group.
.TP
-\fBvgchange\fP \(em Change attributes of a volume group.
+\fBvgreduce\fP \(em Reduce a volume group by removing one or more physical volumes.
.TP
\fBvgck\fP \(em Check volume group metadata.
.TP
-\fBvgconvert\fP \(em Convert volume group metadata format.
-.TP
-\fBvgcreate\fP \(em Create a volume group.
+\fBvgmerge\fP \(em Merge two volume groups.
.TP
-\fBvgdisplay\fP \(em Display attributes of volume groups.
+\fBvgsplit\fP \(em Split a volume group into two, moving any logical volumes from one volume group to another by moving entire physical volumes.
.TP
\fBvgexport\fP \(em Make volume groups unknown to the system.
.TP
-\fBvgextend\fP \(em Add physical volumes to a volume group.
-.TP
\fBvgimport\fP \(em Make exported volume groups known to the system.
.TP
-\fBvgimportclone\fP \(em Import and rename duplicated volume group (e.g. a hardware snapshot).
+\fBvgcfgbackup\fP \(em Backup volume group descriptor area.
.TP
-\fBvgmerge\fP \(em Merge two volume groups.
+\fBvgcfgrestore\fP \(em Restore volume group descriptor area.
.TP
-\fBvgmknodes\fP \(em Recreate volume group directory and logical volume special files
+\fBvgimportclone\fP \(em Import and rename duplicated volume group (e.g. a hardware snapshot).
.TP
-\fBvgreduce\fP \(em Reduce a volume group by removing one or more physical volumes.
+\fBvgmknodes\fP \(em Recreate volume group directory and logical volume special files
.TP
-\fBvgremove\fP \(em Remove a volume group.
+\fBvgconvert\fP \(em Convert volume group metadata format.
.TP
-\fBvgrename\fP \(em Rename a volume group.
+\fBpvs\fP \(em Report information about physical volumes.
.TP
-\fBvgs\fP \(em Report information about volume groups.
+\fBpvdisplay\fP \(em Display attributes of a physical volume.
.TP
-\fBvgscan\fP \(em Scan all disks for volume groups and rebuild caches.
+\fBpvscan\fP \(em Scan all disks for physical volumes.
.TP
-\fBvgsplit\fP \(em Split a volume group into two, moving any logical volumes from one volume group to another by moving entire physical volumes.
+\fBpvcreate\fP \(em Initialize a disk, partition, etc. as physical volume for use by LVM.
.TP
-\fBlvchange\fP \(em Change attributes of a logical volume.
+\fBpvremove\fP \(em Remove a physical volume.
.TP
-\fBlvconvert\fP \(em Convert a logical volume from linear to mirror or snapshot.
+\fBpvchange\fP \(em Change attributes of a physical volume.
.TP
-\fBlvcreate\fP \(em Create a logical volume in an existing volume group.
+\fBpvresize\fP \(em Resize a disk or partition in use by LVM2.
.TP
-\fBlvdisplay\fP \(em Display attributes of a logical volume.
+\fBpvck\fP \(em Check physical volume metadata.
.TP
-\fBlvextend\fP \(em Extend the size of a logical volume.
+\fBpvmove\fP \(em Move physical extents.
.TP
-\fBlvmchange\fP \(em Change attributes of the logical volume manager.
+\fBlvs\fP \(em Report information about logical volumes.
.TP
-\fBlvmdiskscan\fP \(em Scan for all devices visible to LVM2.
+\fBlvdisplay\fP \(em Display attributes of a logical volume.
.TP
-\fBlvmdump\fP \(em Create lvm2 information dumps for diagnostic purposes.
+\fBlvscan\fP \(em Scan (all disks) for logical volumes.
.TP
-\fBlvreduce\fP \(em Reduce the size of a logical volume.
+\fBlvcreate\fP \(em Create a logical volume in an existing volume group.
.TP
\fBlvremove\fP \(em Remove a logical volume.
.TP
\fBlvrename\fP \(em Rename a logical volume.
.TP
+\fBlvchange\fP \(em Change attributes of a logical volume.
+.TP
\fBlvresize\fP \(em Resize a logical volume.
.TP
-\fBlvs\fP \(em Report information about logical volumes.
+\fBlvextend\fP \(em Extend the size of a logical volume.
.TP
-\fBlvscan\fP \(em Scan (all disks) for logical volumes.
+\fBlvreduce\fP \(em Reduce the size of a logical volume.
+.TP
+\fBlvconvert\fP \(em Convert a logical volume from linear to mirror or snapshot.
+.TP
+\fBlvmchange\fP \(em Change attributes of the logical volume manager.
+.TP
+\fBlvmdiskscan\fP \(em Scan for all devices visible to LVM2.
+.TP
+\fBlvmdump\fP \(em Create lvm2 information dumps for diagnostic purposes.
.TP
The following commands are not implemented in LVM2 but might be in the future: lvmsadc, lvmsar, pvdata.
.SH OPTIONS
-------------- next part --------------
--- lvm.8 2010-06-23 16:25:44.099108000 +0200
+++ lvm.8 2010-06-23 16:34:46.931357952 +0200
@@ -48,11 +48,11 @@
.TP
\fBhelp\fP \(em Display the help text.
.TP
-\fBpvdata\fP \(em Not implemented in LVM2.
-.TP
\fBsegtypes\fP \(em Display recognised logical volume segment types.
.TP
\fBversion\fP \(em Display version information.
+.TP
+The following built-in commands are not implemented in LVM2: pvdata
.LP
.SH COMMANDS
The following commands implement the core LVM functionality.
@@ -141,7 +141,7 @@
.TP
\fBlvscan\fP \(em Scan (all disks) for logical volumes.
.TP
-The following commands are not implemented in LVM2 but might be in the future: lvmsadc, lvmsar, pvdata.
+The following commands are not implemented in LVM2 but might be in the future: lvmsadc, lvmsar
.SH OPTIONS
The following options are available for many of the commands.
They are implemented generically and documented here rather
More information about the pkg-lvm-maintainers
mailing list