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

Commit Message

Satoru Takeuchi Dec. 19, 2014, 9:56 a.m. UTC

Hi David,

> On 2014/12/18 23:27, David Sterba wrote:
>> Signed-off-by: David Sterba <[e-mail]>
>> ---
>>    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.

This patch seems to already be in devel/integration-20141218.
Here is the patch example.


---
From: Satoru Takeuchi <[e-mail]>
Subject: [PATCH] btrfs-progs: Cleanup: Fix the redundancy of btrfs-filesystem.

Signed-off-by: Satoru Takeuchi <[e-mail]>

---
 Documentation/btrfs-filesystem.txt | 21 +++------------------
 1 file changed, 3 insertions(+), 18 deletions(-)

Comments

David Sterba Dec. 19, 2014, 1:36 p.m. UTC | #1

On Fri, Dec 19, 2014 at 06:56:43PM +0900, Satoru Takeuchi wrote:
> +There are some options to set unit. See the description of *df* subcommand
> +from '-b' option to '-t' option.

The unit options exist only for very few subcommands so I found it more
convenient to list all of them near to the command itself rather than
pointing somewhere else.
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to [e-mail]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Satoru Takeuchi Dec. 21, 2014, 11:25 p.m. UTC | #2

On 2014/12/19 22:36, David Sterba wrote:
> On Fri, Dec 19, 2014 at 06:56:43PM +0900, Satoru Takeuchi wrote:
>> +There are some options to set unit. See the description of *df* subcommand
>> +from '-b' option to '-t' option.
>
> The unit options exist only for very few subcommands so I found it more
> convenient to list all of them near to the command itself rather than
> pointing somewhere else.
>

OK, got it.

Thanks,
Satoru

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

Patch

diff --git a/Documentation/btrfs-filesystem.txt b/Documentation/btrfs-filesystem.txt
index 85a94eb..a8e7431 100644
--- a/Documentation/btrfs-filesystem.txt
+++ b/Documentation/btrfs-filesystem.txt
@@ -128,27 +128,12 @@  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
 
+There are some options to set unit. See the description of *df* subcommand
+from '-b' option to '-t' option.
+
 If conflicting options are passed, the last one takes precedence.
 
 EXIT STATUS