]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
doc: Documentations maintenance changes
authorTokunori Ikegami <ikegami.t@gmail.com>
Tue, 11 Apr 2023 16:34:47 +0000 (01:34 +0900)
committerDaniel Wagner <wagi@monom.org>
Wed, 12 Apr 2023 13:33:53 +0000 (15:33 +0200)
Change the following commands documentations.
  1. admin-passthru
  2. get-feature
  3. set-feature
  4. clear-fw-activate-history

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
Documentation/nvme-admin-passthru.txt
Documentation/nvme-get-feature.txt
Documentation/nvme-ocp-clear-fw-activate-history.txt
Documentation/nvme-set-feature.txt

index ce452fa2b157337b370e5846b6a7f91f2a2d5b0a..5a20ff835147d0ef3cf44bf90e7df664c453cb4d 100644 (file)
@@ -10,9 +10,11 @@ SYNOPSIS
 [verse]
 'nvme-admin-passthru' <device> [--opcode=<opcode> | -o <opcode>]
                [--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]
-               [--namespace-id=<nsid>] [--cdw2=<cdw2>] [--cdw3=<cdw3>]
-               [--cdw10=<cdw10>] [--cdw11=<cdw11>] [--cdw12=<cdw12>]
-               [--cdw13=<cdw13>] [--cdw14=<cdw14>] [--cdw15=<cdw15>]
+               [--namespace-id=<nsid> | -n <nsid>] [--cdw2=<cdw2> | -2 <cdw2>]
+               [--cdw3=<cdw3> | -3 <cdw3>] [--cdw10=<cdw10> | -4 <cdw4>]
+               [--cdw11=<cdw11> | -5 <cdw5>] [--cdw12=<cdw12> | -6 <cdw6>]
+               [--cdw13=<cdw13> | -7 <cdw7>] [--cdw14=<cdw14> | -8 <cdw8>]
+               [--cdw15=<cdw15> | -9 <cdw9>]
                [--data-len=<data-len> | -l <data-len>]
                [--metadata-len=<len> | -m <len>]
                [--input-file=<file> | -i <file>]
@@ -57,6 +59,7 @@ OPTIONS
 --namespace-id=<nsid>::
        The value for the ns-id in the command.
 
+-[2-9] <cdw>::
 --cdw[2-3,10-15]=<cdw>::
        Specifies the command dword value for that specified entry in
        the command
index a6f57a7aee60b3f8622a5b3a0fda36817e5df363..34df0c3a46fc3a5f9f252487ccee2f795179a9d8 100644 (file)
@@ -51,11 +51,11 @@ OPTIONS
 []
 |==================
 |Select|Description
-|0|Current 
-|1|Default 
+|0|Current
+|1|Default
 |2|Saved
 |3|Supported capabilities
-|47|Reserved
+|4-7|Reserved
 |==================
 
 -U <uuid-index>::
index 210848084ab5cc78ab2213b9ffe027b84c7a638a..20ec724004a691ecf8d38833cc00aa3a79591635 100644 (file)
@@ -8,7 +8,7 @@ nvme-ocp-clear-fw-activate-history - Clear the OCP Firmware Update History Log
 SYNOPSIS
 --------
 [verse]
-'nvme ocp clear-fw-activate-history' <device> [--no-uuid | -n>]
+'nvme ocp clear-fw-activate-history' <device> [--no-uuid | -n]
 
 DESCRIPTION
 -----------
index 24a9f40955b34d28eabf63ed595274772c56ccc2..08b38f48dcf6ea7c900bb1988a3ced0fe66745d3 100644 (file)
@@ -13,7 +13,7 @@ SYNOPSIS
                          [--uuid-index=<uuid-index> | -U <uuid_index>]
                          [--data-len=<data-len> | -l <data-len>]
                          [--data=<data-file> | -d <data-file>]
-                         [--save| -s]
+                         [--save | -s]
 
 DESCRIPTION
 -----------
@@ -58,7 +58,7 @@ OPTIONS
 
 -s::
 --save::
-       Save the attribute so that it persists through all power states and resets.     
+       Save the attribute so that it persists through all power states and resets.
 
 -U <uuid-index>::
 --uuid-index=<uuid-index>::