]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
doc: Change short option -o and -v duplicated to upper case
authorTokunori Ikegami <ikegami.t@gmail.com>
Fri, 13 Oct 2023 09:34:37 +0000 (18:34 +0900)
committerDaniel Wagner <wagi@monom.org>
Thu, 2 Nov 2023 15:52:58 +0000 (16:52 +0100)
Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
18 files changed:
Documentation/nvme-admin-passthru.txt
Documentation/nvme-capacity-mgmt.txt
Documentation/nvme-compare.txt
Documentation/nvme-create-ns.txt
Documentation/nvme-fw-download.txt
Documentation/nvme-get-log.txt
Documentation/nvme-get-property.txt
Documentation/nvme-id-ctrl.txt
Documentation/nvme-id-ns.txt
Documentation/nvme-io-passthru.txt
Documentation/nvme-lockdown.txt
Documentation/nvme-nvme-mi-recv.txt [changed mode: 0644->0755]
Documentation/nvme-nvme-mi-send.txt [changed mode: 0644->0755]
Documentation/nvme-read.txt
Documentation/nvme-set-feature.txt
Documentation/nvme-set-property.txt
Documentation/nvme-telemetry-log.txt
Documentation/nvme-write.txt

index 5a20ff835147d0ef3cf44bf90e7df664c453cb4d..796d446e588d4a25c486958fb6530e7f37228df3 100644 (file)
@@ -8,7 +8,7 @@ nvme-admin-passthru - Submit an arbitrary admin command, return results
 SYNOPSIS
 --------
 [verse]
-'nvme-admin-passthru' <device> [--opcode=<opcode> | -o <opcode>]
+'nvme-admin-passthru' <device> [--opcode=<opcode> | -O <opcode>]
                [--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]
                [--namespace-id=<nsid> | -n <nsid>] [--cdw2=<cdw2> | -2 <cdw2>]
                [--cdw3=<cdw3> | -3 <cdw3>] [--cdw10=<cdw10> | -4 <cdw4>]
@@ -43,7 +43,7 @@ printed to stdout for another program to parse.
 
 OPTIONS
 -------
--o <opcode>::
+-O <opcode>::
 --opcode=<opcode>::
        The NVMe opcode to send to the device in the command
 
index 96274cf0f2bd941ebc1aa04e53a6ae3fcde99e65..b43ffc5ba853074de71fed5fb62b70db1d2135ff 100644 (file)
@@ -9,7 +9,7 @@ nvme-capacity-mgmt - Send capacity management command to configure/create/delete
 SYNOPSIS
 --------
 [verse]
-'nvme capacity-mgmt' <device> [--operation=<operation> | -o <operation>]
+'nvme capacity-mgmt' <device> [--operation=<operation> | -O <operation>]
                        [--element-id=<element-id> | -i <element-id>]
                        [--cap-lower=<cap-lower> | -l <cap-lower>]
                        [--cap-upper=<cap-upper> | -u <cap-upper>]
@@ -27,7 +27,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
 
 OPTIONS
 -------
--o <operation>::
+-O <operation>::
 --operation=<operation>::
     Operation to be performed by the controller
 
index 12121ab14d0c6ed012dc0abcda178fbea7f3d63a..736ca9e2b40d4b32bb25a992e5ae31f42c000614 100644 (file)
@@ -23,7 +23,7 @@ SYNOPSIS
                        [--dir-type=<type> | -T <type>]
                        [--dir-spec=<spec> | -S <spec>]
                        [--dsm=<dsm> | -D <dsm>]
-                       [--show-command | -v]
+                       [--show-command | -V]
                        [--dry-run | -w]
                        [--latency | -t]
                        [--storage-tag<storage-tag> | -g <storage-tag>]
@@ -127,7 +127,7 @@ metadata is passes.
        among other things, as well as yet to be defined types. Please
        consult the NVMe specification for detailed breakdown of how to
        use this field.
