]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
Documenation fixes
authorKeith Busch <keith.busch@intel.com>
Fri, 26 Feb 2016 15:30:21 +0000 (08:30 -0700)
committerKeith Busch <keith.busch@intel.com>
Fri, 26 Feb 2016 15:34:35 +0000 (08:34 -0700)
Addresing typos and a few subtle incorrect usages. '0x' is a required
prefix for parsing hex numbers.

Signed-off-by: Keith Busch <keith.busch@intel.com>
42 files changed:
Documentation/nvme-admin-passthru.1
Documentation/nvme-admin-passthru.html
Documentation/nvme-admin-passthru.txt
Documentation/nvme-detach-ns.1
Documentation/nvme-detach-ns.html
Documentation/nvme-dsm.1
Documentation/nvme-dsm.html
Documentation/nvme-dsm.txt
Documentation/nvme-error-log.1
Documentation/nvme-error-log.html
Documentation/nvme-error-log.txt
Documentation/nvme-flush.1
Documentation/nvme-flush.html
Documentation/nvme-format.1
Documentation/nvme-format.html
Documentation/nvme-format.txt
Documentation/nvme-get-feature.1
Documentation/nvme-get-feature.html
Documentation/nvme-get-feature.txt
Documentation/nvme-id-ctrl.1
Documentation/nvme-id-ctrl.html
Documentation/nvme-id-ctrl.txt
Documentation/nvme-id-ns.1
Documentation/nvme-id-ns.html
Documentation/nvme-id-ns.txt
Documentation/nvme-list-ctrl.1
Documentation/nvme-list-ctrl.html
Documentation/nvme-list-ctrl.txt
Documentation/nvme-list.1
Documentation/nvme-list.html
Documentation/nvme-list.txt
Documentation/nvme-resv-register.1
Documentation/nvme-resv-register.html
Documentation/nvme-set-feature.1
Documentation/nvme-set-feature.html
Documentation/nvme-set-feature.txt
Documentation/nvme-smart-log.1
Documentation/nvme-smart-log.html
Documentation/nvme-smart-log.txt
Documentation/nvme.1
Documentation/nvme.html
Documentation/nvme.txt

index 8bfa1cc1b682a0b36bdbea3ff99fcde7dfe59195..7be84bc4900f76ebf9c7d4c327021ca965ca7da2 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-admin-passthru
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/08/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-ADMIN\-PASSTHR" "1" "06/08/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-ADMIN\-PASSTHR" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -118,7 +118,7 @@ Print the raw returned buffer to stdout if the command returns a structure\&.
 .sp -1
 .IP \(bu 2.3
 .\}
