Skip to content

Commit

Permalink
completions: Change short option -o and -v duplicated to upper case
Browse files Browse the repository at this point in the history
The nvme-mi-recv/send commands doc and completions are not added.
All nvme commands doc/completions not added output-format/verbose options.
So for those will be added and updated doc/completions later separately.

Signed-off-by: Tokunori Ikegami <[email protected]>
  • Loading branch information
ikegami-t committed Oct 13, 2023
1 parent 10e9c65 commit c2510ad
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 34 deletions.
42 changes: 26 additions & 16 deletions completions/_nvme
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ _nvme () {
--human-readable':show infos in readable format'
-H':alias of --human-readable'
--vendor-specific':also dump binary vendor infos'
-v':alias of --vendor-specific'
-V':alias of --vendor-specific'
)
_arguments '*:: :->subcmds'
_describe -t commands "nvme id-ctrl options" _idctrl
Expand All @@ -320,7 +320,7 @@ _nvme () {
--human-readable':show infos in readable format'
-H':alias of --human-readable'
--vendor-specific':also dump binary vendor infos'
-v':alias of --vendor-specific'
-V':alias of --vendor-specific'
)
_arguments '*:: :->subcmds'
_describe -t commands "nvme id-ns options" _idns
Expand Down Expand Up @@ -553,6 +553,16 @@ _nvme () {
-S':alias of --nsze-si'
--ncap-si=':capacity of ns (NCAP) in standard SI units'
-C':alias of --ncap-si'
--azr=':Allocate ZRWA Resources (AZR) for Zoned Namespace Command Set'
-z':alias of --azr'
--rar=':Requested Active Resources (RAR) for Zoned Namespace Command Set'
-r':alias of --rar'
--ror=':Requested Open Resources (ROR) for Zoned Namespace Command Set'
-O':alias of --ror'
--rnumzrwa=':Requested Number of ZRWA Resources (RNUMZRWA) for Zoned Namespace Command Set'
-u':alias of --rnumzrwa'
--phndls=':Comma separated list of Placement Handle Associated RUH'
-p':alias of --phndls'
)
_arguments '*:: :->subcmds'
_describe -t commands "nvme create-ns options" _createns
Expand Down Expand Up @@ -628,7 +638,7 @@ _nvme () {
--aen=':result of the aen, use to override log id'
-a':alias of --aen'
--lpo=':log page offset specifies the location within a log page from where to start returning data'
-o':alias of --lpo'
-L':alias of --lpo'
--lsi=':log specific identifier specifies an identifier that is required for a particular log page'
-S':alias of --lsi'
--rae':Retain an Asynchronous Event'
Expand Down Expand Up @@ -664,7 +674,7 @@ _nvme () {
_telemetry_log=(
/dev/nvme':supply a device to use (required)'
--output-file=':telemetry data output write'
-o':alias for --output-file'
-O':alias for --output-file'
--host-generate=':Have the host tell the controller to generate the report'
-g':alias to --host-generate'
--controller-init':Gather report generated by the controller'
Expand Down Expand Up @@ -903,7 +913,7 @@ _nvme () {
_lockdown=(
/dev/nvme':supply a device to use (required)'
--ofi=':Opcode or Feature Identifier(OFI) (required)'
-o':alias of --ofi'
-O':alias of --ofi'
--ifc=':Interface (INF) field Information (required)'
-f':alias of --ifc'
--prhbt=':Prohibit(PRHBT) bit field (required)'
Expand All @@ -929,7 +939,7 @@ _nvme () {
--data=':data file for LBA Type Range or host identifier buffer (defaults to stdin)'
-d':alias to --data'
--value=':new value of feature (required)'
-v'alias to --value'
-V'alias to --value'
--uuid-index=':uuid index'
-U':alias for --uuid-index'
)
Expand All @@ -941,9 +951,9 @@ _nvme () {
_set_property=(
/dev/nvme':supply a device to use (required)'
--offset=':the offset of the property'
-o':alias to --offset'
-O':alias to --offset'
--value=':the value of the property to be set'
-v':alias to --value'
-V':alias to --value'
)
_arguments '*:: :->subcmds'
_describe -t commands "nvme set-property options" _set_property
Expand All @@ -953,7 +963,7 @@ _nvme () {
_get_property=(
/dev/nvme':supply a device to use (required)'
--offset=':the offset of the property'
-o':alias to --offset'
-O':alias to --offset'
--human-readable':show infos in readable format'
-H':alias of --human-readable'
)
Expand Down Expand Up @@ -1003,7 +1013,7 @@ _nvme () {
--xfer=':limit on chunk-size of transfer (if device has download size limit)'
-x':alias of --xfer'
--offset=':starting offset, in dwords (defaults to 0, only useful if download is split across multiple files)'
-o':alias of --offset'
-O':alias of --offset'
)
_arguments '*:: :->subcmds'
_describe -t commands "nvme fw-download options" _fwd
Expand All @@ -1013,7 +1023,7 @@ _nvme () {
_fwd=(
/dev/nvme':supply a device to use (required)'
--operation=':Operation to be performed by the controller'
-o':alias of --operation'
-O':alias of --operation'
--element-id=':specific to the value of the Operation field'
-i':alias of --element-id'
--cap-lower=':Least significant 32 bits of the capacity in bytes'
Expand Down Expand Up @@ -1207,7 +1217,7 @@ _nvme () {
_admin=(
/dev/nvme':supply a device to use (required)'
--opcode=':hexadecimal opcode to send (required)'
-o':alias of --opcode'
-O':alias of --opcode'
--flags=':command flags'
-f':alias of --flags'
--rsvd=':value for reserved field'
Expand Down Expand Up @@ -1257,7 +1267,7 @@ _nvme () {
_io=(
/dev/nvme':supply a device to use (required)'
--opcode=':hexadecimal opcode to send (required)'
-o':alias of --opcode'
-O':alias of --opcode'
--flags=':command flags'
-f':alias of --flags'
--rsvd=':value for reserved field'
Expand Down Expand Up @@ -1529,7 +1539,7 @@ _nvme () {
--force-unit-access':if included, the data shall be read from non-volatile media'
-f':alias of --force-unit access'
--show-command':show command instead of sending to device'
-v':alias of --show-command'
-V':alias of --show-command'
--dry-run':show command instead of sending to device'
-w':alias of --show-command'
)
Expand Down Expand Up @@ -1565,7 +1575,7 @@ _nvme () {
--force-unit-access':data read shall be returned from nonvolatile media before command completion is indicated'
-f':alias of --force-unit-access'
--show-command':show command instead of sending to device'
-v':alias of --show-command'
-V':alias of --show-command'
--dry-run':show command instead of sending to device'
-w':alias of --show-command'
)
Expand Down Expand Up @@ -1601,7 +1611,7 @@ _nvme () {
--force-unit-access':data shall be written to nonvolatile media before command completion is indicated'
-f':alias of --force-unit-access'
--show-command':show command instead of sending to device'
-v':alias of --show-command'
-V':alias of --show-command'
--dry-run':show command instead of sending to device'
-w':alias of --show-command'
)
Expand Down
35 changes: 17 additions & 18 deletions completions/bash-nvme-completion.sh
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ nvme_list_opts () {
;;
"id-ctrl")
opts+=" --raw-binary -b --human-readable -H \
--vendor-specific -v --output-format= -o"
--vendor-specific -V --output-format= -o"
;;
"id-ns")
opts+=" --namespace-id= -n --raw-binary -b \
--human-readable -H --vendor-specific -v \
--human-readable -H --vendor-specific -V \
--force -f --output-format= -o"
;;
"id-ns-granularity")
Expand Down Expand Up @@ -114,7 +114,7 @@ nvme_list_opts () {
--dps= -d --nmic= -m --anagrp-id= -a --nvmset-id= -i \
--block-size= -b --timeout= -t --csi= -y --lbstm= -l \
--nphndls= -n --nsze-si= -S --ncap-si= -C --azr -z --rar= -r \
--ror= -o --rnumzrwa= -u --phndls= -p --endg-id= -e"
--ror= -O --rnumzrwa= -u --phndls= -p --endg-id= -e"
;;
"delete-ns")
opts+=" -namespace-id= -n --timeout= -t"
Expand All @@ -130,15 +130,15 @@ nvme_list_opts () {
;;
"get-log")
opts+=" --log-id= -i --log-len= -l --namespace-id= -n \
--aen= -a --lpo= -o --lsp= -s --lsi= -S \
--aen= -a --lpo= -O --lsp= -s --lsi= -S \
--rae -r --uuid-index= -U --csi= -y --ot -O \
--raw-binary -b"
;;
"supported-log-pages")
opts+=" --output-format= -o --human-readable -H"
;;
"telemetry-log")
opts+=" --output-file= -o --host-generate= -g \
opts+=" --output-file= -O --host-generate= -g \
--controller-init -c --data-area= -d"
;;
"fw-log")
Expand Down Expand Up @@ -220,10 +220,10 @@ nvme_list_opts () {
--cdw12= -c"
;;
"set-property")
opts+=" --offset= -o --value= -v"
opts+=" --offset= -O --value= -V"
;;
"get-property")
opts=+" --offset= -o --human-readable -H"
opts=+" --offset= -O --human-readable -H"
;;
"format")
opts+=" --namespace-id= -n --timeout= -t --lbaf= -l \
Expand All @@ -233,18 +233,17 @@ nvme_list_opts () {
opts+=" --slot= -s --action= -a --bpid= -b"
;;
"fw-download")
opts+=" --fw= -f --xfer= -x --offset= -o"
opts+=" --fw= -f --xfer= -x --offset= -O"
;;
"capacity-mgmt")
opts+=" --operation= -f --element-id= -i --cap-lower= -l \
--cap-upper= -u"
opts+=" --operation= -O --element-id= -i --cap-lower= -l \
--cap-upper= -u"
;;
"lockdown")
opts+=" --ofi= -O --ifc= -F --prhbt= -P \
-scp= -S --uuid -U"
opts+=" --ofi= -O --ifc= -f --prhbt= -p --scp= -s --uuid -U"
;;
"admin-passthru")
opts+=" --opcode= -o --flags= -f --prefil= -p --rsvd= -R \
opts+=" --opcode= -O --flags= -f --prefil= -p --rsvd= -R \
--namespace-id= -n --data-len= -l --metadata-len= -m \
--timeout= -t --cdw2= -2 --cdw3= -3 --cdw10= -4 \
--cdw11= -5 --cdw12= -6 --cdw13= -7 --cdw14= -8 \
Expand All @@ -253,7 +252,7 @@ nvme_list_opts () {
--latency -T"
;;
"io-passthru")
opts+=" --opcode= -o --flags= -f --prefill= -p --rsvd= -R \
opts+=" --opcode= -O --flags= -f --prefill= -p --rsvd= -R \
--namespace-id= -n --data-len= -l --metadata-len= -m \
--timeout= -t --cdw2= -2 --cdw3= -3 --cdw10= -4 \
--cdw11= -5 --cdw12= -6 --cdw13= -7 --cdw14= -8 \
Expand Down Expand Up @@ -312,7 +311,7 @@ nvme_list_opts () {
--metadata= -M --prinfo= -p --app-tag-mask= -m \
--app-tag= -a --limited-retry -l \
--force-unit-access -f --storage-tag-check -C \
--dir-type= -T --dir-spec= -S --dsm= -D --show-command -v \
--dir-type= -T --dir-spec= -S --dsm= -D --show-command -V \
--dry-run -w --latency -t"
;;
"read")
Expand All @@ -321,7 +320,7 @@ nvme_list_opts () {
--metadata= -M --prinfo= -p --app-tag-mask= -m \
--app-tag= -a --limited-retry -l \
--force-unit-access -f --storage-tag-check -C \
--dir-type= -T --dir-spec= -S --dsm= -D --show-command -v \
--dir-type= -T --dir-spec= -S --dsm= -D --show-command -V \
--dry-run -w --latency -t"
;;
"write")
Expand All @@ -330,7 +329,7 @@ nvme_list_opts () {
--metadata= -M --prinfo= -p --app-tag-mask= -m \
--app-tag= -a --limited-retry -l \
--force-unit-access -f --storage-tag-check -C \
--dir-type= -T --dir-spec= -S --dsm= -D --show-command -v \
--dir-type= -T --dir-spec= -S --dsm= -D --show-command -V \
--dry-run -w --latency -t"
;;
"write-zeroes")
Expand Down Expand Up @@ -983,7 +982,7 @@ plugin_shannon_opts () {
--data-len= -l --raw-binary -b --cdw11= -c --human-readable -H"
;;
"set-feature-add")
opts+=" --namespace-id= -n --feature-id= -f --value= -v \
opts+=" --namespace-id= -n --feature-id= -f --value= -V \
--data-len= -l --data= -d --save -s"
;;
"id-ctrl")
Expand Down

0 comments on commit c2510ad

Please sign in to comment.