* [linux-lvm] Problems in lvmconfig.8, lvm-dumpconfig.8, lvreduce.8, lvresize.8, vgchange.8
@ 2016-02-29 11:35 esr
2016-03-01 13:14 ` Zdenek Kabelac
0 siblings, 1 reply; 3+ messages in thread
From: esr @ 2016-02-29 11:35 UTC (permalink / raw)
To: linux-lvm
[-- Attachment #1: Type: text/plain, Size: 708 bytes --]
This is automatically generated email about markup problems in a man
page for which you appear to be responsible. If you are not the right
person or list, please tell me so I can correct my database.
See http://catb.org/~esr/doclifter/bugs.html for details on how and
why these patches were generated. Feel free to email me with any
questions. Note: These patches do not change the modification date of
any manual page. You may wish to do that by hand.
I apologize if this message seems spammy or impersonal. The volume of
markup bugs I am tracking is over five hundred - there is no real
alternative to generating bugmail from a database and template.
--
Eric S. Raymond
[-- Attachment #2: Type: text/plain, Size: 532 bytes --]
Problems with lvreduce.8:
Unbalanced group in command synopis. You probably forgot
to open or close a [ ] or { } group properly.
--- lvreduce.8-unpatched 2016-02-29 05:58:16.401086143 -0500
+++ lvreduce.8 2016-02-29 06:00:39.252717531 -0500
@@ -16,7 +16,7 @@
.RB [ \-\-noudevsync ]
.RB { \-l | \-\-extents
.RI [ \- ] LogicalExtentsNumber [ % { VG | LV | FREE | ORIGIN "}] |"
-.RB [ \-L | \-\-size
+.RB [ \-L | \-\-size ]
.RI [ \- ] LogicalVolumeSize [ bBsSkKmMgGtTpPeE ]}
.RB [ \-n | \-\-nofsck ]
.RB [ \-r | \-\-resizefs ]
[-- Attachment #3: Type: text/plain, Size: 759 bytes --]
Problems with lvresize.8:
Unbalanced group in command synopis. You probably forgot
to open or close a [ ] or { } group properly.
--- lvresize.8-unpatched 2016-02-29 06:13:26.498737707 -0500
+++ lvresize.8 2016-02-29 06:14:41.306544896 -0500
@@ -9,11 +9,11 @@
.IR ProfileName ]
.RB [ \-i | \-\-stripes " " \fIStripes
.RB [ \-I | \-\-stripesize " " \fIStripeSize ]]
-.RB {[ \-l | \-\-extents
+.RB {[ \-l | \-\-extents ]
.RI [ + | \- ] LogicalExtentsNumber [ % { VG | LV | PVS | FREE | ORIGIN "}] |"
-.RB [ \-L | \-\-size
+.RB [ \-L | \-\-size ]
.RI [ + | \- ] LogicalVolumeSize [ bBsSkKmMgGtTpPeE ]}
-.RB [ \-\-poolmetadatasize
+.RB [ \-\-poolmetadatasize ]
.RI [ + ] MetadataVolumeSize [ bBsSkKmMgG ]
.RB [ \-f | \-\-force ]
.RB [ \-n | \-\-nofsck ]
[-- Attachment #4: Type: text/plain, Size: 663 bytes --]
Problems with lvmconfig.8:
(Identical patches should apply to: lvm-dumpconfig.8)
Unbalanced group in command synopis. You probably forgot
to open or close a [ ] or { } group properly.
--- lvmconfig.8-unpatched 2016-02-29 05:42:45.015495941 -0500
+++ lvmconfig.8 2016-02-29 05:42:52.519476477 -0500
@@ -6,7 +6,7 @@
.RB [ \-f | \-\-file
.IR filename ]
.RB [ \-\-type
-.RI { current | default | diff | list | missing | new | profilable | profilable-command | profilable-metadata }
+.RI { current | default | diff | list | missing | new | profilable | profilable-command | profilable-metadata } ]
.RB [ \-\-atversion
.IR version ]
.RB [ \-\-ignoreadvanced ]
[-- Attachment #5: Type: text/plain, Size: 1091 bytes --]
Problems with vgchange.8:
Invalid option format - cannot have optional prefix in token,
it confuses anything trying to do syntactic parsing.
--- vgchange.8-unpatched 2016-02-29 06:18:37.129937328 -0500
+++ vgchange.8 2016-02-29 06:24:27.177036131 -0500
@@ -40,7 +40,7 @@
.IR MaxPhysicalVolumes ]
.RB [ \-\-metadataprofile
.IR ProfileName ]
-.RB [ \-\- [ vg ] metadatacopies ]
+.RB [ \-\-vgmetadatacopies
.IR NumberOfCopies | unmanaged | all ]
.RB [ \-P | \-\-partial ]
.RB [ \-s | \-\-physicalextentsize
@@ -234,7 +234,7 @@
in the volume group unless the logical volume itself has its own profile
attached. See \fBlvm.conf\fP(5) for more information about \fBmetadata profiles\fP.
.TP
-.BR \-\- [ vg ] metadatacopies " " \fINumberOfCopies | \fIunmanaged | \fIall
+.BR \-\- vgmetadatacopies " " \fINumberOfCopies | \fIunmanaged | \fIall
Sets the desired number of metadata copies in the volume group. If set to
a non-zero value, LVM will automatically manage the 'metadataignore'
flags on the physical volumes (see \fBpvchange\fP or \fBpvcreate \-\-metadataignore\fP) in order
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [linux-lvm] Problems in lvmconfig.8, lvm-dumpconfig.8, lvreduce.8, lvresize.8, vgchange.8
2016-02-29 11:35 [linux-lvm] Problems in lvmconfig.8, lvm-dumpconfig.8, lvreduce.8, lvresize.8, vgchange.8 esr
@ 2016-03-01 13:14 ` Zdenek Kabelac
0 siblings, 0 replies; 3+ messages in thread
From: Zdenek Kabelac @ 2016-03-01 13:14 UTC (permalink / raw)
To: LVM general discussion and development, esr
Dne 29.2.2016 v 12:35 esr@thyrsus.com napsal(a):
> This is automatically generated email about markup problems in a man
> page for which you appear to be responsible. If you are not the right
> person or list, please tell me so I can correct my database.
>
> See http://catb.org/~esr/doclifter/bugs.html for details on how and
> why these patches were generated. Feel free to email me with any
> questions. Note: These patches do not change the modification date of
> any manual page. You may wish to do that by hand.
>
> I apologize if this message seems spammy or impersonal. The volume of
> markup bugs I am tracking is over five hundred - there is no real
> alternative to generating bugmail from a database and template.
>
> --
> Eric S. Raymond
Hi
Thanks for report.
I've tried to fix them (though differently) since proposed changes
were not always correct.
> --- lvreduce.8-unpatched 2016-02-29 05:58:16.401086143 -0500
> +++ lvreduce.8 2016-02-29 06:00:39.252717531 -0500
> @@ -16,7 +16,7 @@
> .RB [ \-\-noudevsync ]
> .RB { \-l | \-\-extents
> .RI [ \- ] LogicalExtentsNumber [ % { VG | LV | FREE | ORIGIN "}] |"
> -.RB [ \-L | \-\-size
> +.RB [ \-L | \-\-size ]
Here we use a different logic - otherwise we would have a full man page of []
chars.
So ATM whenever there is short & long option format - we are not using []
around them and we just use [] around the whole option.
e.g.:
[-l|--extents ExtentsNumber]
> Problems with vgchange.8:
>
> Invalid option format - cannot have optional prefix in token,
> it confuses anything trying to do syntactic parsing.
>
> --- vgchange.8-unpatched 2016-02-29 06:18:37.129937328 -0500
> +++ vgchange.8 2016-02-29 06:24:27.177036131 -0500
> @@ -40,7 +40,7 @@
> .IR MaxPhysicalVolumes ]
> .RB [ \-\-metadataprofile
> .IR ProfileName ]
> -.RB [ \-\- [ vg ] metadatacopies ]
> +.RB [ \-\-vgmetadatacopies
> .IR NumberOfCopies | unmanaged | all ]
> .RB [ \-P | \-\-partial ]
> .RB [ \-s | \-\-physicalextentsize
> @@ -234,7 +234,7 @@
> in the volume group unless the logical volume itself has its own profile
> attached. See \fBlvm.conf\fP(5) for more information about \fBmetadata profiles\fP.
> .TP
> -.BR \-\- [ vg ] metadatacopies " " \fINumberOfCopies | \fIunmanaged | \fIall
> +.BR \-\- vgmetadatacopies " " \fINumberOfCopies | \fIunmanaged | \fIall
Not really sure what we can do with these - since we have couple other similar
one.
lvm2 does support 'optional' prefix so the user can use shorter variant.
--vgmetadatacopies or just --metadatacopies
--raidmaxrecoveryrate or just --maxrecoveryrate
We can probably just put both option in full form to the list - but this
form --[vg]metadatacopies just looks easier to read and saves space ;)
So are we violating some basic 'man-page-writting' rule - or just the catb
parser is not capable of reading it?
IMHO I've already checked many many other man pages and there is a lot of
different styles - so it's quite unclear how to write it properly.
As of now - page for 'lvcreate.8' is basically the style we are heading to.
(and lot's of pages still needs to be updated).
Zdenek
^ permalink raw reply [flat|nested] 3+ messages in thread
* [linux-lvm] Problems in lvmconfig.8, lvm-dumpconfig.8, lvreduce.8, lvresize.8, vgchange.8
@ 2016-02-29 11:49 esr
0 siblings, 0 replies; 3+ messages in thread
From: esr @ 2016-02-29 11:49 UTC (permalink / raw)
To: linux-lvm
[-- Attachment #1: Type: text/plain, Size: 708 bytes --]
This is automatically generated email about markup problems in a man
page for which you appear to be responsible. If you are not the right
person or list, please tell me so I can correct my database.
See http://catb.org/~esr/doclifter/bugs.html for details on how and
why these patches were generated. Feel free to email me with any
questions. Note: These patches do not change the modification date of
any manual page. You may wish to do that by hand.
I apologize if this message seems spammy or impersonal. The volume of
markup bugs I am tracking is over five hundred - there is no real
alternative to generating bugmail from a database and template.
--
Eric S. Raymond
[-- Attachment #2: Type: text/plain, Size: 532 bytes --]
Problems with lvreduce.8:
Unbalanced group in command synopis. You probably forgot
to open or close a [ ] or { } group properly.
--- lvreduce.8-unpatched 2016-02-29 05:58:16.401086143 -0500
+++ lvreduce.8 2016-02-29 06:00:39.252717531 -0500
@@ -16,7 +16,7 @@
.RB [ \-\-noudevsync ]
.RB { \-l | \-\-extents
.RI [ \- ] LogicalExtentsNumber [ % { VG | LV | FREE | ORIGIN "}] |"
-.RB [ \-L | \-\-size
+.RB [ \-L | \-\-size ]
.RI [ \- ] LogicalVolumeSize [ bBsSkKmMgGtTpPeE ]}
.RB [ \-n | \-\-nofsck ]
.RB [ \-r | \-\-resizefs ]
[-- Attachment #3: Type: text/plain, Size: 759 bytes --]
Problems with lvresize.8:
Unbalanced group in command synopis. You probably forgot
to open or close a [ ] or { } group properly.
--- lvresize.8-unpatched 2016-02-29 06:13:26.498737707 -0500
+++ lvresize.8 2016-02-29 06:14:41.306544896 -0500
@@ -9,11 +9,11 @@
.IR ProfileName ]
.RB [ \-i | \-\-stripes " " \fIStripes
.RB [ \-I | \-\-stripesize " " \fIStripeSize ]]
-.RB {[ \-l | \-\-extents
+.RB {[ \-l | \-\-extents ]
.RI [ + | \- ] LogicalExtentsNumber [ % { VG | LV | PVS | FREE | ORIGIN "}] |"
-.RB [ \-L | \-\-size
+.RB [ \-L | \-\-size ]
.RI [ + | \- ] LogicalVolumeSize [ bBsSkKmMgGtTpPeE ]}
-.RB [ \-\-poolmetadatasize
+.RB [ \-\-poolmetadatasize ]
.RI [ + ] MetadataVolumeSize [ bBsSkKmMgG ]
.RB [ \-f | \-\-force ]
.RB [ \-n | \-\-nofsck ]
[-- Attachment #4: Type: text/plain, Size: 663 bytes --]
Problems with lvmconfig.8:
(Identical patches should apply to: lvm-dumpconfig.8)
Unbalanced group in command synopis. You probably forgot
to open or close a [ ] or { } group properly.
--- lvmconfig.8-unpatched 2016-02-29 05:42:45.015495941 -0500
+++ lvmconfig.8 2016-02-29 05:42:52.519476477 -0500
@@ -6,7 +6,7 @@
.RB [ \-f | \-\-file
.IR filename ]
.RB [ \-\-type
-.RI { current | default | diff | list | missing | new | profilable | profilable-command | profilable-metadata }
+.RI { current | default | diff | list | missing | new | profilable | profilable-command | profilable-metadata } ]
.RB [ \-\-atversion
.IR version ]
.RB [ \-\-ignoreadvanced ]
[-- Attachment #5: Type: text/plain, Size: 1091 bytes --]
Problems with vgchange.8:
Invalid option format - cannot have optional prefix in token,
it confuses anything trying to do syntactic parsing.
--- vgchange.8-unpatched 2016-02-29 06:18:37.129937328 -0500
+++ vgchange.8 2016-02-29 06:24:27.177036131 -0500
@@ -40,7 +40,7 @@
.IR MaxPhysicalVolumes ]
.RB [ \-\-metadataprofile
.IR ProfileName ]
-.RB [ \-\- [ vg ] metadatacopies ]
+.RB [ \-\-vgmetadatacopies
.IR NumberOfCopies | unmanaged | all ]
.RB [ \-P | \-\-partial ]
.RB [ \-s | \-\-physicalextentsize
@@ -234,7 +234,7 @@
in the volume group unless the logical volume itself has its own profile
attached. See \fBlvm.conf\fP(5) for more information about \fBmetadata profiles\fP.
.TP
-.BR \-\- [ vg ] metadatacopies " " \fINumberOfCopies | \fIunmanaged | \fIall
+.BR \-\- vgmetadatacopies " " \fINumberOfCopies | \fIunmanaged | \fIall
Sets the desired number of metadata copies in the volume group. If set to
a non-zero value, LVM will automatically manage the 'metadataignore'
flags on the physical volumes (see \fBpvchange\fP or \fBpvcreate \-\-metadataignore\fP) in order
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2016-03-01 13:14 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-02-29 11:35 [linux-lvm] Problems in lvmconfig.8, lvm-dumpconfig.8, lvreduce.8, lvresize.8, vgchange.8 esr
2016-03-01 13:14 ` Zdenek Kabelac
-- strict thread matches above, loose matches on Subject: below --
2016-02-29 11:49 esr
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).