[v3] btrfs-progs: Documentation: add T/P/E description for resize cmd
diff mbox

Message ID 1419904337-9945-1-git-send-email-guihc.fnst@cn.fujitsu.com
State Accepted
Headers show

Commit Message

Gui Hecheng Dec. 30, 2014, 1:52 a.m. UTC
Signed-off-by: Gui Hecheng <guihc.fnst@cn.fujitsu.com>
Reviewed-by: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com>
---
changelog
	v1->v2:
		s/\'E\'(EiB)/or \'E\'(EiB)/ as suggested by Satoru, thanks.
	v2->v3:
		replace confusing format 'K'(KiB) etc. Thanks, David.
---
 Documentation/btrfs-filesystem.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

Chris Murphy Jan. 2, 2015, 3:27 a.m. UTC | #1
On Mon, Dec 29, 2014 at 6:52 PM, Gui Hecheng <guihc.fnst@cn.fujitsu.com> wrote:
> Signed-off-by: Gui Hecheng <guihc.fnst@cn.fujitsu.com>
> Reviewed-by: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com>
> ---
> changelog
>         v1->v2:
>                 s/\'E\'(EiB)/or \'E\'(EiB)/ as suggested by Satoru, thanks.
>         v2->v3:
>                 replace confusing format 'K'(KiB) etc. Thanks, David.
> ---
>  Documentation/btrfs-filesystem.txt | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/btrfs-filesystem.txt b/Documentation/btrfs-filesystem.txt
> index a8f2972..96c4420 100644
> --- a/Documentation/btrfs-filesystem.txt
> +++ b/Documentation/btrfs-filesystem.txt
> @@ -102,8 +102,9 @@ If the prefix + or - is present the size is increased or decreased
>  by the quantity <size>.
>  If no units are specified, the unit of the <size> parameter defaults to
>  bytes. Optionally, the size parameter may be suffixed by one of the following
> -units designators: \'K\', \'M', or \'G', kilobytes, megabytes, or gigabytes,
> -respectively.
> +units designators: \'K\', \'M\', \'G\', \'T\', \'P\', or \'E\', which represent
> +KiB, MiB, GiB, TiB, PiB, or EiB, respectively.
> +
>  +
>  If \'max' is passed, the filesystem will occupy all available space on the
>  device devid.

Small problem with the rendering of this commit
d4ef1a06f8be623ae94e4d498c306e8dd1605bef, when I use 'man btrfs
filesystem' the above portion looks like this:

 'K', 'M', 'G', 'T', 'P', or 'E\',

I'm not sure why there's a trailing slash after the E.

Separately, for -t option, it reads:
For <start>, <len>, <size> it is possible to append a suffix like k
for 1 KBytes, m for 1 MBytes...

So there's a reference of small k and m there, but then later
references for capitalized KMGTPE, so maybe the reference could be
more like e.g. LVM where it's described as [bBsSkKmMgGtTpPeE] and just
omit the sS for sectors since this isn't supported.
David Sterba Jan. 2, 2015, 4:12 p.m. UTC | #2
On Thu, Jan 01, 2015 at 08:27:55PM -0700, Chris Murphy wrote:
> Small problem with the rendering of this commit
> d4ef1a06f8be623ae94e4d498c306e8dd1605bef, when I use 'man btrfs
> filesystem' the above portion looks like this:
> 
>  'K', 'M', 'G', 'T', 'P', or 'E\',
> 
> I'm not sure why there's a trailing slash after the E.

Me neither, but it looks like a bug in the asciidoc processing, ends up
in the intermediate xml output. I'll probably drop/change the quoting.

> Separately, for -t option, it reads:
> For <start>, <len>, <size> it is possible to append a suffix like k
> for 1 KBytes, m for 1 MBytes...
> 
> So there's a reference of small k and m there, but then later
> references for capitalized KMGTPE, so maybe the reference could be
> more like e.g. LVM where it's described as [bBsSkKmMgGtTpPeE] and just
> omit the sS for sectors since this isn't supported.

Yep, this should be unified.
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
David Sterba Jan. 2, 2015, 4:21 p.m. UTC | #3
On Fri, Jan 02, 2015 at 05:12:04PM +0100, David Sterba wrote:
> On Thu, Jan 01, 2015 at 08:27:55PM -0700, Chris Murphy wrote:
> > Small problem with the rendering of this commit
> > d4ef1a06f8be623ae94e4d498c306e8dd1605bef, when I use 'man btrfs
> > filesystem' the above portion looks like this:
> > 
> >  'K', 'M', 'G', 'T', 'P', or 'E\',
> > 
> > I'm not sure why there's a trailing slash after the E.
> 
> Me neither, but it looks like a bug in the asciidoc processing.

Seems that only the first ' has to be quoted, and consumes the next
unquoted ' as a pair, so with the last \' the next one is missing and
is printed verbatim:

Fixed by:

-units designators: \'K\', \'M\', \'G\', \'T\', \'P\', or \'E\', which represent
+units designators: \'K', \'M', \'G', \'T', \'P', or \'E', which represent

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Gui Hecheng Jan. 5, 2015, 1:42 a.m. UTC | #4
On Fri, 2015-01-02 at 17:21 +0100, David Sterba wrote:
> On Fri, Jan 02, 2015 at 05:12:04PM +0100, David Sterba wrote:
> > On Thu, Jan 01, 2015 at 08:27:55PM -0700, Chris Murphy wrote:
> > > Small problem with the rendering of this commit
> > > d4ef1a06f8be623ae94e4d498c306e8dd1605bef, when I use 'man btrfs
> > > filesystem' the above portion looks like this:
> > > 
> > >  'K', 'M', 'G', 'T', 'P', or 'E\',
> > > 
> > > I'm not sure why there's a trailing slash after the E.
> > 
> > Me neither, but it looks like a bug in the asciidoc processing.
> 
> Seems that only the first ' has to be quoted, and consumes the next
> unquoted ' as a pair, so with the last \' the next one is missing and
> is printed verbatim:
> 
> Fixed by:
> 
> -units designators: \'K\', \'M\', \'G\', \'T\', \'P\', or \'E\', which represent
> +units designators: \'K', \'M', \'G', \'T', \'P', or \'E', which represent
> 

Oh, sorry, I missed this problem, thanks for fixing it.

-Gui

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch
diff mbox

diff --git a/Documentation/btrfs-filesystem.txt b/Documentation/btrfs-filesystem.txt
index a8f2972..96c4420 100644
--- a/Documentation/btrfs-filesystem.txt
+++ b/Documentation/btrfs-filesystem.txt
@@ -102,8 +102,9 @@  If the prefix + or - is present the size is increased or decreased
 by the quantity <size>.
 If no units are specified, the unit of the <size> parameter defaults to
 bytes. Optionally, the size parameter may be suffixed by one of the following
-units designators: \'K\', \'M', or \'G', kilobytes, megabytes, or gigabytes,
-respectively.
+units designators: \'K\', \'M\', \'G\', \'T\', \'P\', or \'E\', which represent
+KiB, MiB, GiB, TiB, PiB, or EiB, respectively.
+
 +
 If \'max' is passed, the filesystem will occupy all available space on the
 device devid.