From: Keith Busch Date: Fri, 26 Feb 2016 15:30:21 +0000 (-0700) Subject: Documenation fixes X-Git-Tag: v0.4~5 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=3ae8c973742999a22129568f5cf80644ededc37b;p=users%2Fsagi%2Fnvme-cli.git Documenation fixes Addresing typos and a few subtle incorrect usages. '0x' is a required prefix for parsing hex numbers. Signed-off-by: Keith Busch --- diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1 index 8bfa1cc1..7be84bc4 100644 --- a/Documentation/nvme-admin-passthru.1 +++ b/Documentation/nvme-admin-passthru.1 @@ -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 -.\" 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 diff --git a/Documentation/nvme-admin-passthru.html b/Documentation/nvme-admin-passthru.html index a7612298..a955088d 100644 --- a/Documentation/nvme-admin-passthru.html +++ b/Documentation/nvme-admin-passthru.html @@ -931,7 +931,7 @@ printed to stdout for another program to parse.

  • 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

    @@ -962,7 +962,7 @@ Or if you want to save that structure to a file:
    diff --git a/Documentation/nvme-admin-passthru.txt b/Documentation/nvme-admin-passthru.txt index c0b58960..a107a04e 100644 --- a/Documentation/nvme-admin-passthru.txt +++ b/Documentation/nvme-admin-passthru.txt @@ -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 + diff --git a/Documentation/nvme-detach-ns.1 b/Documentation/nvme-detach-ns.1 index 1135ba84..8539ecc9 100644 --- a/Documentation/nvme-detach-ns.1 +++ b/Documentation/nvme-detach-ns.1 @@ -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 -.\" 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 .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-detach-ns.html b/Documentation/nvme-detach-ns.html index 68e8922b..eed4a127 100644 --- a/Documentation/nvme-detach-ns.html +++ b/Documentation/nvme-detach-ns.html @@ -812,7 +812,7 @@ controller identifiers.

    diff --git a/Documentation/nvme-dsm.1 b/Documentation/nvme-dsm.1 index e29f0d5d..4af74562 100644 --- a/Documentation/nvme-dsm.1 +++ b/Documentation/nvme-dsm.1 @@ -2,12 +2,12 @@ .\" Title: nvme-dsm .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.76.1 -.\" 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= .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 diff --git a/Documentation/nvme-dsm.html b/Documentation/nvme-dsm.html index 7621b2df..1466d494 100644 --- a/Documentation/nvme-dsm.html +++ b/Documentation/nvme-dsm.html @@ -872,8 +872,8 @@ any settings from the flags may have provided.

    - 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

    @@ -895,7 +895,7 @@ any settings from the flags may have provided.

    diff --git a/Documentation/nvme-dsm.txt b/Documentation/nvme-dsm.txt index 9afedc6b..e81de14c 100644 --- a/Documentation/nvme-dsm.txt +++ b/Documentation/nvme-dsm.txt @@ -70,8 +70,8 @@ OPTIONS -c :: --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 -------- diff --git a/Documentation/nvme-error-log.1 b/Documentation/nvme-error-log.1 index 9e863a3d..fb836468 100644 --- a/Documentation/nvme-error-log.1 +++ b/Documentation/nvme-error-log.1 @@ -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 -.\" 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 , \-\-namespace\-id= .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 , \-\-log\-entries= diff --git a/Documentation/nvme-error-log.html b/Documentation/nvme-error-log.html index ba9ad103..5a20df98 100644 --- a/Documentation/nvme-error-log.html +++ b/Documentation/nvme-error-log.html @@ -787,7 +787,7 @@ printed to stdout for another program to parse.

    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.

    @@ -854,7 +854,7 @@ Print the raw output to a file:
    diff --git a/Documentation/nvme-error-log.txt b/Documentation/nvme-error-log.txt index dfc75ada..f512760d 100644 --- a/Documentation/nvme-error-log.txt +++ b/Documentation/nvme-error-log.txt @@ -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 :: diff --git a/Documentation/nvme-flush.1 b/Documentation/nvme-flush.1 index b23ae63a..b2f74fd3 100644 --- a/Documentation/nvme-flush.1 +++ b/Documentation/nvme-flush.1 @@ -2,12 +2,12 @@ .\" Title: nvme-flush .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.76.1 -.\" 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 .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-flush.html b/Documentation/nvme-flush.html index 2487162f..59d365c9 100644 --- a/Documentation/nvme-flush.html +++ b/Documentation/nvme-flush.html @@ -802,7 +802,7 @@ any namespace.

    diff --git a/Documentation/nvme-format.1 b/Documentation/nvme-format.1 index d3a8815d..5cafee96 100644 --- a/Documentation/nvme-format.1 +++ b/Documentation/nvme-format.1 @@ -2,12 +2,12 @@ .\" Title: nvme-format .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.76.1 -.\" 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= .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 diff --git a/Documentation/nvme-format.html b/Documentation/nvme-format.html index 24807640..7941d599 100644 --- a/Documentation/nvme-format.html +++ b/Documentation/nvme-format.html @@ -821,7 +821,7 @@ for the new block size to be visible.

    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.

    @@ -978,7 +978,7 @@ information:
    diff --git a/Documentation/nvme-format.txt b/Documentation/nvme-format.txt index 99b3049e..92b4f616 100644 --- a/Documentation/nvme-format.txt +++ b/Documentation/nvme-format.txt @@ -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=:: 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. + diff --git a/Documentation/nvme-get-feature.1 b/Documentation/nvme-get-feature.1 index 0a315e32..09b60ba1 100644 --- a/Documentation/nvme-get-feature.1 +++ b/Documentation/nvme-get-feature.1 @@ -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 -.\" 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 diff --git a/Documentation/nvme-get-feature.html b/Documentation/nvme-get-feature.html index 9d63700d..4b668449 100644 --- a/Documentation/nvme-get-feature.html +++ b/Documentation/nvme-get-feature.html @@ -920,7 +920,7 @@ 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
  • @@ -948,7 +948,7 @@ format:
    diff --git a/Documentation/nvme-get-feature.txt b/Documentation/nvme-get-feature.txt index 459f38c7..4be581f5 100644 --- a/Documentation/nvme-get-feature.txt +++ b/Documentation/nvme-get-feature.txt @@ -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 ------------ + diff --git a/Documentation/nvme-id-ctrl.1 b/Documentation/nvme-id-ctrl.1 index 00a74a67..a6b98ad1 100644 --- a/Documentation/nvme-id-ctrl.1 +++ b/Documentation/nvme-id-ctrl.1 @@ -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 -.\" 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 diff --git a/Documentation/nvme-id-ctrl.html b/Documentation/nvme-id-ctrl.html index f1cf463c..0224f7a1 100644 --- a/Documentation/nvme-id-ctrl.html +++ b/Documentation/nvme-id-ctrl.html @@ -806,7 +806,7 @@ raw buffer may be printed to stdout.

    - 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.

    @@ -899,7 +899,7 @@ int main(int argc, char **argv)
    diff --git a/Documentation/nvme-id-ctrl.txt b/Documentation/nvme-id-ctrl.txt index 89b5a768..2966403d 100644 --- a/Documentation/nvme-id-ctrl.txt +++ b/Documentation/nvme-id-ctrl.txt @@ -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. diff --git a/Documentation/nvme-id-ns.1 b/Documentation/nvme-id-ns.1 index f857a592..31b68240 100644 --- a/Documentation/nvme-id-ns.1 +++ b/Documentation/nvme-id-ns.1 @@ -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 -.\" 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 diff --git a/Documentation/nvme-id-ns.html b/Documentation/nvme-id-ns.html index fc932b84..150514ed 100644 --- a/Documentation/nvme-id-ns.html +++ b/Documentation/nvme-id-ns.html @@ -824,7 +824,7 @@ raw buffer may be printed to stdout.

    - 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.

    @@ -929,7 +929,7 @@ int main(int argc, char **argv)
    diff --git a/Documentation/nvme-id-ns.txt b/Documentation/nvme-id-ns.txt index 6d27ec26..912676af 100644 --- a/Documentation/nvme-id-ns.txt +++ b/Documentation/nvme-id-ns.txt @@ -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. diff --git a/Documentation/nvme-list-ctrl.1 b/Documentation/nvme-list-ctrl.1 index d086bf39..6d865cae 100644 --- a/Documentation/nvme-list-ctrl.1 +++ b/Documentation/nvme-list-ctrl.1 @@ -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 -.\" 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 , \-\-namespace\-id= .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 diff --git a/Documentation/nvme-list-ctrl.html b/Documentation/nvme-list-ctrl.html index 1c7297fb..fab7f24f 100644 --- a/Documentation/nvme-list-ctrl.html +++ b/Documentation/nvme-list-ctrl.html @@ -796,7 +796,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).

    @@ -818,7 +818,7 @@ OPTIONS
    diff --git a/Documentation/nvme-list-ctrl.txt b/Documentation/nvme-list-ctrl.txt index 640092e4..14995413 100644 --- a/Documentation/nvme-list-ctrl.txt +++ b/Documentation/nvme-list-ctrl.txt @@ -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 -------- diff --git a/Documentation/nvme-list.1 b/Documentation/nvme-list.1 index 6a36563c..2ee59b7d 100644 --- a/Documentation/nvme-list.1 +++ b/Documentation/nvme-list.1 @@ -2,12 +2,12 @@ .\" Title: nvme-list .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.76.1 -.\" 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\&. diff --git a/Documentation/nvme-list.html b/Documentation/nvme-list.html index fcd4c1ef..418c8077 100644 --- a/Documentation/nvme-list.html +++ b/Documentation/nvme-list.html @@ -761,7 +761,7 @@ nvme-list(1) Manual Page

    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.

    @@ -786,7 +786,7 @@ for those devices as well as some pertinant information about them.

    diff --git a/Documentation/nvme-list.txt b/Documentation/nvme-list.txt index edb77b7f..ae69f8a4 100644 --- a/Documentation/nvme-list.txt +++ b/Documentation/nvme-list.txt @@ -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 ------- diff --git a/Documentation/nvme-resv-register.1 b/Documentation/nvme-resv-register.1 index 0341bb67..f0e5f9d9 100644 --- a/Documentation/nvme-resv-register.1 +++ b/Documentation/nvme-resv-register.1 @@ -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 -.\" 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 .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-resv-register.html b/Documentation/nvme-resv-register.html index 345546b4..eafce25d 100644 --- a/Documentation/nvme-resv-register.html +++ b/Documentation/nvme-resv-register.html @@ -934,7 +934,7 @@ cellspacing="0" cellpadding="4">
    diff --git a/Documentation/nvme-set-feature.1 b/Documentation/nvme-set-feature.1 index a6b24d30..37164476 100644 --- a/Documentation/nvme-set-feature.1 +++ b/Documentation/nvme-set-feature.1 @@ -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 -.\" 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= .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= @@ -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 diff --git a/Documentation/nvme-set-feature.html b/Documentation/nvme-set-feature.html index dabff31b..2f507fab 100644 --- a/Documentation/nvme-set-feature.html +++ b/Documentation/nvme-set-feature.html @@ -828,7 +828,7 @@ printed to stdout for another program to parse.

    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.

    @@ -875,7 +875,7 @@ 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
  • @@ -912,7 +912,7 @@ format:
    diff --git a/Documentation/nvme-set-feature.txt b/Documentation/nvme-set-feature.txt index 7bbd66d8..50a5856d 100644 --- a/Documentation/nvme-set-feature.txt +++ b/Documentation/nvme-set-feature.txt @@ -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=:: 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 ------------ + diff --git a/Documentation/nvme-smart-log.1 b/Documentation/nvme-smart-log.1 index c18aa434..4d479565 100644 --- a/Documentation/nvme-smart-log.1 +++ b/Documentation/nvme-smart-log.1 @@ -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 -.\" 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 , \-\-namespace\-id= .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 diff --git a/Documentation/nvme-smart-log.html b/Documentation/nvme-smart-log.html index b4f2542c..0f3d4c94 100644 --- a/Documentation/nvme-smart-log.html +++ b/Documentation/nvme-smart-log.html @@ -785,7 +785,7 @@ printed to stdout for another program to parse.

    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.

    @@ -839,7 +839,7 @@ Print the raw SMART log to a file:
    diff --git a/Documentation/nvme-smart-log.txt b/Documentation/nvme-smart-log.txt index 443caabe..c0c77919 100644 --- a/Documentation/nvme-smart-log.txt +++ b/Documentation/nvme-smart-log.txt @@ -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:: diff --git a/Documentation/nvme.1 b/Documentation/nvme.1 index 59deac97..850ca06a 100644 --- a/Documentation/nvme.1 +++ b/Documentation/nvme.1 @@ -2,12 +2,12 @@ .\" Title: nvme .\" Author: [see the "Authors" section] .\" Generator: DocBook XSL Stylesheets v1.76.1 -.\" 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) diff --git a/Documentation/nvme.html b/Documentation/nvme.html index f57cc57d..8d7495c0 100644 --- a/Documentation/nvme.html +++ b/Documentation/nvme.html @@ -760,11 +760,11 @@ nvme(1) Manual Page

    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.

    @@ -815,6 +815,14 @@ available, run "nvme help".

    +nvme-dms(1) +
    +
    +

    + Submit Data Set Management +

    +
    +
    nvme-format(1)
    @@ -1080,7 +1088,7 @@ NVM-Express Site.

    diff --git a/Documentation/nvme.txt b/Documentation/nvme.txt index 62a66d0e..dcbc6604 100644 --- a/Documentation/nvme.txt +++ b/Documentation/nvme.txt @@ -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 -------------