| Message ID | 20180806212130.1605-1-msys.mizuma@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | ndctl, documentation: Clarify the dimm id for ndctl list d option | expand |
On Mon, 2018-08-06 at 17:21 -0400, Masayoshi Mizuma wrote: > From: Masayoshi Mizuma <m.mizuma@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.mizuma@jp.fujitsu.com> > --- > Documentation/ndctl/ndctl-list.txt | 7 ++++--- > 1 file changed, 4 insertions(+), 3 deletions(-) Looks good, Applied. > > 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 > ----
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 ----