--v::
+-V::
 --show-cmd::
        Print out the command to be sent.
 
index 28046b68e136aac451c139a0834167a0c9900692..9d81a1550cbef1fb6cf46ce20764983e90fa4a7c 100644 (file)
@@ -25,7 +25,7 @@ SYNOPSIS
                        [--ncap-si=<ncap-si> | -C <ncap-si>]
                        [--azr | -z]
                        [--rar=<rar> | -r <rar>]
-                       [--ror=<ror> | -o <ror>]
+                       [--ror=<ror> | -O <ror>]
                        [--rnumzrwa=<rnumzrwa> | -u <rnumzrwa>]
                        [--phndls=<placement-handle-list,> | -p <placement-handle-list,>]
 
@@ -119,7 +119,7 @@ OPTIONS
        Requested Active Resources. This field specifies the number of active
        resources to be allocated to the created namespace.
 
--o <ror>::
+-O <ror>::
 --ror=<ror>::
        Requested Open Resources. This field specifies the number of open resources
        to be allocated to the created namespace.
index 84e407ed83fb8c09048726401d66dd591fa19a5a..a00be4c660e131bd0d681b1d7bade46727727942 100644 (file)
@@ -10,7 +10,7 @@ SYNOPSIS
 [verse]
 'nvme fw-download' <device> [--fw=<firmware-file> | -f <firmware-file>]
                    [--xfer=<transfer-size> | -x <transfer-size>]
-                   [--offset=<offset> | -o <offset>]
+                   [--offset=<offset> | -O <offset>]
 
 DESCRIPTION
 -----------
@@ -48,7 +48,7 @@ OPTIONS
        the device has a max transfer size requirement for firmware. It
        defaults to 4k.
 
--o <offset>::
+-O <offset>::
 --offset=<offset>::
        This specifies the starting offset in dwords. This is really only
        useful if your firmware is split in multiple files; otherwise
index a51c435df04b96594c88889d6a2c880d2e4c4289..7d0f90c565974374228692997e7dce62faf5a708 100644 (file)
@@ -13,7 +13,7 @@ SYNOPSIS
              [--aen=<aen> | -a <aen>]
              [--namespace-id=<nsid> | -n <nsid>]
              [--raw-binary | -b]
-             [--lpo=<offset> | -o <offset>]
+             [--lpo=<offset> | -L <offset>]
              [--lsp=<field> | -s <field>]
              [--lsi=<field> | -S <field>]
              [--rae | -r]
@@ -63,7 +63,7 @@ OPTIONS
 --raw-binary::
        Print the raw log buffer to stdout.
 
--o <offset>::
+-L <offset>::
 --lpo=<offset>::
        The log page offset specifies the location within a log page to start
        returning data from. It's Dword-aligned and 64-bits.
index b2b7d29024bd6837e715b23f2fea91fe83dbdc36..8a906e54feef96d353e3d32354d49522cda15fb7 100644 (file)
@@ -9,7 +9,7 @@ for NVMe over Fabric
 SYNOPSIS
 --------
 [verse]
-'nvme get-property' <device> [--offset=<offset> | -o <offset>]
+'nvme get-property' <device> [--offset=<offset> | -O <offset>]
                                [--human-readable | -H ]
 
 
@@ -20,7 +20,7 @@ Reads and shows the defined NVMe controller property for NVMe over Fabric.
 
 OPTIONS
 -------
--o::
+-O::
 --offset::
         The offset of the property. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20
 
index b9fcffc4ea47e42d7b5c8caa8cc6efa333ac5f3e..76ae86df21060f27b49b5bbd80632082777eebad 100644 (file)
@@ -8,7 +8,7 @@ nvme-id-ctrl - Send NVMe Identify Controller, return result and structure
 SYNOPSIS
 --------
 [verse]
