* [ndctl PATCH v2] ndctl, docs: cleanup the man page for create-namespace
@ 2018-03-14 22:26 Vishal Verma
0 siblings, 0 replies; only message in thread
From: Vishal Verma @ 2018-03-14 22:26 UTC (permalink / raw)
To: linux-nvdimm
Clean up some rendering artifacts in the man page for
ndctl-create-namespace.
Cc: Dan Williams <dan.j.williams@intel.com>
Reviewed-by: Dan Williams <dan.j.williams@intel.com>
Signed-off-by: Vishal Verma <vishal.l.verma@intel.com>
---
Documentation/ndctl/ndctl-create-namespace.txt | 54 +++++++++++++-------------
1 file changed, 26 insertions(+), 28 deletions(-)
v2: Make the "In the latter case.." paragraph a continuation of the
first bullet.
diff --git a/Documentation/ndctl/ndctl-create-namespace.txt b/Documentation/ndctl/ndctl-create-namespace.txt
index c8b1c99..8de6689 100644
--- a/Documentation/ndctl/ndctl-create-namespace.txt
+++ b/Documentation/ndctl/ndctl-create-namespace.txt
@@ -171,32 +171,31 @@ OPTIONS
Section 6.5.10 NVDIMM Label Methods) support "labelled
namespace" operation.
- There are two cases where the kernel will default to
- label-less operation:
-
- * NVDIMM does not support labels
-
- * The NVDIMM supports labels, but the Label Index Block (see
- UEFI 2.7) is not present and there is no capacity aliasing
- between 'blk' and 'pmem' regions.
-
- In the latter case the configuration can be upgraded to
- labelled operation by writing an index block on all DIMMs in a
- region and re-enabling that region. The 'autolabel' capability
- of 'ndctl create-namespace --reconfig' tries to do this by
- default if it can determine that all DIMM capacity is
- referenced by the namespace being reconfigured. It will
- otherwise fail to autolabel and remain in label-less mode if
- it finds a DIMM contributes capacity to more than one region.
- This check prevents inadvertent data loss of that other region
- is in active use. The --autolabel option is implied by
- default, the --no-autolabel option can be used to disable this
- behavior. When automatic labeling fails and labelled operation
- is still desired the safety policy can be bypassed by the
- following commands, note that all data on all regions is
- forfeited by running these commands:
-
- [verse]
+ - There are two cases where the kernel will default to
+ label-less operation:
+
+ * NVDIMM does not support labels
+
+ * The NVDIMM supports labels, but the Label Index Block (see
+ UEFI 2.7) is not present and there is no capacity aliasing
+ between 'blk' and 'pmem' regions.
+
+ - In the latter case the configuration can be upgraded to
+ labelled operation by writing an index block on all DIMMs in a
+ region and re-enabling that region. The 'autolabel' capability
+ of 'ndctl create-namespace --reconfig' tries to do this by
+ default if it can determine that all DIMM capacity is
+ referenced by the namespace being reconfigured. It will
+ otherwise fail to autolabel and remain in label-less mode if
+ it finds a DIMM contributes capacity to more than one region.
+ This check prevents inadvertent data loss of that other region
+ is in active use. The --autolabel option is implied by
+ default, the --no-autolabel option can be used to disable this
+ behavior. When automatic labeling fails and labelled operation
+ is still desired the safety policy can be bypassed by the
+ following commands, note that all data on all regions is
+ forfeited by running these commands:
+
ndctl disable-region all
ndctl init-labels all
ndctl enable-region all
@@ -222,5 +221,4 @@ linkndctl:ndctl-zero-labels[1],
linkndctl:ndctl-init-labels[1],
linkndctl:ndctl-disable-namespace[1],
linkndctl:ndctl-enable-namespace[1],
-http://www.uefi.org/sites/default/files/resources/UEFI_Spec_2_7.pdf[UEFI NVDIMM Label Protocol
-]
+http://www.uefi.org/sites/default/files/resources/UEFI_Spec_2_7.pdf[UEFI NVDIMM Label Protocol]
--
2.14.3
_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2018-03-14 22:20 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-03-14 22:26 [ndctl PATCH v2] ndctl, docs: cleanup the man page for create-namespace Vishal Verma
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).