[PATCH] ndctl: add list -M documentation

[PATCH] ndctl: add list -M documentation

[Dave Jiang]

Adding the list --media-errors option to documentation.

Signed-off-by: Dave Jiang <dave.jiang@intel.com>
---
 Documentation/ndctl-list.txt |   29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/Documentation/ndctl-list.txt b/Documentation/ndctl-list.txt
index 444a6f9..0ac08a8 100644
--- a/Documentation/ndctl-list.txt
+++ b/Documentation/ndctl-list.txt
@@ -146,6 +146,35 @@ include::xable-region-options.txt[]
 --idle::
 	Include idle (not enabled) devices in the listing
 
+-M::
+--media-errors::
+	Include media errors (badblocks) in the listing. badblocks_count
+	may count blocks that are not in the data space of the namespace
+	for sector mode.
+[verse]
+{
+  "dev":"namespace7.0",
+  "mode":"raw",
+  "size":33554432,
+  "blockdev":"pmem7",
+  "badblock_count":17,
+  "badblocks":[
+    {
+      "offset":4,
+      "length":1
+    },
+    {
+      "offset":32768,
+      "length":8
+    },
+    {
+      "offset":65528,
+      "length":8
+    }
+  ]
+}
+
+
 SEE ALSO
 --------
 linkndctl:ndctl-create-namespace[1]

_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm

Re: [PATCH] ndctl: add list -M documentation

[Kani, Toshimitsu]

On Thu, 2017-05-11 at 13:18 -0700, Dave Jiang wrote:
> Adding the list --media-errors option to documentation.
> 
> Signed-off-by: Dave Jiang <dave.jiang@intel.com>
> ---
>  Documentation/ndctl-list.txt |   29 +++++++++++++++++++++++++++++
>  1 file changed, 29 insertions(+)
> 
> diff --git a/Documentation/ndctl-list.txt b/Documentation/ndctl-
> list.txt
> index 444a6f9..0ac08a8 100644
> --- a/Documentation/ndctl-list.txt
> +++ b/Documentation/ndctl-list.txt
> @@ -146,6 +146,35 @@ include::xable-region-options.txt[]
>  --idle::
>  	Include idle (not enabled) devices in the listing

The output under EXAMPLE should have "badblock_count".  
 
> +-M::
> +--media-errors::
> +	Include media errors (badblocks) in the listing. 

badblock_count does not need -M.  So, I think the description below
could be put under NOTE or something. 

> badblocks_count
> +	may count blocks that are not in the data space of the
> namespace
> +	for sector mode.

Thanks,
-Toshi

_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm