diff mbox

[ndctl,2/2] ndctl: Add 'list' verbose documentation

Message ID 20180626204649.7665-2-keith.busch@intel.com (mailing list archive)
State New, archived
Headers show

Commit Message

Keith Busch June 26, 2018, 8:46 p.m. UTC
Signed-off-by: Keith Busch <keith.busch@intel.com>
---
 Documentation/ndctl/ndctl-list.txt | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Comments

Verma, Vishal L June 26, 2018, 10:59 p.m. UTC | #1
On Tue, 2018-06-26 at 14:46 -0600, Keith Busch wrote:
> Signed-off-by: Keith Busch <keith.busch@intel.com>
> ---
>  Documentation/ndctl/ndctl-list.txt | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 

I think this can all just go in the first patch?

> diff --git a/Documentation/ndctl/ndctl-list.txt
> b/Documentation/ndctl/ndctl-list.txt
> index 13ebdcd..791638c 100644
> --- a/Documentation/ndctl/ndctl-list.txt
> +++ b/Documentation/ndctl/ndctl-list.txt
> @@ -200,6 +200,18 @@ include::xable-region-options.txt[]
>    ]
>  }
>  
> +-v::
> +--verbose::
> +	Increase verbosity of the output. This can be specified
> +	multiple times to be even more verbose on the informational and
> +	miscellaneous output, and can be used to override the flags for
> +	showing specific information.

Should we detail here what verbosity level enables which flags? Or is that
too much upkeep in case things change..

> +
> +[verse]
> +ndctl list -v
> +ndctl list -vv
> +ndctl list -vvv
> +
>  include::human-option.txt[]
>  
>  ----
Dan Williams June 26, 2018, 11:20 p.m. UTC | #2
On Tue, Jun 26, 2018 at 3:59 PM, Verma, Vishal L
<vishal.l.verma@intel.com> wrote:
> On Tue, 2018-06-26 at 14:46 -0600, Keith Busch wrote:
>> Signed-off-by: Keith Busch <keith.busch@intel.com>
>> ---
>>  Documentation/ndctl/ndctl-list.txt | 12 ++++++++++++
>>  1 file changed, 12 insertions(+)
>>
>
> I think this can all just go in the first patch?
>
>> diff --git a/Documentation/ndctl/ndctl-list.txt
>> b/Documentation/ndctl/ndctl-list.txt
>> index 13ebdcd..791638c 100644
>> --- a/Documentation/ndctl/ndctl-list.txt
>> +++ b/Documentation/ndctl/ndctl-list.txt
>> @@ -200,6 +200,18 @@ include::xable-region-options.txt[]
>>    ]
>>  }
>>
>> +-v::
>> +--verbose::
>> +     Increase verbosity of the output. This can be specified
>> +     multiple times to be even more verbose on the informational and
>> +     miscellaneous output, and can be used to override the flags for
>> +     showing specific information.
>
> Should we detail here what verbosity level enables which flags? Or is that
> too much upkeep in case things change..

Hopefully does not change too much. We've had some contention about
which fields are available in the listing, so it would be nice to give
a heads up when people say "hey! where did my numa node and
sector_size fields go?".
diff mbox

Patch

diff --git a/Documentation/ndctl/ndctl-list.txt b/Documentation/ndctl/ndctl-list.txt
index 13ebdcd..791638c 100644
--- a/Documentation/ndctl/ndctl-list.txt
+++ b/Documentation/ndctl/ndctl-list.txt
@@ -200,6 +200,18 @@  include::xable-region-options.txt[]
   ]
 }
 
+-v::
+--verbose::
+	Increase verbosity of the output. This can be specified
+	multiple times to be even more verbose on the informational and
+	miscellaneous output, and can be used to override the flags for
+	showing specific information.
+
+[verse]
+ndctl list -v
+ndctl list -vv
+ndctl list -vvv
+
 include::human-option.txt[]
 
 ----