-The following will run the admin command with opcode=6 and cdw10=1, which cooresponds to an identify controller command\&. This example requires the data\-len param be 4096, which is the size of the returned structure\&. The \-r option is used because it is a data\-in command
+The following will run the admin command with opcode=6 and cdw10=1, which corresponds to an identify controller command\&. This example requires the data\-len param be 4096, which is the size of the returned structure\&. The \-r option is used because it is a data\-in command
 .sp
 .if n \{\
 .RS 4
index a7612298b63feb06415049db8734e2df46ee14fd..a955088d586f6278a897158661099d810054438c 100644 (file)
@@ -931,7 +931,7 @@ printed to stdout for another program to parse.</p></div>
 <li>\r
 <p>\r
 The following will run the admin command with opcode=6 and cdw10=1, which\r
- cooresponds to an identify controller command. This example requires the\r
+ corresponds to an identify controller command. This example requires the\r
  data-len param be 4096, which is the size of the returned structure. The -r\r
  option is used because it is a data-in command\r
 </p>\r
@@ -962,7 +962,7 @@ Or if you want to save that structure to a file:
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-05-29 09:29:39 MDT\r
+Last updated 2016-02-26 08:23:20 MST\r
 </div>\r
 </div>\r
 </body>\r
index c0b5896019260b078e57303794a1a6ebeacc5e9c..a107a04ee255e819491c0d2c3e809d736f84120b 100644 (file)
@@ -94,7 +94,7 @@ OPTIONS
 EXAMPLES
 --------
 * The following will run the admin command with opcode=6 and cdw10=1, which
- cooresponds to an identify controller command. This example requires the
+ corresponds to an identify controller command. This example requires the
  data-len param be 4096, which is the size of the returned structure. The -r
  option is used because it is a data-in command
 +
index 1135ba8469ed53c54c2702158fed19fe5a5fb312..8539ecc97bdda10423108e0f6f014feb5a214878 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-detach-ns
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/08/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-DETACH\-NS" "1" "06/08/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-DETACH\-NS" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
index 68e8922b37c62c026700da72fe7664ebd8e158de..eed4a127e5aceec38d259aad904b6ecdefb745e6 100644 (file)
@@ -812,7 +812,7 @@ controller identifiers.</p></div>
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-06-08 14:06:57 MDT\r
+Last updated 2016-02-26 08:25:34 MST\r
 </div>\r
 </div>\r
 </body>\r
index e29f0d5ddc23a4e57820f5bba5417aab1c07efa1..4af7456294590ac16f6034a6ff3f58d3dd365fa4 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-dsm
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 10/23/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-DSM" "1" "10/23/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-DSM" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -87,7 +87,7 @@ Attribute Integral Dataset for Read\&.
 .PP
 \-c <cdw11>, \-\-cdw11=<cdw11>
 .RS 4
-All the command command dword 11 attribuets\&. Use exclusive from speficying individual attributes
+All the command command dword 11 attributes\&. Use exclusive from specifying individual attributes
 .RE
 .SH "EXAMPLES"
 .sp
index 7621b2df9ce057c46a9b5c56b076e62a0943486f..1466d4945e7e9e19d5a3b3b739874e86a5fdabe5 100644 (file)
@@ -872,8 +872,8 @@ any settings from the flags may have provided.</p></div>
 </dt>\r
 <dd>\r
 <p>\r
-        All the command command dword 11 attribuets. Use exclusive from\r
-        speficying individual attributes\r
+        All the command command dword 11 attributes. Use exclusive from\r
+        specifying individual attributes\r
 </p>\r
 </dd>\r
 </dl></div>\r
@@ -895,7 +895,7 @@ any settings from the flags may have provided.</p></div>
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-10-23 16:50:00 MDT\r
+Last updated 2016-02-26 08:25:50 MST\r
 </div>\r
 </div>\r
 </body>\r
index 9afedc6bd381249d1a40f4d1f32fdeefa2fe4740..e81de14cc9632c569dc5e6704a206278a8b348c5 100644 (file)
@@ -70,8 +70,8 @@ OPTIONS
 
 -c <cdw11>::
 --cdw11=<cdw11>::
-       All the command command dword 11 attribuets. Use exclusive from
-       speficying individual attributes
+       All the command command dword 11 attributes. Use exclusive from
+       specifying individual attributes
 
 EXAMPLES
 --------
index 9e863a3dfc00078ad0b30399e4bbbda342be18a5..fb83646875c3aa83d892575fa6d2006fb74ba9c0 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-error-log
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/08/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-ERROR\-LOG" "1" "06/08/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-ERROR\-LOG" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -47,7 +47,7 @@ On success, the returned error log structure may be returned in one of several w
 .PP
 \-n <nsid>, \-\-namespace\-id=<nsid>
 .RS 4
-Retrieve the Error Log for the given nsid\&. This is optional and its success may depend on the device\(cqs capabilities to provide this log on a per\-namespace basis (see the NVMe Identify Controller for this capability)\&. The defualt nsid to use is 0xffffffff for the device global error log\&.
+Retrieve the Error Log for the given nsid\&. This is optional and its success may depend on the device\(cqs capabilities to provide this log on a per\-namespace basis (see the NVMe Identify Controller for this capability)\&. The default nsid to use is 0xffffffff for the device global error log\&.
 .RE
 .PP
 \-e <entries>, \-\-log\-entries=<entries>
index ba9ad103f43364a159ec6eee1f89bb9ea7d30b3e..5a20df98d72e341cb5d7c49145841335eb2db92c 100644 (file)
@@ -787,7 +787,7 @@ printed to stdout for another program to parse.</p></div>
         Retrieve the Error Log for the given nsid. This is optional\r
         and its success may depend on the device&#8217;s capabilities to\r
         provide this log on a per-namespace basis (see the NVMe Identify\r
-        Controller for this capability). The defualt nsid to use is\r
+        Controller for this capability). The default nsid to use is\r
         0xffffffff for the device global error log.\r
 </p>\r
 </dd>\r
@@ -854,7 +854,7 @@ Print the raw output to a file:
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-05-11 13:55:59 MDT\r
+Last updated 2016-02-26 08:25:58 MST\r
 </div>\r
 </div>\r
 </body>\r
index dfc75adad82157ded61c2db35e1f5be08fd0ebdc..f512760d5e726d70b0e39acdd795fea5efc43ed1 100644 (file)
@@ -32,7 +32,7 @@ OPTIONS
        Retrieve the Error Log for the given nsid. This is optional
        and its success may depend on the device's capabilities to
        provide this log on a per-namespace basis (see the NVMe Identify
-       Controller for this capability). The defualt nsid to use is
+       Controller for this capability). The default nsid to use is
        0xffffffff for the device global error log.
 
 -e <entries>::
index b23ae63a0ddd692f4f389cc6e5ec95c6f60a39fe..b2f74fd3d80dbfdf88ea4120d6fbb6a98d9199ce 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-flush
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/09/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-FLUSH" "1" "06/09/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-FLUSH" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
index 2487162f49fb3ef500144085f392fc9cef7cb222..59d365c9da5a70a357f4871d46a78620fb32a202 100644 (file)
@@ -802,7 +802,7 @@ any namespace.</p></div>
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-02-09 08:30:40 MST\r
+Last updated 2016-02-26 08:26:16 MST\r
 </div>\r
 </div>\r
 </body>\r
index d3a8815d2234dba4a0e41ec945a22fb13a3e2d2e..5cafee96ed158bfc6a971e7f52e9e4012816cf37 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-format
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/08/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-FORMAT" "1" "06/08/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-FORMAT" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -60,7 +60,7 @@ LBA Format: This field specifies the LBA format to apply to the NVM media\&. Thi
 .PP
 \-s <ses>, \-\-ses=<ses>
 .RS 4
-Secure Erase Settings: This field specifies whether a secure erase should be performed as part of the format and the type of the secureerase operation\&. The erase applies to all user data, regardless of location (e\&.g\&., within an exposed LBA, within a cache, within deallocated LBAs, etc)\&. Defaults to 0\&.
+Secure Erase Settings: This field specifies whether a secure erase should be performed as part of the format and the type of the secure erase operation\&. The erase applies to all user data, regardless of location (e\&.g\&., within an exposed LBA, within a cache, within deallocated LBAs, etc)\&. Defaults to 0\&.
 .TS
 allbox tab(:);
 lt lt
index 248076400e92975fe5905748ca421de72cb9ce46..7941d599a71c23583ec9ee2918a498559d9ec04f 100644 (file)
@@ -821,7 +821,7 @@ for the new block size to be visible.</p></div>
 <p>\r
         Secure Erase Settings: This field specifies whether a secure\r
         erase should be performed as part of the format and the type of\r
-        the secureerase operation. The erase applies to all user data,\r
+        the secure erase operation. The erase applies to all user data,\r
         regardless of location (e.g., within an exposed LBA, within a\r
         cache, within deallocated LBAs, etc). Defaults to 0.\r
 </p>\r
@@ -978,7 +978,7 @@ information:
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-02-09 08:30:40 MST\r
+Last updated 2016-02-26 08:26:37 MST\r
 </div>\r
 </div>\r
 </body>\r
index 99b3049ecf637ff530686ff6fe2428db98129075..92b4f616320dd2b3a21f3e9f5d0eba4a287473d7 100644 (file)
@@ -26,7 +26,7 @@ If the character device is given, the namespace identifer will default
 to 0xffffffff to send the format to all namespace, but can be overridden
 to any namespace with the 'namespace-id' option. If the block device
 is given, the namespace identifier will default to the namespace id of
-the block device given, but can be overriden with the same option.
+the block device given, but can be overridden with the same option.
 
 On success, the program will automatically issue BLKRRPART ioctl to
 force rescanning the namespaces. If the driver is recent enough, this
@@ -52,7 +52,7 @@ OPTIONS
 --ses=<ses>::
        Secure Erase Settings: This field specifies whether a secure
        erase should be performed as part of the format and the type of
-       the secureerase operation. The erase applies to all user data,
+       the secure erase operation. The erase applies to all user data,
        regardless of location (e.g., within an exposed LBA, within a
        cache, within deallocated LBAs, etc). Defaults to 0.
 +
index 0a315e325dde08558fa1cd11cc750fa2216f5585..09b60ba105dddcdd8c74f4ae4aa7275061a4f57f 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-get-feature
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/08/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-GET\-FEATURE" "1" "06/08/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-GET\-FEATURE" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -174,7 +174,7 @@ Retrieves the feature for the some vendor specific feature and specifically requ
 .RS 4
 .\}
 .nf
