diff mbox

ndctl: add list -M documentation

Message ID 149453390131.38698.13565665088604739422.stgit@djiang5-desk3.ch.intel.com (mailing list archive)
State Accepted
Commit 9d82b38ddf9d
Headers show

Commit Message

Dave Jiang May 11, 2017, 8:18 p.m. UTC
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(+)

Comments

Kani, Toshi May 11, 2017, 9:52 p.m. UTC | #1
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
diff mbox

Patch

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]