diff mbox

[5/5] Add man page description for nCmSpP replication levels

Message ID 1362861071-12589-6-git-send-email-hugo@carfax.org.uk (mailing list archive)
State New, archived
Headers show

Commit Message

Hugo Mills March 9, 2013, 8:31 p.m. UTC
Signed-off-by: Hugo Mills <hugo@carfax.org.uk>
---
 man/btrfs.8.in      |    9 +++++++++
 man/mkfs.btrfs.8.in |   24 +++++++++++++++++++++++-
 2 files changed, 32 insertions(+), 1 deletion(-)

Comments

Goffredo Baroncelli March 10, 2013, 2:01 p.m. UTC | #1
Hi Hugo,

could you please add also to the btrfs man page a section where are
described the nCmSpP levels ?

Thanks.
GB



On 03/09/2013 09:31 PM, Hugo Mills wrote:
> Signed-off-by: Hugo Mills <hugo@carfax.org.uk>
> ---
>  man/btrfs.8.in      |    9 +++++++++
>  man/mkfs.btrfs.8.in |   24 +++++++++++++++++++++++-
>  2 files changed, 32 insertions(+), 1 deletion(-)
> 
> diff --git a/man/btrfs.8.in b/man/btrfs.8.in
> index 94f4ffe..2799ec7 100644
> --- a/man/btrfs.8.in
> +++ b/man/btrfs.8.in
> @@ -25,6 +25,8 @@ btrfs \- control a btrfs filesystem
>  [-s \fIstart\fR] [-t \fIsize\fR] -[vf] <\fIfile\fR>|<\fIdir\fR> \
>  [<\fIfile\fR>|<\fIdir\fR>...]
>  .PP
> +\fBbtrfs\fP \fBfilesystem df\fP [-r]\fI <path> \fP
> +.PP
>  \fBbtrfs\fP \fBfilesystem sync\fP\fI <path> \fP
>  .PP
>  \fBbtrfs\fP \fBfilesystem resize\fP\fI [devid:][+/\-]<size>[gkm]|[devid:]max <filesystem>\fP
> @@ -217,6 +219,13 @@ don't use it if you use snapshots, have de-duplicated your data or made
>  copies with \fBcp --reflink\fP.
>  .TP
>  
> +\fBfilesystem df\fR [-r] \fI<path>\fR
> +Show usage information for the filesystem identified by \fI<path>\fR.
> +
> +\fB-r, --raid\fP Use old-style "RAID-n" terminology to show replication types
> +
> +.TP
> +
>  \fBfilesystem sync\fR\fI <path> \fR
>  Force a sync for the filesystem identified by \fI<path>\fR.
>  .TP
> diff --git a/man/mkfs.btrfs.8.in b/man/mkfs.btrfs.8.in
> index 41163e0..2e71e65 100644
> --- a/man/mkfs.btrfs.8.in
> +++ b/man/mkfs.btrfs.8.in
> @@ -37,7 +37,29 @@ mkfs.btrfs uses all the available storage for the filesystem.
>  .TP
>  \fB\-d\fR, \fB\-\-data \fItype\fR
>  Specify how the data must be spanned across the devices specified. Valid
> -values are raid0, raid1, raid10 or single.
> +values are of the form <n>C[D][<m>S[<p>P]], where <n> is the number of copies
> +of data, <m> is the number of stripes per copy, and <p> is the number of parity
> +stripes. The <m> parameter must (currently) be a literal "m", indicating that
> +as many stripes as possible will be used. The letter D may be added to the
> +number of copies, to indicate non-redundant copies (e.g. on the same device).
> +
> +The following deprecated values may also be used:
> +.RS 16
> +.P
> +single	1C
> +.P
> +raid0	1CmS
> +.P
> +raid1	2C
> +.P
> +dup		2CD
> +.P
> +raid10	2CmS
> +.P
> +raid5	1CmS1P
> +.P
> +raid6	1CmS2P
> +.RS -16
>  .TP
>  \fB\-f\fR
>  Force overwrite when an existing filesystem is detected on the device.
Hugo Mills March 10, 2013, 5:20 p.m. UTC | #2
On Sun, Mar 10, 2013 at 03:01:12PM +0100, Goffredo Baroncelli wrote:
> Hi Hugo,
> 
> could you please add also to the btrfs man page a section where are
> described the nCmSpP levels ?
> 
> Thanks.
> GB
> 
> 
> 
> On 03/09/2013 09:31 PM, Hugo Mills wrote:
> > Signed-off-by: Hugo Mills <hugo@carfax.org.uk>
> > ---
[snip]
> > diff --git a/man/mkfs.btrfs.8.in b/man/mkfs.btrfs.8.in
> > index 41163e0..2e71e65 100644
> > --- a/man/mkfs.btrfs.8.in
> > +++ b/man/mkfs.btrfs.8.in
> > @@ -37,7 +37,29 @@ mkfs.btrfs uses all the available storage for the filesystem.
> >  .TP
> >  \fB\-d\fR, \fB\-\-data \fItype\fR
> >  Specify how the data must be spanned across the devices specified. Valid
> > -values are raid0, raid1, raid10 or single.

   Like here?

