Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mal doc comp #2660

Merged
merged 4 commits into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions Documentation/nvme-mgmt-addr-list-log.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
nvme-mgmt-addr-list-log(1)
==========================

NAME
----
nvme-mgmt-addr-list-log - Retrieve Management Address List Log, show it

SYNOPSIS
--------
[verse]
'nvme mgmt-addr-list-log' <device> [--verbose | -v]
[--output-format=<fmt> | -o <fmt>] [--timeout=<timeout>]

DESCRIPTION
-----------
Retrieve Management Address List Log, show it

The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).

On success it returns 0, error code otherwise.

OPTIONS
-------
-v::
--verbose::
Increase the information detail in the output.

-o <fmt>::
--output-format=<fmt>::
Set the reporting format to 'normal', 'json' or 'binary'. Only one
output format can be used at a time.

-t <timeout>::
--timeout=<timeout>::
Override default timeout value. In milliseconds.

EXAMPLES
--------
* Has the program issue a mgmt-addr-list-log
+
------------
# nvme mgmt-addr-list-log /dev/nvme0
------------

NVME
----
Part of the nvme-user suite.
4 changes: 2 additions & 2 deletions Documentation/nvme-ocp-hardware-component-log.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,13 @@ OPTIONS

EXAMPLES
--------
* Has the program issue a set-error-injection
* Has the program issue a ocp hardware-component-log
+
------------
# nvme ocp hardware-component-log /dev/nvme0
------------

* Has the program issue a set-error-injection with the asic component list.
* Has the program issue a ocp hardware-component-log with asic component list
+
------------
# nvme ocp hardware-component-log /dev/nvme0 -i asic -l
Expand Down
18 changes: 16 additions & 2 deletions completions/_nvme
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ _nvme () {
--comp-id=':component identifier'
-i':alias for --comp-id'
--list':list component descriptions'
-v':alias for --list'
-l':alias for --list'
--verbose':Increase the information detail in the output.'
-v':alias for --verbose'
--output-format=':Output format: normal|json|binary'
Expand Down Expand Up @@ -2613,6 +2613,20 @@ _nvme () {
_arguments '*:: :->subcmds'
_describe -t commands "nvme set-reg options" _io_mgmt_send
;;
(mgmt-addr-list-log)
local _mal_log
_caplog=(
/dev/nvme':supply a device to use (required)'
--verbose':Increase the information detail in the output.'
-v':alias for --verbose'
--output-format=':Output format: normal|json|binary'
-o ':alias for --output-format'
--timeout=':value for timeout'
-t ':alias for --timeout'
)
_arguments '*:: :->subcmds'
_describe -t commands "nvme mgmt-addr-list-log" _mal_log
;;
(version)
local _version
_version=(
Expand Down Expand Up @@ -2724,7 +2738,7 @@ _nvme () {
get-property write-zeroes write-uncor verify sanitize sanitize-log reset
subsystem-reset ns-rescan get-lba-status dsm discover connect-all connect
dim disconnect disconnect-all gen-hostnqn show-hostnqn tls-key dir-receive
dir-send virt-mgmt rpmb version ocp solidigm dapustor
dir-send virt-mgmt rpmb version ocp solidigm dapustor mgmt-addr-list-log
)
_arguments '*:: :->subcmds'
_describe -t commands "help: infos on a specific nvme command, or provide no option to see a synopsis of all nvme commands" _h
Expand Down
5 changes: 4 additions & 1 deletion completions/bash-nvme-completion.sh
Original file line number Diff line number Diff line change
Expand Up @@ -479,6 +479,9 @@ nvme_list_opts () {
--pmrmscu= --output-format= -o --verbose= -v \
--timeout= -t"
;;
"mgmt-addr-list-log")
opts+=" --verbose -v --output-format= -o --timeout= -t"
;;
"version")
opts+=$NO_OPTS
;;
Expand Down Expand Up @@ -1669,7 +1672,7 @@ _nvme_subcmds () {
rpmb boot-part-log fid-support-effects-log \
supported-log-pages lockdown media-unit-stat-log \
supported-cap-config-log dim show-topology list-endgrp \
nvme-mi-recv nvme-mi-send get-reg set-reg"
nvme-mi-recv nvme-mi-send get-reg set-reg mgmt-addr-list-log"

# Add plugins:
for plugin in "${!_plugin_subcmds[@]}"; do
Expand Down
Loading