From: Masayoshi Mizuma <m.miz...@jp.fujitsu.com>

User may be confused the dimm id description of ndctl list -d
option because ndctl list says id, but the id is not useful to
d option.

]# ndctl list -d nmem7 | jq -r .id
cdab-0a-07e0-fefffeff
]# ndctl list -d cdab-0a-07e0-fefffeff
]#

The appropriate id here is X in 'nmemX' (Above example, X is 7).
Let's clarify the description.

Signed-off-by: Masayoshi Mizuma <m.miz...@jp.fujitsu.com>
---
 Documentation/ndctl/ndctl-list.txt | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/ndctl/ndctl-list.txt 
b/Documentation/ndctl/ndctl-list.txt
index 13ebdcd..1b5882a 100644
--- a/Documentation/ndctl/ndctl-list.txt
+++ b/Documentation/ndctl/ndctl-list.txt
@@ -64,9 +64,10 @@ include::xable-region-options.txt[]
 
 -d::
 --dimm=::
-       An 'nmemX' device name, or dimm id number. Filter listing by
-       devices that reference the given dimm. For example to see all
-       namespaces comprised of storage capacity on nmem0:
+       An 'nmemX' device name, or dimm id number. The dimm id number
+       here is X in 'nmemX'. Filter listing by devices that reference
+       the given dimm. For example to see all namespaces comprised
+       of storage capacity on nmem0:
 ----
 # ndctl list --dimm=nmem0 --namespaces
 ----
-- 
2.18.0

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

Reply via email to