-'nvme id-ctrl' <device> [-v | --vendor-specific] [-b | --raw-binary]
+'nvme id-ctrl' <device> [-V | --vendor-specific] [-b | --raw-binary]
                        [-o <fmt> | --output-format=<fmt>]
 
 DESCRIPTION
@@ -30,7 +30,7 @@ OPTIONS
        Print the raw buffer to stdout. Structure is not parsed by
        program. This overrides the vendor specific and human readable options.
 
--v::
+-V::
 --vendor-specific::
        In addition to parsing known fields, this option will dump
        the vendor specific region of the structure in hex with ascii
@@ -61,7 +61,7 @@ the vendor unique field:
 +
 ------------
 # nvme id-ctrl /dev/nvme0 --vendor-specific
-# nvme id-ctrl /dev/nvme0 -v
+# nvme id-ctrl /dev/nvme0 -V
 ------------
 +
 The above will dump the 'vs' buffer in hex since it doesn't know how to
index a2ac155484ce8ff8468f3b1c18936bd86a896616..86918d99bacab7db913f30f0f6cde9962f12f998 100644 (file)
@@ -8,7 +8,7 @@ nvme-id-ns - Send NVMe Identify Namespace, return result and structure
 SYNOPSIS
 --------
 [verse]
-'nvme id-ns' <device> [-v | --vendor-specific] [-b | --raw-binary]
+'nvme id-ns' <device> [-V | --vendor-specific] [-b | --raw-binary]
                    [--namespace-id=<nsid> | -n <nsid>] [--force]
                    [--human-readable | -H]
                    [--output-format=<fmt> | -o <fmt>]
@@ -51,7 +51,7 @@ OPTIONS
        Print the raw buffer to stdout. Structure is not parsed by
        program. This overrides the vendor specific and human readable options.
 
--v::
+-V::
 --vendor-specific::
        In addition to parsing known fields, this option will dump
        the vendor specific region of the structure in hex with ascii
@@ -93,7 +93,7 @@ the vendor unique field:
 +
 ------------
 # nvme id-ns /dev/nvme0n1 --vendor-specific
-# nvme id-ns /dev/nvme0n1 -v
+# nvme id-ns /dev/nvme0n1 -V
 ------------
 +
 The above will dump the \'vs' buffer in hex since it doesn't know how to
index ba0904cf6414e64325bdd00cbdd618614dab3bda..5dad73359d9be52ce394287a3ba3ca293bb13500 100644 (file)
@@ -8,7 +8,7 @@ nvme-io-passthru - Submit an arbitrary io command, return results
 SYNOPSIS
 --------
 [verse]
-'nvme-io-passthru' <device> [--opcode=<opcode> | -o <opcode>]
+'nvme-io-passthru' <device> [--opcode=<opcode> | -O <opcode>]
                [--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]
                [--namespace-id=<nsid> | -nsid <nsid>]
                [--cdw2=<cdw2>] [--cdw3=<cdw3>] [--cdw10=<cdw10>]
@@ -43,7 +43,7 @@ printed to stdout for another program to parse.
 
 OPTIONS
 -------
--o <opcode>::
+-O <opcode>::
 --opcode=<opcode>::
        The NVMe opcode to send to the device in the command
 
index cf8a48ff9cf5f379058600616a64f07f0c183d41..34369ecf594028a5c32cc73307386e77464b8186 100644 (file)
@@ -8,7 +8,7 @@ nvme-lockdown - Send an NVMe Lockdown command to prohibit or allow the execution
 SYNOPSIS
 --------
 [verse]
-'nvme-lockdown' <device> [--ofi=<ofi> | -o <ofi>]
+'nvme-lockdown' <device> [--ofi=<ofi> | -O <ofi>]
                        [--ifc=<ifc> | -f <ifc>]
                        [--prhbt=<prhbt> | -p <prhbt>]
                        [--scp=<scp> | -s <scp>]
@@ -24,7 +24,7 @@ Identifier.
 OPTIONS
 -------
 --ofi=<ofi>::
