From 558b50ef61f67dadfa67abe772e709ed6e06bdaf Mon Sep 17 00:00:00 2001 From: Martin Belanger Date: Thu, 9 Feb 2023 12:13:43 -0500 Subject: [PATCH] docs: Fixed typos and missing options Signed-off-by: Martin Belanger --- Documentation/nvme-connect-all.txt | 10 +++++++++- Documentation/nvme-discover.txt | 23 +++++++++++++---------- 2 files changed, 22 insertions(+), 11 deletions(-) diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt index b449955d..d963fdb2 100644 --- a/Documentation/nvme-connect-all.txt +++ b/Documentation/nvme-connect-all.txt @@ -18,8 +18,9 @@ SYNOPSIS [--hostnqn= | -q ] [--hostid= | -I ] [--raw= | -r ] + [--device= | -d ] [--cfg-file= | -C ] - [--keep-alive-tmo=<#> | -k <#>] + [--keep-alive-tmo= | -k ] [--reconnect-delay=<#> | -c <#>] [--ctrl-loss-tmo=<#> | -l <#>] [--hdr-digest | -g] @@ -114,6 +115,13 @@ OPTIONS and dump it to a raw binary file. By default 'nvme connect-all' will dump the output to stdout. +-d :: +--device=:: + This field takes a device as input. It must be a persistent device + associated with a Discovery Controller previously created by the + command "connect-all" or "discover". follows the format + nvme*, eg. nvme0, nvme1. + -C :: --config-file=:: Use the specified JSON configuration file instead of the diff --git a/Documentation/nvme-discover.txt b/Documentation/nvme-discover.txt index 53826d54..e1e74f01 100644 --- a/Documentation/nvme-discover.txt +++ b/Documentation/nvme-discover.txt @@ -23,8 +23,8 @@ SYNOPSIS [--keep-alive-tmo= | -k ] [--reconnect-delay=<#> | -c <#>] [--ctrl-loss-tmo=<#> | -l <#>] - [--hdr_digest | -g] - [--data_digest | -G] + [--hdr-digest | -g] + [--data-digest | -G] [--nr-io-queues=<#> | -i <#>] [--nr-write-queues=<#> | -W <#>] [--nr-poll-queues=<#> | -P <#>] @@ -97,7 +97,7 @@ OPTIONS --traddr=:: This field specifies the network address of the Discovery Controller. For transports using IP addressing (e.g. rdma) this should be an - IP-based (ex. IPv4) address. + IP-based address (ex. IPv4). -s :: --trsvcid=:: @@ -137,8 +137,10 @@ OPTIONS -d :: --device=:: - This field takes a device as input. Device is in the format of nvme*, - eg. nvme0, nvme1 + This field takes a device as input. It must be a persistent device + associated with a Discovery Controller previously created by the + command "connect-all" or "discover". follows the format + nvme*, eg. nvme0, nvme1. -C :: --config-file=:: @@ -150,8 +152,8 @@ OPTIONS -k <#>:: --keep-alive-tmo=<#>:: - Overrides the default timeout (in seconds) for keep alive. - This option will be ignored for the discovery, and it is only + Overrides the default keep alive timeout (in seconds). This + option will be ignored for discovery, and it is only implemented for completeness. -c <#>:: @@ -164,11 +166,11 @@ OPTIONS Overrides the default controller loss timeout period (in seconds). -g:: ---hdr_digest:: +--hdr-digest:: Generates/verifies header digest (TCP). -G:: ---data_digest:: +--data-digest:: Generates/verifies data digest (TCP). -i <#>:: @@ -194,7 +196,8 @@ OPTIONS -p:: --persistent:: - Persistent discovery connection. + Don't remove the discovery controller after retrieving the discovery + log page. -S:: --quiet:: -- 2.50.1