linux-nvdimm.lists.01.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Documentation: use includes in more ndctl command pages.
@ 2020-07-14 11:45 Michal Suchanek
  0 siblings, 0 replies; only message in thread
From: Michal Suchanek @ 2020-07-14 11:45 UTC (permalink / raw)
  To: linux-nvdimm; +Cc: Michal Suchanek

While backporting commit 498ee3d100c3 ("Documentation: clarify bus/dimm/region filtering")
I noticed not all instances of --bus, --dimm, and --region use the
include and hence do not get the clarification.

Fixes: 498ee3d100c3 ("Documentation: clarify bus/dimm/region filtering")

Signed-off-by: Michal Suchanek <msuchanek@suse.de>
---
 Documentation/ndctl/labels-options.txt     |  7 ++-----
 Documentation/ndctl/ndctl-inject-smart.txt |  4 +---
 Documentation/ndctl/ndctl-monitor.txt      | 11 +++--------
 3 files changed, 6 insertions(+), 16 deletions(-)

diff --git a/Documentation/ndctl/labels-options.txt b/Documentation/ndctl/labels-options.txt
index 4aee37969fd5..c7649cfd2aab 100644
--- a/Documentation/ndctl/labels-options.txt
+++ b/Documentation/ndctl/labels-options.txt
@@ -1,9 +1,7 @@
 // SPDX-License-Identifier: GPL-2.0
 
 <memory device(s)>::
-	One or more 'nmemX' device names. The keyword 'all' can be specified to
-	operate on every dimm in the system, optionally filtered by bus id (see
-        --bus= option).
+include::xable-dimm-options.txt[]
 
 -s::
 --size=::
@@ -16,8 +14,7 @@
 
 -b::
 --bus=::
-	Limit operation to memory devices (dimms) that are on the given bus.
-	Where 'bus' can be a provider name or a bus id number.
+include::xable-bus-options.txt[]
 
 -v::
 	Turn on verbose debug messages in the library (if ndctl was built with
diff --git a/Documentation/ndctl/ndctl-inject-smart.txt b/Documentation/ndctl/ndctl-inject-smart.txt
index d28be46cae1c..9fd63bae2729 100644
--- a/Documentation/ndctl/ndctl-inject-smart.txt
+++ b/Documentation/ndctl/ndctl-inject-smart.txt
@@ -38,9 +38,7 @@ OPTIONS
 -------
 -b::
 --bus=::
-	Enforce that the operation only be carried on devices that are
-	attached to the given bus. Where 'bus' can be a provider name or a bus
-	id number.
+include::xable-bus-options.txt[]
 
 -m::
 --media-temperature=::
diff --git a/Documentation/ndctl/ndctl-monitor.txt b/Documentation/ndctl/ndctl-monitor.txt
index 2239f047266d..c0273d378b59 100644
--- a/Documentation/ndctl/ndctl-monitor.txt
+++ b/Documentation/ndctl/ndctl-monitor.txt
@@ -49,20 +49,15 @@ OPTIONS
 -------
 -b::
 --bus=::
-	Enforce that the operation only be carried on devices that are
-	attached to the given bus. Where 'bus' can be a provider name
-	or a bus id number.
+include::xable-bus-options.txt[]
 
 -d::
 --dimm=::
-	A 'nmemX' device name, or dimm id number. Select the devices to
-	monitor reference the given dimm.
+include::xable-dimm-options.txt[]
 
 -r::
 --region=::
-	A 'regionX' device name, or a region id number. The keyword 'all'
-	can be specified to carry out the operation on every region in
-	the system, optionally filtered by bus id (see --bus= option).
+include::xable-region-options.txt[]
 
 -n::
 --namespace=::
-- 
2.26.2
_______________________________________________
Linux-nvdimm mailing list -- linux-nvdimm@lists.01.org
To unsubscribe send an email to linux-nvdimm-leave@lists.01.org

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2020-07-14 11:46 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-14 11:45 [PATCH] Documentation: use includes in more ndctl command pages Michal Suchanek

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