nvdimm.lists.linux.dev archive mirror
 help / color / mirror / Atom feed
From: Masayoshi Mizuma <msys.mizuma@gmail.com>
To: linux-nvdimm@lists.01.org
Cc: Masayoshi Mizuma <m.mizuma@jp.fujitsu.com>
Subject: [PATCH] ndctl, documentation: Clarify the dimm id for ndctl list d option
Date: Mon,  6 Aug 2018 17:21:30 -0400	[thread overview]
Message-ID: <20180806212130.1605-1-msys.mizuma@gmail.com> (raw)

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(-)

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	other threads:[~2018-08-06 21:21 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-08-06 21:21 Masayoshi Mizuma [this message]
2018-08-07 19:26 ` [PATCH] ndctl, documentation: Clarify the dimm id for ndctl list d option Verma, Vishal L

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180806212130.1605-1-msys.mizuma@gmail.com \
    --to=msys.mizuma@gmail.com \
    --cc=linux-nvdimm@lists.01.org \
    --cc=m.mizuma@jp.fujitsu.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).