-# nvme get\-feature /dev/nvme0 \-f c0 \-l 512
+# nvme get\-feature /dev/nvme0 \-f 0xc0 \-l 512
 .fi
 .if n \{\
 .RE
index 9d63700d8bb462ce68d4fda1a24d1a6eca38886e..4b668449dfd804636824998ac3d9de3db61cb927 100644 (file)
@@ -920,7 +920,7 @@ will be displayed to the user in as a hex dump:
 </p>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt># nvme get-feature /dev/nvme0 -f c0 -l 512</tt></pre>\r
+<pre><tt># nvme get-feature /dev/nvme0 -f 0xc0 -l 512</tt></pre>\r
 </div></div>\r
 </li>\r
 <li>\r
@@ -948,7 +948,7 @@ format:
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-02-09 08:30:40 MST\r
+Last updated 2016-02-26 08:27:10 MST\r
 </div>\r
 </div>\r
 </body>\r
index 459f38c7ba1251b8043128c1e20378b4afdfbe84..4be581f5437542f3ef061c4310becf8235fc0249 100644 (file)
@@ -94,7 +94,7 @@ specifically requesting a buffer be allocate for this feature, which
 will be displayed to the user in as a hex dump:
 +
 ------------
-# nvme get-feature /dev/nvme0 -f c0 -l 512
+# nvme get-feature /dev/nvme0 -f 0xc0 -l 512
 ------------
 +
 
index 00a74a678293f7998a81196a8134bfcb7d01a9fa..a6b98ad1b61440c71a4baef28d67770a56392a16 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-id-ctrl
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/08/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-ID\-CTRL" "1" "06/08/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-CTRL" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -55,7 +55,7 @@ In addition to parsing known fields, this option will dump the vendor specific r
 .PP
 \-H, \-\-human\-readable
 .RS 4
-This option will parse and format many of the bitfields into human\-readable formats\&.
+This option will parse and format many of the bit fields into human\-readable formats\&.
 .RE
 .SH "EXAMPLES"
 .sp
index f1cf463c1596d73df793e2a0449edc54788efff8..0224f7a1e8598357457129b3dedafa16ecf7f56d 100644 (file)
@@ -806,7 +806,7 @@ raw buffer may be printed to stdout.</p></div>
 </dt>\r
 <dd>\r
 <p>\r
-        This option will parse and format many of the bitfields\r
+        This option will parse and format many of the bit fields\r
         into human-readable formats.\r
 </p>\r
 </dd>\r
@@ -899,7 +899,7 @@ int main(int argc, char **argv)
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-05-12 13:35:56 MDT\r
+Last updated 2016-02-26 08:27:44 MST\r
 </div>\r
 </div>\r
 </body>\r
index 89b5a768c49436316dea6a84fa9ab2823b0bd86a..2966403dfdec8d3b408f3566846150adf0e60b33 100644 (file)
@@ -37,7 +37,7 @@ OPTIONS
 
 -H::
 --human-readable::
-       This option will parse and format many of the bitfields
+       This option will parse and format many of the bit fields
        into human-readable formats.
 
 
index f857a59268c2f0fb3e1f9473fba9e5eb6d96c81e..31b68240ea7ff03da146f840dd722da7709b7eb6 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-id-ns
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/08/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-ID\-NS" "1" "06/08/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-NS" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -61,7 +61,7 @@ In addition to parsing known fields, this option will dump the vendor specific r
 .PP
 \-H, \-\-human\-readable
 .RS 4
-This option will parse and format many of the bitfields into human\-readable formats\&.
+This option will parse and format many of the bit fields into human\-readable formats\&.
 .RE
 .SH "EXAMPLES"
 .sp
index fc932b8462496d4bb8ac32bead48349e7b268a8a..150514ed5846f937c51738ddf5dbac914860b722 100644 (file)
@@ -824,7 +824,7 @@ raw buffer may be printed to stdout.</p></div>
 </dt>\r
 <dd>\r
 <p>\r
-        This option will parse and format many of the bitfields\r
+        This option will parse and format many of the bit fields\r
         into human-readable formats.\r
 </p>\r
 </dd>\r
@@ -929,7 +929,7 @@ int main(int argc, char **argv)
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-05-12 13:35:56 MDT\r
+Last updated 2016-02-26 08:27:57 MST\r
 </div>\r
 </div>\r
 </body>\r
index 6d27ec26c435076113f196e07ec501a608798d53..912676af91c68fc12414acb999c7cefb72cbf581 100644 (file)
@@ -48,7 +48,7 @@ OPTIONS
 
 -H::
 --human-readable::
-       This option will parse and format many of the bitfields
+       This option will parse and format many of the bit fields
        into human-readable formats.
 
 
index d086bf397f26c006a4bbaf0e370cd4f75b9a5c52..6d865caeb4d81672bdbfd861b7579a5cd8b19e9e 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-id-ns
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/08/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-ID\-NS" "1" "06/08/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-NS" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -60,7 +60,7 @@ Retrieve the identify list structure starting with the given controller id\&.
 .PP
 \-n <nsid>, \-\-namespace\-id=<nsid>
 .RS 4
-If provided, will request the controllers attached to the specified namespace\&. If no namespace is given, or set to 0, the command requests the controller list for the entire subsystem, whether or not they are attached to namesapce(s)\&.
+If provided, will request the controllers attached to the specified namespace\&. If no namespace is given, or set to 0, the command requests the controller list for the entire subsystem, whether or not they are attached to namespace(s)\&.
 .RE
 .SH "EXAMPLES"
 .sp
index 1c7297fbdc188245ed980b1e404bd7e0f158dfbd..fab7f24f1dc213f414331192be99db6315e2eacc 100644 (file)
@@ -796,7 +796,7 @@ OPTIONS</tt></pre>
         If provided, will request the controllers attached to the\r
         specified namespace. If no namespace is given, or set to 0, the\r
         command requests the controller list for the entire subsystem,\r
-        whether or not they are attached to namesapce(s).\r
+        whether or not they are attached to namespace(s).\r
 </p>\r
 </dd>\r
 </dl></div>\r
@@ -818,7 +818,7 @@ OPTIONS</tt></pre>
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-06-08 16:59:37 MDT\r
+Last updated 2016-02-26 08:28:20 MST\r
 </div>\r
 </div>\r
 </body>\r
index 640092e482391bcd43c4ed283a507b075adeafc8..1499541369c86b4d7997e169f45df5a22d7e9b75 100644 (file)
@@ -35,7 +35,7 @@ OPTIONS
        If provided, will request the controllers attached to the
        specified namespace. If no namespace is given, or set to 0, the
        command requests the controller list for the entire subsystem,
-       whether or not they are attached to namesapce(s).
+       whether or not they are attached to namespace(s).
 
 EXAMPLES
 --------
index 6a36563cd1b00c67febb47a5e324a6e3567b1cf7..2ee59b7dd73ed8454f0b90bd22e43424c7f9bec0 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-list
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/08/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-LIST" "1" "06/08/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-LIST" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -36,7 +36,7 @@ nvme-list \- List all recognized NVMe devices
 .fi
 .SH "DESCRIPTION"
 .sp
-Scan the sysfs tree for NVM Express devices and return the /dev node for those devices as well as some pertinant information about them\&.
+Scan the sysfs tree for NVM Express devices and return the /dev node for those devices as well as some pertinent information about them\&.
 .SH "OPTIONS"
 .sp
 No options yet\&.
index fcd4c1efc94ef16e20efca6cc742dd3e684fee84..418c807702ff872967be8d5931cfbede1af7e902 100644 (file)
@@ -761,7 +761,7 @@ nvme-list(1) Manual Page
 <h2 id="_description">DESCRIPTION</h2>\r
 <div class="sectionbody">\r
 <div class="paragraph"><p>Scan the sysfs tree for NVM Express devices and return the /dev node\r
-for those devices as well as some pertinant information about them.</p></div>\r
+for those devices as well as some pertinent information about them.</p></div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
@@ -786,7 +786,7 @@ for those devices as well as some pertinant information about them.</p></div>
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-02-09 08:30:40 MST\r
+Last updated 2016-02-26 08:28:41 MST\r
 </div>\r
 </div>\r
 </body>\r
index edb77b7f163f74b38a99fc05d9dfbac91659f1cb..ae69f8a4aca5b0e4aabf71c91cc1da90a27c7da7 100644 (file)
@@ -13,7 +13,7 @@ SYNOPSIS
 DESCRIPTION
 -----------
 Scan the sysfs tree for NVM Express devices and return the /dev node
-for those devices as well as some pertinant information about them.
+for those devices as well as some pertinent information about them.
 
 OPTIONS
 -------
index 0341bb67b6be31ef4245ebc35371642cdf5f120f..f0e5f9d9fd3ad3315bd22ab2af222fe087d928e9 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-resv-register
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/08/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-RESV\-REGISTER" "1" "06/08/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-RESV\-REGISTER" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
index 345546b4341925591a304c8c69eb82be232f8eaf..eafce25dbcc617f754918417c41ebd6bb86cc01f 100644 (file)
@@ -934,7 +934,7 @@ cellspacing="0" cellpadding="4">
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-02-09 08:30:40 MST\r
+Last updated 2016-02-26 08:28:55 MST\r
 </div>\r
 </div>\r
 </body>\r
index a6b24d302e025d26791841b626fbae8bb8f262a2..3716447645914344e447ba88e317bb131eda2355 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-set-feature
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/08/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-SET\-FEATURE" "1" "06/08/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-SET\-FEATURE" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -64,7 +64,7 @@ The data length for the buffer submitted for this feature\&. Most known features
 .PP
 \-d <data\-file>, \-\-data=<data\-file>
 .RS 4
-The data file for the buffer submitted for this feature\&. Most known features do not use this value\&. The exceptions is LBA Range Type and host identifier\&. This defaults to STDIN so files and echos can be piped\&.
+The data file for the buffer submitted for this feature\&. Most known features do not use this value\&. The exceptions is LBA Range Type and host identifier\&. This defaults to STDIN so files and echo can be piped\&.
 .RE
 .PP
 \-\-value=<value>
@@ -129,7 +129,7 @@ Retrieves the feature for the some vendor specific feature and specifically requ
 .RS 4
 .\}
 .nf
