nvdimm.lists.linux.dev archive mirror
 help / color / mirror / Atom feed
* [PATCH] ndctl, documentation: Clarify the dimm id for ndctl list d option
@ 2018-08-06 21:21 Masayoshi Mizuma
  2018-08-07 19:26 ` Verma, Vishal L
  0 siblings, 1 reply; 2+ messages in thread
From: Masayoshi Mizuma @ 2018-08-06 21:21 UTC (permalink / raw)
  To: linux-nvdimm; +Cc: Masayoshi Mizuma

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] ndctl, documentation: Clarify the dimm id for ndctl list d option
  2018-08-06 21:21 [PATCH] ndctl, documentation: Clarify the dimm id for ndctl list d option Masayoshi Mizuma
@ 2018-08-07 19:26 ` Verma, Vishal L
  0 siblings, 0 replies; 2+ messages in thread
From: Verma, Vishal L @ 2018-08-07 19:26 UTC (permalink / raw)
  To: linux-nvdimm, msys.mizuma; +Cc: m.mizuma


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
>  ----
_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2018-08-07 19:26 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-08-06 21:21 [PATCH] ndctl, documentation: Clarify the dimm id for ndctl list d option Masayoshi Mizuma
2018-08-07 19:26 ` Verma, Vishal L

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