]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
docs: Fixed typos and missing options
authorMartin Belanger <martin.belanger@dell.com>
Thu, 9 Feb 2023 17:13:43 +0000 (12:13 -0500)
committerMartin Belanger <martin.belanger@dell.com>
Thu, 9 Feb 2023 17:13:43 +0000 (12:13 -0500)
Signed-off-by: Martin Belanger <martin.belanger@dell.com>
Documentation/nvme-connect-all.txt
Documentation/nvme-discover.txt

index b449955d52ce2c4a31da8545577170493e245f59..d963fdb273a053b9549bf6eea6bfd699a680d839 100644 (file)
@@ -18,8 +18,9 @@ SYNOPSIS
                [--hostnqn=<hostnqn>      | -q <hostnqn>]
                [--hostid=<hostid>        | -I <hostid>]
                [--raw=<filename>         | -r <filename>]
+               [--device=<device>        | -d <device>]
                [--cfg-file=<cfg>         | -C <cfg>]
-               [--keep-alive-tmo=<#>     | -k <#>]
+               [--keep-alive-tmo=<sec>   | -k <sec>]
                [--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>::
+--device=<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". <device> follows the format
+       nvme*, eg. nvme0, nvme1.
+
 -C <cfg>::
 --config-file=<cfg>::
        Use the specified JSON configuration file instead of the
index 53826d54b6812dfe3fb8a4346a85063be987cccd..e1e74f01026c724876d6a4f1ba68051bc3883401 100644 (file)
@@ -23,8 +23,8 @@ SYNOPSIS
                [--keep-alive-tmo=<sec>   | -k <sec>]
                [--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=<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>::
 --trsvcid=<trsvcid>::
@@ -137,8 +137,10 @@ OPTIONS
 
 -d <device>::
 --device=<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". <device> follows the format
+       nvme*, eg. nvme0, nvme1.
 
 -C <cfg>::
 --config-file=<cfg>::
@@ -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::