-# nvme set\-feature /dev/nvme0 \-f c0 \-l 512
+# nvme set\-feature /dev/nvme0 \-f 0xc0 \-l 512
 .fi
 .if n \{\
 .RE
index dabff31bb1bc4c8ad9cf889334aa49b8fa6b00a9..2f507fab212a57dd96dd7827caac3b3bcaf107af 100644 (file)
@@ -828,7 +828,7 @@ printed to stdout for another program to parse.</p></div>
         The data file for the buffer submitted for this feature. Most\r
         known features do not use this value. The exceptions is LBA\r
         Range Type and host identifier. This defaults to STDIN so files\r
-        and echos can be piped.\r
+        and echo can be piped.\r
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
@@ -875,7 +875,7 @@ will be displayed to the user in as a hex dump:
 </p>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt># nvme set-feature /dev/nvme0 -f c0 -l 512</tt></pre>\r
+<pre><tt># nvme set-feature /dev/nvme0 -f 0xc0 -l 512</tt></pre>\r
 </div></div>\r
 </li>\r
 <li>\r
@@ -912,7 +912,7 @@ format:
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-03-20 09:11:33 MDT\r
+Last updated 2016-02-26 08:29:25 MST\r
 </div>\r
 </div>\r
 </body>\r
index 7bbd66d86911f522ef25379c26c0dff9a995402d..50a5856dd47fe6b3bdc03da10e2e6fe1c675f9e5 100644 (file)
@@ -52,7 +52,7 @@ OPTIONS
        The data file for the buffer submitted for this feature. Most
        known features do not use this value. The exceptions is LBA
        Range Type and host identifier. This defaults to STDIN so files
-       and echos can be piped.
+       and echo can be piped.
 
 --value=<value>::
        The value for command dword 11, the value you want to set the
@@ -82,7 +82,7 @@ specifically requesting a buffer be allocate for this feature, which
 will be displayed to the user in as a hex dump:
 +
 ------------
-# nvme set-feature /dev/nvme0 -f c0 -l 512
+# nvme set-feature /dev/nvme0 -f 0xc0 -l 512
 ------------
 +
 
index c18aa434bcdc99eaad8aa99acc7802aa5655d748..4d479565f905a7eaedaec1e59aac1c73b086a315 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-smart-log
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/08/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-SMART\-LOG" "1" "06/08/2015" "NVMe" "NVMe Manual"
+.TH "NVME\-SMART\-LOG" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -46,7 +46,7 @@ On success, the returned f/w log structure may be returned in one of several way
 .PP
 \-n <nsid>, \-\-namespace\-id=<nsid>
 .RS 4
-Retrieve the SMART log for the given nsid\&. This is optional and its success may depend on the device\(cqs capabilities to provide this log on a per\-namespace basis (see the NVMe Identify Controller for this capability)\&. The defualt nsid to use is 0xffffffff for the device global SMART log\&.
+Retrieve the SMART log for the given nsid\&. This is optional and its success may depend on the device\(cqs capabilities to provide this log on a per\-namespace basis (see the NVMe Identify Controller for this capability)\&. The default nsid to use is 0xffffffff for the device global SMART log\&.
 .RE
 .PP
 \-b, \-\-raw\-binary
index b4f2542c27fab810135b2d829ee8aa5abaa27d52..0f3d4c94ef03cd266fd510dd3aa23cff8ba698a6 100644 (file)
@@ -785,7 +785,7 @@ printed to stdout for another program to parse.</p></div>
         Retrieve the SMART log for the given nsid. This is optional\r
         and its success may depend on the device&#8217;s capabilities to\r
         provide this log on a per-namespace basis (see the NVMe Identify\r
-        Controller for this capability). The defualt nsid to use is\r
+        Controller for this capability). The default nsid to use is\r
         0xffffffff for the device global SMART log.\r
 </p>\r
 </dd>\r
@@ -839,7 +839,7 @@ Print the raw SMART log to a file:
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-02-09 08:30:40 MST\r
+Last updated 2016-02-26 08:29:40 MST\r
 </div>\r
 </div>\r
 </body>\r
index 443caabe33b29a825a5c1753fb88a6bf454d997e..c0c7791963aef1c6031b8aea3615089b695ee541 100644 (file)
@@ -30,7 +30,7 @@ OPTIONS
        Retrieve the SMART log for the given nsid. This is optional
        and its success may depend on the device's capabilities to
        provide this log on a per-namespace basis (see the NVMe Identify
-       Controller for this capability). The defualt nsid to use is
+       Controller for this capability). The default nsid to use is
        0xffffffff for the device global SMART log.
 
 -b::
index 59deac971372071c016ab12101a59611c45d4db3..850ca06a18aa85f245fdaacadac679d206b3b971 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme
 .\"    Author: [see the "Authors" section]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 06/08/2015
+.\"      Date: 02/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME" "1" "06/08/2015" "NVMe" "NVMe Manual"
+.TH "NVME" "1" "02/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -36,9 +36,9 @@ nvme \- the dumb pci\-e storage utility
 .fi
 .SH "DESCRIPTION"
 .sp
-NVM\-Express is a fast, scalabale host controller interface designed to address the needs for PCI Express based solida state drives\&.
+NVM\-Express is a fast, scalable host controller interface designed to address the needs for PCI Express based solid state drives\&.
 .sp
-This \fInvme\fR program is a user space utility to provide standards compliant tooling for NVM\-Express drives\&. It was made specifically for Linux as it relies on the IOCTLs defined by the mailine kernel driver\&.
+This \fInvme\fR program is a user space utility to provide standards compliant tooling for NVM\-Express drives\&. It was made specifically for Linux as it relies on the IOCTLs defined by the mainline kernel driver\&.
 .SH "NVME COMMANDS"
 .sp
 The utility has sub\-commands for all admin and io commands defined in the specification and for displaying controller registers\&. There is also an option to submit completely arbitrary commands\&. For a list of commands available, run "nvme help"\&.
@@ -65,6 +65,11 @@ Retrieve error logs
 Submit flush
 .RE
 .PP
+\fBnvme-dms\fR(1)
+.RS 4
+Submit Data Set Management
+.RE
+.PP
 \fBnvme-format\fR(1)
 .RS 4
 Format namespace(s)
index f57cc57d0ecd0e29763ef92f5e0613324531659b..8d7495c01339b0c51e21bfcd2676ff25a8855e59 100644 (file)
@@ -760,11 +760,11 @@ nvme(1) Manual Page
 <div class="sect1">\r
 <h2 id="_description">DESCRIPTION</h2>\r
 <div class="sectionbody">\r
-<div class="paragraph"><p>NVM-Express is a fast, scalabale host controller interface designed to\r
-address the needs for PCI Express based solida state drives.</p></div>\r
+<div class="paragraph"><p>NVM-Express is a fast, scalable host controller interface designed to\r
+address the needs for PCI Express based solid state drives.</p></div>\r
 <div class="paragraph"><p>This <em>nvme</em> program is a user space utility to provide standards compliant\r
 tooling for NVM-Express drives. It was made specifically for Linux as\r
-it relies on the IOCTLs defined by the mailine kernel driver.</p></div>\r
+it relies on the IOCTLs defined by the mainline kernel driver.</p></div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
@@ -815,6 +815,14 @@ available, run "nvme help".</p></div>
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+<a href="nvme-dms.html">nvme-dms(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Submit Data Set Management\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 <a href="nvme-format.html">nvme-format(1)</a>\r
 </dt>\r
 <dd>\r
@@ -1080,7 +1088,7 @@ NVM-Express Site</a>.</p></div>
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2015-05-29 09:18:27 MDT\r
+Last updated 2016-02-26 08:22:43 MST\r
 </div>\r
 </div>\r
 </body>\r
index 62a66d0e3ce32b483cfc16ea45105395252f02b5..dcbc6604904c2156a6158d43c0c8ec6abf5072dc 100644 (file)
@@ -12,12 +12,12 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-NVM-Express is a fast, scalabale host controller interface designed to
-address the needs for PCI Express based solida state drives.
+NVM-Express is a fast, scalable host controller interface designed to
+address the needs for PCI Express based solid state drives.
 
 This 'nvme' program is a user space utility to provide standards compliant
 tooling for NVM-Express drives. It was made specifically for Linux as
-it relies on the IOCTLs defined by the mailine kernel driver.
+it relies on the IOCTLs defined by the mainline kernel driver.
 
 NVME COMMANDS
 -------------