--o <ofi>::
+-O <ofi>::
        Opcode or Feature Identifier(OFI) specifies the command opcode or Set
        Features Feature Identifier identified by the Scope field.
 
old mode 100644 (file)
new mode 100755 (executable)
index e5130ed..c636db4
@@ -8,8 +8,8 @@ nvme-nvme-mi-recv - Send a NVMe-MI Receive command to the specified device
 SYNOPSIS
 --------
 [verse]
-'nvme nvme-mi-recv' <device> [--opcode=<opcode> | -o <opcode>]
-                            [--namespace-id=<nsid>]
+'nvme nvme-mi-recv' <device> [--opcode=<opcode> | -O <opcode>]
+                            [--namespace-id=<nsid> | -n <nsid>]
                             [--data-len=<data-len> | -l <data-len>]
                             [--nmimt=<nmimt> | -m <nmimt>]
                             [--nmd0=<nmd0> | -0 <nmd0>]
@@ -27,7 +27,7 @@ On success it returns 0, error code otherwise.
 
 OPTIONS
 -------
--o <opcode>::
+-O <opcode>::
 --opcode=<opcode>::
        The NVMe-MI opcode to send to the device in the command
 
@@ -62,7 +62,7 @@ EXAMPLES
 * Has the program issue a nvme-mi-recv to execute the VPD read.
 +
 ------------
-# nvme nvme-mi-recv /dev/nvme0n1 -o 5 -m 1 -0 0 -1 0x100 -l 256
+# nvme nvme-mi-recv /dev/nvme0n1 -O 5 -m 1 -0 0 -1 0x100 -l 256
 ------------
 
 NVME
old mode 100644 (file)
new mode 100755 (executable)
index 5139a86..b759e2c
@@ -8,8 +8,8 @@ nvme-nvme-mi-send - Send a NVMe-MI Send command to the specified device
 SYNOPSIS
 --------
 [verse]
-'nvme nvme-mi-send' <device> [--opcode=<opcode> | -o <opcode>]
-                            [--namespace-id=<nsid>]
+'nvme nvme-mi-send' <device> [--opcode=<opcode> | -O <opcode>]
+                            [--namespace-id=<nsid> | -n <nsid>]
                             [--data-len=<data-len> | -l <data-len>]
                             [--nmimt=<nmimt> | -m <nmimt>]
                             [--nmd0=<nmd0> | -0 <nmd0>]
@@ -27,7 +27,7 @@ On success it returns 0, error code otherwise.
 
 OPTIONS
 -------
--o <opcode>::
+-O <opcode>::
 --opcode=<opcode>::
        The NVMe-MI opcode to send to the device in the command
 
@@ -62,7 +62,7 @@ EXAMPLES
 * Has the program issue a nvme-mi-send to execute the VPD write.
 +
 ------------
-# nvme nvme-mi-send /dev/nvme0n1 -o 6 -m 1 -0 0 -1 0x100 -l 256 -i vpd.bin
+# nvme nvme-mi-send /dev/nvme0n1 -O 6 -m 1 -0 0 -1 0x100 -l 256 -i vpd.bin
 ------------
 
 NVME
index 3ceeba12ef69f5ce5fca9a67744b66994d0f8c60..2f5d174c65a70017d22cceaf75398dca0d1ecb33 100644 (file)
@@ -23,7 +23,7 @@ SYNOPSIS
                        [--dir-type=<type> | -T <type>]
                        [--dir-spec=<spec> | -S <spec>]
                        [--dsm=<dsm> | -D <dsm>]
-                       [--show-command | -v]
+                       [--show-command | -V]
                        [--dry-run | -w]
                        [--latency | -t]
                        [--storage-tag<storage-tag> | -g <storage-tag>]
@@ -117,7 +117,7 @@ metadata is passes.
        consult the NVMe specification for detailed breakdown of how to
        use this field.
 
