From: Vishal Verma <vishal.l.verma@intel.com>
To: linux-nvdimm@lists.01.org
Cc: Steve Scargall <steve.scargall@intel.com>
Subject: [ndctl PATCH 1/3] Documentation: refactor 'bus options' into its own include
Date: Wed, 28 Aug 2019 18:17:33 -0600 [thread overview]
Message-ID: <20190829001735.30289-2-vishal.l.verma@intel.com> (raw)
In-Reply-To: <20190829001735.30289-1-vishal.l.verma@intel.com>
Create a new 'xable-bus-options.txt' file that is included everywhere
that previously relied upon xable-region-options.txt for bus options
inclusion.
While at it, fix the formatting for the first description text block
from an include - the empty line at the start caused the first block to
be incorrectly indented. This fixes both the dimm and region variants.
Cc: Dan Williams <dan.j.williams@intel.com>
Signed-off-by: Vishal Verma <vishal.l.verma@intel.com>
---
Documentation/ndctl/ndctl-check-namespace.txt | 4 ++++
Documentation/ndctl/ndctl-clear-errors.txt | 4 ++++
Documentation/ndctl/ndctl-create-namespace.txt | 4 ++++
Documentation/ndctl/ndctl-disable-dimm.txt | 4 ++++
Documentation/ndctl/ndctl-disable-region.txt | 4 ++++
Documentation/ndctl/ndctl-enable-dimm.txt | 4 ++++
Documentation/ndctl/ndctl-enable-region.txt | 4 ++++
Documentation/ndctl/ndctl-freeze-security.txt | 4 ++++
Documentation/ndctl/ndctl-inject-error.txt | 4 ++++
Documentation/ndctl/ndctl-list.txt | 4 ++++
Documentation/ndctl/ndctl-remove-passphrase.txt | 4 ++++
Documentation/ndctl/ndctl-sanitize-dimm.txt | 4 ++++
Documentation/ndctl/ndctl-setup-passphrase.txt | 4 ++++
Documentation/ndctl/ndctl-update-firmware.txt | 4 ++++
Documentation/ndctl/ndctl-update-passphrase.txt | 4 ++++
Documentation/ndctl/ndctl-wait-overwrite.txt | 4 ++++
Documentation/ndctl/xable-bus-options.txt | 4 ++++
Documentation/ndctl/xable-dimm-options.txt | 13 +++----------
Documentation/ndctl/xable-namespace-options.txt | 4 ++++
Documentation/ndctl/xable-region-options.txt | 13 +++----------
20 files changed, 78 insertions(+), 20 deletions(-)
create mode 100644 Documentation/ndctl/xable-bus-options.txt
diff --git a/Documentation/ndctl/ndctl-check-namespace.txt b/Documentation/ndctl/ndctl-check-namespace.txt
index 2ece4e7..222f729 100644
--- a/Documentation/ndctl/ndctl-check-namespace.txt
+++ b/Documentation/ndctl/ndctl-check-namespace.txt
@@ -69,6 +69,10 @@ OPTIONS
--region=::
include::xable-region-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
include::../copyright.txt[]
SEE ALSO
diff --git a/Documentation/ndctl/ndctl-clear-errors.txt b/Documentation/ndctl/ndctl-clear-errors.txt
index 206ab58..8eff57e 100644
--- a/Documentation/ndctl/ndctl-clear-errors.txt
+++ b/Documentation/ndctl/ndctl-clear-errors.txt
@@ -98,6 +98,10 @@ can potentially be a very long-running operation.
--region=::
include::xable-region-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
include::../copyright.txt[]
SEE ALSO
diff --git a/Documentation/ndctl/ndctl-create-namespace.txt b/Documentation/ndctl/ndctl-create-namespace.txt
index 343733d..c9ae27c 100644
--- a/Documentation/ndctl/ndctl-create-namespace.txt
+++ b/Documentation/ndctl/ndctl-create-namespace.txt
@@ -211,6 +211,10 @@ OPTIONS
--region=::
include::xable-region-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
include::../copyright.txt[]
SEE ALSO
diff --git a/Documentation/ndctl/ndctl-disable-dimm.txt b/Documentation/ndctl/ndctl-disable-dimm.txt
index 7706ac3..caa6714 100644
--- a/Documentation/ndctl/ndctl-disable-dimm.txt
+++ b/Documentation/ndctl/ndctl-disable-dimm.txt
@@ -19,6 +19,10 @@ OPTIONS
<dimm>::
include::xable-dimm-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
include::../copyright.txt[]
SEE ALSO
diff --git a/Documentation/ndctl/ndctl-disable-region.txt b/Documentation/ndctl/ndctl-disable-region.txt
index ea1fd3a..3ca65a6 100644
--- a/Documentation/ndctl/ndctl-disable-region.txt
+++ b/Documentation/ndctl/ndctl-disable-region.txt
@@ -19,6 +19,10 @@ OPTIONS
<region>::
include::xable-region-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
include::../copyright.txt[]
SEE ALSO
diff --git a/Documentation/ndctl/ndctl-enable-dimm.txt b/Documentation/ndctl/ndctl-enable-dimm.txt
index cd9908d..3e7106c 100644
--- a/Documentation/ndctl/ndctl-enable-dimm.txt
+++ b/Documentation/ndctl/ndctl-enable-dimm.txt
@@ -19,6 +19,10 @@ OPTIONS
<dimm>::
include::xable-dimm-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
include::../copyright.txt[]
SEE ALSO
diff --git a/Documentation/ndctl/ndctl-enable-region.txt b/Documentation/ndctl/ndctl-enable-region.txt
index e5cbddb..96c2d1e 100644
--- a/Documentation/ndctl/ndctl-enable-region.txt
+++ b/Documentation/ndctl/ndctl-enable-region.txt
@@ -19,6 +19,10 @@ OPTIONS
<region>::
include::xable-region-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
include::../copyright.txt[]
SEE ALSO
diff --git a/Documentation/ndctl/ndctl-freeze-security.txt b/Documentation/ndctl/ndctl-freeze-security.txt
index dbb94e7..55aaab7 100644
--- a/Documentation/ndctl/ndctl-freeze-security.txt
+++ b/Documentation/ndctl/ndctl-freeze-security.txt
@@ -56,6 +56,10 @@ OPTIONS
<dimm>::
include::xable-dimm-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
-v::
--verbose::
Emit debug messages.
diff --git a/Documentation/ndctl/ndctl-inject-error.txt b/Documentation/ndctl/ndctl-inject-error.txt
index 744ea50..da376ec 100644
--- a/Documentation/ndctl/ndctl-inject-error.txt
+++ b/Documentation/ndctl/ndctl-inject-error.txt
@@ -112,6 +112,10 @@ include::human-option.txt[]
--region=::
include::xable-region-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
include::../copyright.txt[]
SEE ALSO
diff --git a/Documentation/ndctl/ndctl-list.txt b/Documentation/ndctl/ndctl-list.txt
index 80ad610..f9c7434 100644
--- a/Documentation/ndctl/ndctl-list.txt
+++ b/Documentation/ndctl/ndctl-list.txt
@@ -62,6 +62,10 @@ OPTIONS
--region=::
include::xable-region-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
-d::
--dimm=::
An 'nmemX' device name, or dimm id number. The dimm id number
diff --git a/Documentation/ndctl/ndctl-remove-passphrase.txt b/Documentation/ndctl/ndctl-remove-passphrase.txt
index 3e838bb..f14e649 100644
--- a/Documentation/ndctl/ndctl-remove-passphrase.txt
+++ b/Documentation/ndctl/ndctl-remove-passphrase.txt
@@ -25,6 +25,10 @@ OPTIONS
<dimm>::
include::xable-dimm-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
-v::
--verbose::
Emit debug messages.
diff --git a/Documentation/ndctl/ndctl-sanitize-dimm.txt b/Documentation/ndctl/ndctl-sanitize-dimm.txt
index 91abf47..b2e5fde 100644
--- a/Documentation/ndctl/ndctl-sanitize-dimm.txt
+++ b/Documentation/ndctl/ndctl-sanitize-dimm.txt
@@ -38,6 +38,10 @@ OPTIONS
<dimm>::
include::xable-dimm-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
-c::
--crypto-erase::
Replace the media encryption key on the NVDIMM causing all existing
diff --git a/Documentation/ndctl/ndctl-setup-passphrase.txt b/Documentation/ndctl/ndctl-setup-passphrase.txt
index b22d352..1219279 100644
--- a/Documentation/ndctl/ndctl-setup-passphrase.txt
+++ b/Documentation/ndctl/ndctl-setup-passphrase.txt
@@ -34,6 +34,10 @@ OPTIONS
<dimm>::
include::xable-dimm-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
-k::
--key_handle=::
Handle for the master 'kek' (key-encryption-key) that will be used for
diff --git a/Documentation/ndctl/ndctl-update-firmware.txt b/Documentation/ndctl/ndctl-update-firmware.txt
index 449d858..1aa7fee 100644
--- a/Documentation/ndctl/ndctl-update-firmware.txt
+++ b/Documentation/ndctl/ndctl-update-firmware.txt
@@ -24,6 +24,10 @@ OPTIONS
<dimm>::
include::xable-dimm-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
-f::
--firmware::
firmware file used to perform the update
diff --git a/Documentation/ndctl/ndctl-update-passphrase.txt b/Documentation/ndctl/ndctl-update-passphrase.txt
index 995efec..c7c1bfc 100644
--- a/Documentation/ndctl/ndctl-update-passphrase.txt
+++ b/Documentation/ndctl/ndctl-update-passphrase.txt
@@ -31,6 +31,10 @@ OPTIONS
<dimm>::
include::xable-dimm-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
-k::
--key_handle=::
Handle for the master 'kek' (key-encryption-key) that will be used for
diff --git a/Documentation/ndctl/ndctl-wait-overwrite.txt b/Documentation/ndctl/ndctl-wait-overwrite.txt
index 0fada36..eb24f39 100644
--- a/Documentation/ndctl/ndctl-wait-overwrite.txt
+++ b/Documentation/ndctl/ndctl-wait-overwrite.txt
@@ -23,6 +23,10 @@ OPTIONS
<dimm>::
include::xable-dimm-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
-v::
--verbose::
Emit debug messages.
diff --git a/Documentation/ndctl/xable-bus-options.txt b/Documentation/ndctl/xable-bus-options.txt
new file mode 100644
index 0000000..8813113
--- /dev/null
+++ b/Documentation/ndctl/xable-bus-options.txt
@@ -0,0 +1,4 @@
+// SPDX-License-Identifier: GPL-2.0
+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.
diff --git a/Documentation/ndctl/xable-dimm-options.txt b/Documentation/ndctl/xable-dimm-options.txt
index 709e2e4..8826c2b 100644
--- a/Documentation/ndctl/xable-dimm-options.txt
+++ b/Documentation/ndctl/xable-dimm-options.txt
@@ -1,11 +1,4 @@
// SPDX-License-Identifier: GPL-2.0
-
- A 'nmemX' device name, or a dimm id number. The keyword 'all' can
- be specified to carry out the operation on every dimm in the system,
- optionally filtered by bus id (see --bus= option).
-
--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.
+A 'nmemX' device name, or a dimm id number. The keyword 'all' can
+be specified to carry out the operation on every dimm in the system,
+optionally filtered by bus id (see --bus= option).
diff --git a/Documentation/ndctl/xable-namespace-options.txt b/Documentation/ndctl/xable-namespace-options.txt
index babc248..1a25fee 100644
--- a/Documentation/ndctl/xable-namespace-options.txt
+++ b/Documentation/ndctl/xable-namespace-options.txt
@@ -9,6 +9,10 @@ the operation on every namespace in the system, optionally filtered by region
--region=::
include::xable-region-options.txt[]
+-b::
+--bus=::
+include::xable-bus-options.txt[]
+
-v::
--verbose::
Emit debug messages for the namespace operation
diff --git a/Documentation/ndctl/xable-region-options.txt b/Documentation/ndctl/xable-region-options.txt
index 69d3926..d5198f5 100644
--- a/Documentation/ndctl/xable-region-options.txt
+++ b/Documentation/ndctl/xable-region-options.txt
@@ -1,11 +1,4 @@
// SPDX-License-Identifier: GPL-2.0
-
- 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).
-
--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.
+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).
--
2.20.1
_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm
next prev parent reply other threads:[~2019-08-29 0:19 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-29 0:17 [ndctl PATCH 0/3] greedy namespace creation Vishal Verma
2019-08-29 0:17 ` Vishal Verma [this message]
2019-08-29 0:17 ` [ndctl PATCH 2/3] Documentation: clarify bus/dimm/region filtering Vishal Verma
2019-08-29 0:17 ` [ndctl PATCH 3/3] ndctl/namespace: add a --continue option to create namespaces greedily Vishal Verma
2019-08-29 2:34 ` Dan Williams
2019-08-29 18:05 ` Verma, Vishal L
2019-08-29 19:08 ` Vishal Verma
2019-08-29 17:38 ` jane.chu
2019-08-29 18:08 ` Verma, Vishal L
2019-08-29 18:28 ` Dan Williams
2019-08-29 19:16 ` jane.chu
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=20190829001735.30289-2-vishal.l.verma@intel.com \
--to=vishal.l.verma@intel.com \
--cc=linux-nvdimm@lists.01.org \
--cc=steve.scargall@intel.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).