respin documentation

For format man page updates.

Signed-off-by: Keith Busch <keith.busch@intel.com>

diff --git a/Documentation/nvme-format.1 b/Documentation/nvme-format.1
index a2d4fc8a654b27c3f9cc20d939d15c94d1e94930..e1601445207df263099743973fd74b75a7dc21e6 100644 (file)
--- a/Documentation/nvme-format.1
+++ b/Documentation/nvme-format.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-format
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\"      Date: 04/08/2019
+.\"      Date: 05/16/2019
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-FORMAT" "1" "04/08/2019" "NVMe" "NVMe Manual"
+.TH "NVME\-FORMAT" "1" "05/16/2019" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -48,7 +48,9 @@ For the NVMe device given, send an nvme Format Namespace admin command and provi
 .sp
 The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. If the character device is given, the namespace identifier will default to 0xffffffff to send the format to all namespace, but can be overridden to any namespace with the \fInamespace\-id\fR option\&. If the block device is given, the namespace identifier will default to the namespace id of the block device given, but can be overridden with the same option\&.
 .sp
-On success, the program will automatically issue BLKRRPART ioctl to force rescanning the namespaces\&. If the driver is recent enough, this will automatically update the physical block size\&. If it is not recent enough, you will need to remove and rescan your device some other way for the new block size to be visible\&.
+Note, the numeric suffix on the character device, for example the \fI0\fR in /dev/nvme0, does NOT indicate this device handle is the parent controller of any namespaces with the same suffix\&. The namespace handle\(cqs numeral may be coming from the subsystem identifier, which is independent of the controller\(cqs identifier\&. Do not assume any particular device relationship based on their names\&. If you do, you may irrevocably erase data on an unintended device\&.
+.sp
+On success, the program will automatically issue BLKRRPART ioctl to force rescanning the namespaces\&. If the driver is recent enough, this will automatically update the physical block size\&. If it is not recent enough, you will need to remove and rescan your device some other way for the new block size to be visible, if the size was changed with this command\&.
 .SH "OPTIONS"
 .PP
 \-n <nsid>, \-\-namespace\-id=<nsid>

diff --git a/Documentation/nvme-format.html b/Documentation/nvme-format.html
index 11ccfef2c4c54ec8402f47ea8e6382a2caa15e4c..cdca79d55b3e2db21a1fb66c0e116c15798836f7 100644 (file)
--- a/Documentation/nvme-format.html
+++ b/Documentation/nvme-format.html
@@ -771,11 +771,18 @@ to 0xffffffff to send the format to all namespace, but can be overridden
 to any namespace with the <em>namespace-id</em> option. If the block device\r
 is given, the namespace identifier will default to the namespace id of\r
 the block device given, but can be overridden with the same option.</p></div>\r
+<div class="paragraph"><p>Note, the numeric suffix on the character device, for example the <em>0</em> in\r
+/dev/nvme0, does NOT indicate this device handle is the parent controller\r
+of any namespaces with the same suffix. The namespace handle&#8217;s numeral\r
+may be coming from the subsystem identifier, which is independent of the\r
+controller&#8217;s identifier. Do not assume any particular device relationship\r
+based on their names. If you do, you may irrevocably erase data on an\r
+unintended device.</p></div>\r
 <div class="paragraph"><p>On success, the program will automatically issue BLKRRPART ioctl to\r
-force rescanning the namespaces. If the driver is recent enough, this\r
-will automatically update the physical block size. If it is not recent\r
-enough, you will need to remove and rescan your device some other way\r
-for the new block size to be visible.</p></div>\r
+force rescanning the namespaces. If the driver is recent enough, this will\r
+automatically update the physical block size. If it is not recent enough,\r
+you will need to remove and rescan your device some other way for the\r
+new block size to be visible, if the size was changed with this command.</p></div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
@@ -1013,7 +1020,7 @@ information:
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2019-01-28 17:42:37 MST\r
+Last updated 2019-05-16 09:47:03 MDT\r
 </div>\r
 </div>\r
 </body>\r