--v::
+-V::
 --show-cmd::
        Print out the command to be sent.
 
index 08b38f48dcf6ea7c900bb1988a3ced0fe66745d3..993e0080f1f6c928ad985c1d359dd3884c1bfa18 100644 (file)
@@ -9,7 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'nvme set-feature' <device> [--namespace-id=<nsid> | -n <nsid>]
-                         [--feature-id=<fid> | -f <fid>] [--value=<value> | -v <value>]
+                         [--feature-id=<fid> | -f <fid>] [--value=<value> | -V <value>]
                          [--uuid-index=<uuid-index> | -U <uuid_index>]
                          [--data-len=<data-len> | -l <data-len>]
                          [--data=<data-file> | -d <data-file>]
@@ -51,7 +51,7 @@ OPTIONS
        Range Type and host identifier. This defaults to STDIN so files
        and echo can be piped.
 
--v <value>::
+-V <value>::
 --value=<value>::
        The value for command dword 11, the value you want to set the
        feature to.
@@ -69,7 +69,7 @@ EXAMPLES
 * Sets the Power State (PS) to 1  in feature id 2:
 +
 ------------
-# nvme set-feature /dev/nvme0 -f 2 /dev/nvme0n1 -v 0x1
+# nvme set-feature /dev/nvme0 -f 2 /dev/nvme0n1 -V 0x1
 ------------
 +
 
index ba90fd3b0ed40e0aad8afe096a89b696bc2b7ca3..0ea0d137f9946ff6aa32009dabc633cac2d4e658 100644 (file)
@@ -9,8 +9,8 @@ for NVMe over Fabric
 SYNOPSIS
 --------
 [verse]
-'nvme set-property' <device> [--offset=<offset> | -o <offset>]
-                               [--value=<val> | -v <val>]
+'nvme set-property' <device> [--offset=<offset> | -O <offset>]
+                               [--value=<val> | -V <val>]
 
 
 DESCRIPTION
@@ -19,11 +19,11 @@ Writes and shows the defined NVMe controller property for NVMe over Fabric.
 
 OPTIONS
 -------
--o::
+-O::
 --offset::
        The offset of the property.
 
--v::
+-V::
 --value:
        The value of the property to be set.
 
index cf126d9c513db682cae9317328e26f70e1cf04a2..576401b9e6541162ba9f0af05200a26654ac7fea 100644 (file)
@@ -8,7 +8,7 @@ nvme-telemetry-log - Retrieves a Telemetry Host-Initiated log page from an NVMe
 SYNOPSIS
 --------
 [verse]
-'nvme telemetry-log' <device> [--output-file=<file> | -o <file>]
+'nvme telemetry-log' <device> [--output-file=<file> | -O <file>]
                      [--host-generate=<gen> | -g <gen>]
 
 DESCRIPTION
@@ -24,7 +24,7 @@ On success, the returned log structure will be in raw binary format _only_ with
 
 OPTIONS
 -------
--o <file>::
+-O <file>::
 --output-file=<file>::
        File name to which raw binary data will be saved to.
 
index 76cbd7ac1f1277c1ff5f1dc4bc44655bbfa0d902..fc993998b3f60b6a802f9a6475cd1588861b0375 100644 (file)
@@ -23,7 +23,7 @@ SYNOPSIS
                        [--dir-type=<type> | -T <type>]
                        [--dir-spec=<spec> | -S <spec>]
                        [--dsm=<dsm> | -D <dsm>]
-                       [--show-command | -v]
+                       [--show-command | -V]
                        [--dry-run | -w]
                        [--latency | -t]
                        [--storage-tag<storage-tag> | -g <storage-tag>]
@@ -125,7 +125,7 @@ metadata is passes.
        consult the NVMe specification for detailed breakdown of how to
        use this field.
 
--v::
+-V::
 --show-cmd::
        Print out the command to be sent.