> > +values are of the form <n>C[D][<m>S[<p>P]], where <n> is the number of copies
> > +of data, <m> is the number of stripes per copy, and <p> is the number of parity
> > +stripes. The <m> parameter must (currently) be a literal "m", indicating that
> > +as many stripes as possible will be used. The letter D may be added to the
> > +number of copies, to indicate non-redundant copies (e.g. on the same device).
> > +
> > +The following deprecated values may also be used:
> > +.RS 16
> > +.P
> > +single	1C
> > +.P
> > +raid0	1CmS
> > +.P
> > +raid1	2C
> > +.P
> > +dup		2CD
> > +.P
> > +raid10	2CmS
> > +.P
> > +raid5	1CmS1P
> > +.P
> > +raid6	1CmS2P
> > +.RS -16
> >  .TP
> >  \fB\-f\fR
> >  Force overwrite when an existing filesystem is detected on the device.
Goffredo Baroncelli March 10, 2013, 5:52 p.m. UTC | #3
On 03/10/2013 06:20 PM, Hugo Mills wrote:
> On Sun, Mar 10, 2013 at 03:01:12PM +0100, Goffredo Baroncelli wrote:
>> Hi Hugo,
>>
>> could you please add also to the btrfs man page a section where are
>> described the nCmSpP levels ?
>>
>> Thanks.
>> GB
>>
>>
>>
>> On 03/09/2013 09:31 PM, Hugo Mills wrote:
>>> Signed-off-by: Hugo Mills <hugo@carfax.org.uk>
>>> ---
> [snip]
>>> diff --git a/man/mkfs.btrfs.8.in b/man/mkfs.btrfs.8.in
>>> index 41163e0..2e71e65 100644
>>> --- a/man/mkfs.btrfs.8.in
>>> +++ b/man/mkfs.btrfs.8.in
>>> @@ -37,7 +37,29 @@ mkfs.btrfs uses all the available storage for the filesystem.
>>>  .TP
>>>  \fB\-d\fR, \fB\-\-data \fItype\fR
>>>  Specify how the data must be spanned across the devices specified. Valid
>>> -values are raid0, raid1, raid10 or single.
> 
>    Like here?

Yes, I thought about a section which lists the allowable raid level.

> 
>>> +values are of the form <n>C[D][<m>S[<p>P]], where <n> is the number of copies
>>> +of data, <m> is the number of stripes per copy, and <p> is the number of parity
>>> +stripes. The <m> parameter must (currently) be a literal "m", indicating that
>>> +as many stripes as possible will be used. The letter D may be added to the
>>> +number of copies, to indicate non-redundant copies (e.g. on the same device).
>>> +
>>> +The following deprecated values may also be used:
>>> +.RS 16
>>> +.P
>>> +single	1C
>>> +.P
>>> +raid0	1CmS
>>> +.P
>>> +raid1	2C
>>> +.P
>>> +dup		2CD
>>> +.P
>>> +raid10	2CmS
>>> +.P
>>> +raid5	1CmS1P
>>> +.P
>>> +raid6	1CmS2P
>>> +.RS -16
>>>  .TP
>>>  \fB\-f\fR
>>>  Force overwrite when an existing filesystem is detected on the device.
>
diff mbox

Patch

diff --git a/man/btrfs.8.in b/man/btrfs.8.in
index 94f4ffe..2799ec7 100644
--- a/man/btrfs.8.in
+++ b/man/btrfs.8.in
@@ -25,6 +25,8 @@  btrfs \- control a btrfs filesystem
 [-s \fIstart\fR] [-t \fIsize\fR] -[vf] <\fIfile\fR>|<\fIdir\fR> \
 [<\fIfile\fR>|<\fIdir\fR>...]
 .PP
+\fBbtrfs\fP \fBfilesystem df\fP [-r]\fI <path> \fP
+.PP
 \fBbtrfs\fP \fBfilesystem sync\fP\fI <path> \fP
 .PP
 \fBbtrfs\fP \fBfilesystem resize\fP\fI [devid:][+/\-]<size>[gkm]|[devid:]max <filesystem>\fP
@@ -217,6 +219,13 @@  don't use it if you use snapshots, have de-duplicated your data or made
 copies with \fBcp --reflink\fP.
 .TP
 
+\fBfilesystem df\fR [-r] \fI<path>\fR
+Show usage information for the filesystem identified by \fI<path>\fR.
+
+\fB-r, --raid\fP Use old-style "RAID-n" terminology to show replication types
+
+.TP
+
 \fBfilesystem sync\fR\fI <path> \fR
 Force a sync for the filesystem identified by \fI<path>\fR.
 .TP
diff --git a/man/mkfs.btrfs.8.in b/man/mkfs.btrfs.8.in
index 41163e0..2e71e65 100644
--- a/man/mkfs.btrfs.8.in
+++ b/man/mkfs.btrfs.8.in
@@ -37,7 +37,29 @@  mkfs.btrfs uses all the available storage for the filesystem.
 .TP
 \fB\-d\fR, \fB\-\-data \fItype\fR
 Specify how the data must be spanned across the devices specified. Valid
-values are raid0, raid1, raid10 or single.
+values are of the form <n>C[D][<m>S[<p>P]], where <n> is the number of copies
+of data, <m> is the number of stripes per copy, and <p> is the number of parity
+stripes. The <m> parameter must (currently) be a literal "m", indicating that
+as many stripes as possible will be used. The letter D may be added to the
+number of copies, to indicate non-redundant copies (e.g. on the same device).
+
+The following deprecated values may also be used:
+.RS 16
+.P
+single	1C
+.P
+raid0	1CmS
+.P
+raid1	2C
+.P
+dup		2CD
+.P
+raid10	2CmS
+.P
+raid5	1CmS1P
+.P
+raid6	1CmS2P
+.RS -16
 .TP
 \fB\-f\fR
 Force overwrite when an existing filesystem is detected on the device.