[ndctl] Documentation, write-labels: add man page

Commit Message

Dan Williams March 29, 2017, 5:01 a.m. UTC

Unlike read-labels, the write-labels command is meant to be run against
one dimm at a time. This hopefully avoids confusion trying to match
input files to output devices.

Signed-off-by: Dan Williams <[e-mail]>
---
 Documentation/Makefile.am            |    1 +
 Documentation/ndctl-write-labels.txt |   29 +++++++++++++++++++++++++++++
 2 files changed, 30 insertions(+)
 create mode 100644 Documentation/ndctl-write-labels.txt

Patch

diff --git a/Documentation/Makefile.am b/Documentation/Makefile.am
index eea11e087012..d72085df4845 100644
--- a/Documentation/Makefile.am
+++ b/Documentation/Makefile.am
@@ -2,6 +2,7 @@  man1_MANS = \
 	ndctl.1 \
 	ndctl-zero-labels.1 \
 	ndctl-read-labels.1 \
+	ndctl-write-labels.1 \
 	ndctl-init-labels.1 \
 	ndctl-check-labels.1 \
 	ndctl-enable-region.1 \
diff --git a/Documentation/ndctl-write-labels.txt b/Documentation/ndctl-write-labels.txt
new file mode 100644
index 000000000000..bace46fba160
--- /dev/null
+++ b/Documentation/ndctl-write-labels.txt
@@ -0,0 +1,29 @@ 
+ndctl-write-labels(1)
+=====================
+
+NAME
+----
+ndctl-write-labels - write data to the label area on a dimm
+
+SYNOPSIS
+--------
+[verse]
+'ndctl write-labels <nmem> [-i <filename>]'
+
+include::labels-description.txt[]
+Read data from the input filename, or stdin, and write it to the given
+<nmem> device. Note that the device must not be active in any region,
+otherwise the kernel will not allow write access to the device's label
+data area.
+
+OPTIONS
+-------
+include::labels-options.txt[]
+-i::
+--input::
+	input file
+
+SEE ALSO
+--------
+http://pmem.io/documents/NVDIMM_Namespace_Spec.pdf[NVDIMM Namespace
+Specification]