From 254ff3d007a11ef5b9513d8906b5f1fe35074a84 Mon Sep 17 00:00:00 2001 From: Tokunori Ikegami Date: Fri, 13 Oct 2023 18:34:37 +0900 Subject: [PATCH] doc: Change short option -o and -v duplicated to upper case Signed-off-by: Tokunori Ikegami --- Documentation/nvme-admin-passthru.txt | 4 ++-- Documentation/nvme-capacity-mgmt.txt | 4 ++-- Documentation/nvme-compare.txt | 4 ++-- Documentation/nvme-create-ns.txt | 4 ++-- Documentation/nvme-fw-download.txt | 4 ++-- Documentation/nvme-get-log.txt | 4 ++-- Documentation/nvme-get-property.txt | 4 ++-- Documentation/nvme-id-ctrl.txt | 6 +++--- Documentation/nvme-id-ns.txt | 6 +++--- Documentation/nvme-io-passthru.txt | 4 ++-- Documentation/nvme-lockdown.txt | 4 ++-- Documentation/nvme-nvme-mi-recv.txt | 8 ++++---- Documentation/nvme-nvme-mi-send.txt | 8 ++++---- Documentation/nvme-read.txt | 4 ++-- Documentation/nvme-set-feature.txt | 6 +++--- Documentation/nvme-set-property.txt | 8 ++++---- Documentation/nvme-telemetry-log.txt | 4 ++-- Documentation/nvme-write.txt | 4 ++-- 18 files changed, 45 insertions(+), 45 deletions(-) mode change 100644 => 100755 Documentation/nvme-nvme-mi-recv.txt mode change 100644 => 100755 Documentation/nvme-nvme-mi-send.txt diff --git a/Documentation/nvme-admin-passthru.txt b/Documentation/nvme-admin-passthru.txt index 5a20ff83..796d446e 100644 --- a/Documentation/nvme-admin-passthru.txt +++ b/Documentation/nvme-admin-passthru.txt @@ -8,7 +8,7 @@ nvme-admin-passthru - Submit an arbitrary admin command, return results SYNOPSIS -------- [verse] -'nvme-admin-passthru' [--opcode= | -o ] +'nvme-admin-passthru' [--opcode= | -O ] [--flags= | -f ] [-rsvd= | -R ] [--namespace-id= | -n ] [--cdw2= | -2 ] [--cdw3= | -3 ] [--cdw10= | -4 ] @@ -43,7 +43,7 @@ printed to stdout for another program to parse. OPTIONS ------- --o :: +-O :: --opcode=:: The NVMe opcode to send to the device in the command diff --git a/Documentation/nvme-capacity-mgmt.txt b/Documentation/nvme-capacity-mgmt.txt index 96274cf0..b43ffc5b 100644 --- a/Documentation/nvme-capacity-mgmt.txt +++ b/Documentation/nvme-capacity-mgmt.txt @@ -9,7 +9,7 @@ nvme-capacity-mgmt - Send capacity management command to configure/create/delete SYNOPSIS -------- [verse] -'nvme capacity-mgmt' [--operation= | -o ] +'nvme capacity-mgmt' [--operation= | -O ] [--element-id= | -i ] [--cap-lower= | -l ] [--cap-upper= | -u ] @@ -27,7 +27,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). OPTIONS ------- --o :: +-O :: --operation=:: Operation to be performed by the controller diff --git a/Documentation/nvme-compare.txt b/Documentation/nvme-compare.txt index 12121ab1..736ca9e2 100644 --- a/Documentation/nvme-compare.txt +++ b/Documentation/nvme-compare.txt @@ -23,7 +23,7 @@ SYNOPSIS [--dir-type= | -T ] [--dir-spec= | -S ] [--dsm= | -D ] - [--show-command | -v] + [--show-command | -V] [--dry-run | -w] [--latency | -t] [--storage-tag | -g ] @@ -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. diff --git a/Documentation/nvme-create-ns.txt b/Documentation/nvme-create-ns.txt index 28046b68..9d81a155 100644 --- a/Documentation/nvme-create-ns.txt +++ b/Documentation/nvme-create-ns.txt @@ -25,7 +25,7 @@ SYNOPSIS [--ncap-si= | -C ] [--azr | -z] [--rar= | -r ] - [--ror= | -o ] + [--ror= | -O ] [--rnumzrwa= | -u ] [--phndls= | -p ] @@ -119,7 +119,7 @@ OPTIONS Requested Active Resources. This field specifies the number of active resources to be allocated to the created namespace. --o :: +-O :: --ror=:: Requested Open Resources. This field specifies the number of open resources to be allocated to the created namespace. diff --git a/Documentation/nvme-fw-download.txt b/Documentation/nvme-fw-download.txt index 84e407ed..a00be4c6 100644 --- a/Documentation/nvme-fw-download.txt +++ b/Documentation/nvme-fw-download.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] 'nvme fw-download' [--fw= | -f ] [--xfer= | -x ] - [--offset= | -o ] + [--offset= | -O ] DESCRIPTION ----------- @@ -48,7 +48,7 @@ OPTIONS the device has a max transfer size requirement for firmware. It defaults to 4k. --o :: +-O :: --offset=:: This specifies the starting offset in dwords. This is really only useful if your firmware is split in multiple files; otherwise diff --git a/Documentation/nvme-get-log.txt b/Documentation/nvme-get-log.txt index a51c435d..7d0f90c5 100644 --- a/Documentation/nvme-get-log.txt +++ b/Documentation/nvme-get-log.txt @@ -13,7 +13,7 @@ SYNOPSIS [--aen= | -a ] [--namespace-id= | -n ] [--raw-binary | -b] - [--lpo= | -o ] + [--lpo= | -L ] [--lsp= | -s ] [--lsi= | -S ] [--rae | -r] @@ -63,7 +63,7 @@ OPTIONS --raw-binary:: Print the raw log buffer to stdout. --o :: +-L :: --lpo=:: The log page offset specifies the location within a log page to start returning data from. It's Dword-aligned and 64-bits. diff --git a/Documentation/nvme-get-property.txt b/Documentation/nvme-get-property.txt index b2b7d290..8a906e54 100644 --- a/Documentation/nvme-get-property.txt +++ b/Documentation/nvme-get-property.txt @@ -9,7 +9,7 @@ for NVMe over Fabric SYNOPSIS -------- [verse] -'nvme get-property' [--offset= | -o ] +'nvme get-property' [--offset= | -O ] [--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 diff --git a/Documentation/nvme-id-ctrl.txt b/Documentation/nvme-id-ctrl.txt index b9fcffc4..76ae86df 100644 --- a/Documentation/nvme-id-ctrl.txt +++ b/Documentation/nvme-id-ctrl.txt @@ -8,7 +8,7 @@ nvme-id-ctrl - Send NVMe Identify Controller, return result and structure SYNOPSIS -------- [verse] -'nvme id-ctrl' [-v | --vendor-specific] [-b | --raw-binary] +'nvme id-ctrl' [-V | --vendor-specific] [-b | --raw-binary] [-o | --output-format=] 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 diff --git a/Documentation/nvme-id-ns.txt b/Documentation/nvme-id-ns.txt index a2ac1554..86918d99 100644 --- a/Documentation/nvme-id-ns.txt +++ b/Documentation/nvme-id-ns.txt @@ -8,7 +8,7 @@ nvme-id-ns - Send NVMe Identify Namespace, return result and structure SYNOPSIS -------- [verse] -'nvme id-ns' [-v | --vendor-specific] [-b | --raw-binary] +'nvme id-ns' [-V | --vendor-specific] [-b | --raw-binary] [--namespace-id= | -n ] [--force] [--human-readable | -H] [--output-format= | -o ] @@ -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 diff --git a/Documentation/nvme-io-passthru.txt b/Documentation/nvme-io-passthru.txt index ba0904cf..5dad7335 100644 --- a/Documentation/nvme-io-passthru.txt +++ b/Documentation/nvme-io-passthru.txt @@ -8,7 +8,7 @@ nvme-io-passthru - Submit an arbitrary io command, return results SYNOPSIS -------- [verse] -'nvme-io-passthru' [--opcode= | -o ] +'nvme-io-passthru' [--opcode= | -O ] [--flags= | -f ] [-rsvd= | -R ] [--namespace-id= | -nsid ] [--cdw2=] [--cdw3=] [--cdw10=] @@ -43,7 +43,7 @@ printed to stdout for another program to parse. OPTIONS ------- --o :: +-O :: --opcode=:: The NVMe opcode to send to the device in the command diff --git a/Documentation/nvme-lockdown.txt b/Documentation/nvme-lockdown.txt index cf8a48ff..34369ecf 100644 --- a/Documentation/nvme-lockdown.txt +++ b/Documentation/nvme-lockdown.txt @@ -8,7 +8,7 @@ nvme-lockdown - Send an NVMe Lockdown command to prohibit or allow the execution SYNOPSIS -------- [verse] -'nvme-lockdown' [--ofi= | -o ] +'nvme-lockdown' [--ofi= | -O ] [--ifc= | -f ] [--prhbt= | -p ] [--scp= | -s ] @@ -24,7 +24,7 @@ Identifier. OPTIONS ------- --ofi=:: --o :: +-O :: Opcode or Feature Identifier(OFI) specifies the command opcode or Set Features Feature Identifier identified by the Scope field. diff --git a/Documentation/nvme-nvme-mi-recv.txt b/Documentation/nvme-nvme-mi-recv.txt old mode 100644 new mode 100755 index e5130edc..c636db4b --- a/Documentation/nvme-nvme-mi-recv.txt +++ b/Documentation/nvme-nvme-mi-recv.txt @@ -8,8 +8,8 @@ nvme-nvme-mi-recv - Send a NVMe-MI Receive command to the specified device SYNOPSIS -------- [verse] -'nvme nvme-mi-recv' [--opcode= | -o ] - [--namespace-id=] +'nvme nvme-mi-recv' [--opcode= | -O ] + [--namespace-id= | -n ] [--data-len= | -l ] [--nmimt= | -m ] [--nmd0= | -0 ] @@ -27,7 +27,7 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o :: +-O :: --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 diff --git a/Documentation/nvme-nvme-mi-send.txt b/Documentation/nvme-nvme-mi-send.txt old mode 100644 new mode 100755 index 5139a86e..b759e2c5 --- a/Documentation/nvme-nvme-mi-send.txt +++ b/Documentation/nvme-nvme-mi-send.txt @@ -8,8 +8,8 @@ nvme-nvme-mi-send - Send a NVMe-MI Send command to the specified device SYNOPSIS -------- [verse] -'nvme nvme-mi-send' [--opcode= | -o ] - [--namespace-id=] +'nvme nvme-mi-send' [--opcode= | -O ] + [--namespace-id= | -n ] [--data-len= | -l ] [--nmimt= | -m ] [--nmd0= | -0 ] @@ -27,7 +27,7 @@ On success it returns 0, error code otherwise. OPTIONS ------- --o :: +-O :: --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 diff --git a/Documentation/nvme-read.txt b/Documentation/nvme-read.txt index 3ceeba12..2f5d174c 100644 --- a/Documentation/nvme-read.txt +++ b/Documentation/nvme-read.txt @@ -23,7 +23,7 @@ SYNOPSIS [--dir-type= | -T ] [--dir-spec= | -S ] [--dsm= | -D ] - [--show-command | -v] + [--show-command | -V] [--dry-run | -w] [--latency | -t] [--storage-tag | -g ] @@ -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. diff --git a/Documentation/nvme-set-feature.txt b/Documentation/nvme-set-feature.txt index 08b38f48..993e0080 100644 --- a/Documentation/nvme-set-feature.txt +++ b/Documentation/nvme-set-feature.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'nvme set-feature' [--namespace-id= | -n ] - [--feature-id= | -f ] [--value= | -v ] + [--feature-id= | -f ] [--value= | -V ] [--uuid-index= | -U ] [--data-len= | -l ] [--data= | -d ] @@ -51,7 +51,7 @@ OPTIONS Range Type and host identifier. This defaults to STDIN so files and echo can be piped. --v :: +-V :: --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 ------------ + diff --git a/Documentation/nvme-set-property.txt b/Documentation/nvme-set-property.txt index ba90fd3b..0ea0d137 100644 --- a/Documentation/nvme-set-property.txt +++ b/Documentation/nvme-set-property.txt @@ -9,8 +9,8 @@ for NVMe over Fabric SYNOPSIS -------- [verse] -'nvme set-property' [--offset= | -o ] - [--value= | -v ] +'nvme set-property' [--offset= | -O ] + [--value= | -V ] 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. diff --git a/Documentation/nvme-telemetry-log.txt b/Documentation/nvme-telemetry-log.txt index cf126d9c..576401b9 100644 --- a/Documentation/nvme-telemetry-log.txt +++ b/Documentation/nvme-telemetry-log.txt @@ -8,7 +8,7 @@ nvme-telemetry-log - Retrieves a Telemetry Host-Initiated log page from an NVMe SYNOPSIS -------- [verse] -'nvme telemetry-log' [--output-file= | -o ] +'nvme telemetry-log' [--output-file= | -O ] [--host-generate= | -g ] DESCRIPTION @@ -24,7 +24,7 @@ On success, the returned log structure will be in raw binary format _only_ with OPTIONS ------- --o :: +-O :: --output-file=:: File name to which raw binary data will be saved to. diff --git a/Documentation/nvme-write.txt b/Documentation/nvme-write.txt index 76cbd7ac..fc993998 100644 --- a/Documentation/nvme-write.txt +++ b/Documentation/nvme-write.txt @@ -23,7 +23,7 @@ SYNOPSIS [--dir-type= | -T ] [--dir-spec= | -S ] [--dsm= | -D ] - [--show-command | -v] + [--show-command | -V] [--dry-run | -w] [--latency | -t] [--storage-tag | -g ] @@ -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. -- 2.50.1