ndctl, documentation: Clarify the dimm id for ndctl list d option
Subsystems (2)
PATCH 1/1 ndctl, documentation: Clarify the dimm id for ndctl list d option
From: Masayoshi Mizuma <[email protected]>
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.
--- Documentation/ndctl/ndctl-list.txt | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
Documentation/ndctl/ndctl-list.txt +4 -3
@@ -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 ----
Signature · 6 lines
2.18.0 _______________________________________________ Linux-nvdimm mailing list [email protected] https://lists.01.org/mailman/listinfo/linux-nvdimm
Verma, Vishal L
maintainerQuoted 11 lines · Masayoshi Mizuma
From: Masayoshi Mizuma <[email protected]>
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
]#
Quoted 7 lines
The appropriate id here is X in 'nmemX' (Above example, X is 7). Let's clarify the description.
Signed-off-by Masayoshi Mizuma <[email protected]>--- Documentation/ndctl/ndctl-list.txt | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
Looks good, Applied.
Quoted 18 lines
Documentation/ndctl/ndctl-list.txt +0
-2@@ -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 seeall
Documentation/ndctl/ndctl-list.txt +1
-1- namespaces comprised of storage capacity on nmem0: + An 'nmemX' device name, or dimm id number. The dimm idnumber
Documentation/ndctl/ndctl-list.txt +1
-0+ here is X in 'nmemX'. Filter listing by devices thatreference
Documentation/ndctl/ndctl-list.txt include::xable-region-options.txt[] · line 73
Quoted 5 lines
Documentation/ndctl/ndctl-list.txt +2
-0+ the given dimm. For example to see all namespaces comprised + of storage capacity on nmem0: ---- # ndctl list --dimm=nmem0 --namespaces ----
_______________________________________________
Linux-nvdimm mailing list
[email protected]
https://lists.01.org/mailman/listinfo/linux-nvdimm