diff mbox

[3/6] btrfs-progs: fi usage, update manpage

Message ID 488c53a0e5e255f9504cfc2a029e7c1c72994f66.1418912740.git.dsterba@suse.cz (mailing list archive)
State Superseded
Headers show

Commit Message

David Sterba Dec. 18, 2014, 2:27 p.m. UTC
Signed-off-by: David Sterba <dsterba@suse.cz>
---
 Documentation/btrfs-filesystem.txt | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

Comments

Satoru Takeuchi Dec. 19, 2014, 5:04 a.m. UTC | #1
Hi David,

On 2014/12/18 23:27, David Sterba wrote:
> Signed-off-by: David Sterba <dsterba@suse.cz>
> ---
>   Documentation/btrfs-filesystem.txt | 28 ++++++++++++++++++++++++++++
>   1 file changed, 28 insertions(+)
> 
> diff --git a/Documentation/btrfs-filesystem.txt b/Documentation/btrfs-filesystem.txt
> index a8f2972a0e1a..85a94eb52569 100644
> --- a/Documentation/btrfs-filesystem.txt
> +++ b/Documentation/btrfs-filesystem.txt
> @@ -123,6 +123,34 @@ Show or update the label of a filesystem.
>   If a newlabel optional argument is passed, the label is changed.
>   NOTE: the maximum allowable length shall be less than 256 chars
>   
> +*usage* [options] <path> [<path>...]::
> +Show detailed information about internal filesystem usage.

Options from "-b" to "-t" are the completely same as "btrfs fi df"'s ones.
So how about pointing the df's options as follows?

===============================================================================
...
+
`Options`
+
-T::::
Show data in tabular format
+
There are some option to set unit. See description of *df*'s options
from '-b' to '-t'.
+
If conflicting options are passed, the last one takes precedence.
...
===============================================================================

I consider it can prevent mistakes caused by further changes.

Thanks,
Satoru

> ++
> +`Options`
> ++
> +-b|--raw::::
> +raw numbers in bytes, without the 'B' suffix
> +-h::::
> +print human friendly numbers, base 1024, this is the default
> +-H::::
> +print human friendly numbers, base 1000
> +--iec::::
> +select the 1024 base for the following options, according to the IEC standard
> +--si::::
> +select the 1000 base for the following options, according to the SI standard
> +-k|--kbytes::::
> +show sizes in KiB, or kB with --si
> +-m|--mbytes::::
> +show sizes in MiB, or MB with --si
> +-g|--gbytes::::
> +show sizes in GiB, or GB with --si
> +-t|--tbytes::::
> +show sizes in TiB, or TB with --si
> +-T::::
> +show data in tabular format
> +
> +If conflicting options are passed, the last one takes precedence.
> +
>   EXIT STATUS
>   -----------
>   *btrfs filesystem* returns a zero exit status if it succeeds. Non zero is
> 

--
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
diff mbox

Patch

diff --git a/Documentation/btrfs-filesystem.txt b/Documentation/btrfs-filesystem.txt
index a8f2972a0e1a..85a94eb52569 100644
--- a/Documentation/btrfs-filesystem.txt
+++ b/Documentation/btrfs-filesystem.txt
@@ -123,6 +123,34 @@  Show or update the label of a filesystem.
 If a newlabel optional argument is passed, the label is changed.
 NOTE: the maximum allowable length shall be less than 256 chars
 
+*usage* [options] <path> [<path>...]::
+Show detailed information about internal filesystem usage.
++
+`Options`
++
+-b|--raw::::
+raw numbers in bytes, without the 'B' suffix
+-h::::
+print human friendly numbers, base 1024, this is the default
+-H::::
+print human friendly numbers, base 1000
+--iec::::
+select the 1024 base for the following options, according to the IEC standard
+--si::::
+select the 1000 base for the following options, according to the SI standard
+-k|--kbytes::::
+show sizes in KiB, or kB with --si
+-m|--mbytes::::
+show sizes in MiB, or MB with --si
+-g|--gbytes::::
+show sizes in GiB, or GB with --si
+-t|--tbytes::::
+show sizes in TiB, or TB with --si
+-T::::
+show data in tabular format
+
+If conflicting options are passed, the last one takes precedence.
+
 EXIT STATUS
 -----------
 *btrfs filesystem* returns a zero exit status if it succeeds. Non zero is