]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
update discover and connect-all man pages
authorChristoph Hellwig <hch@lst.de>
Thu, 17 Nov 2016 16:26:25 +0000 (17:26 +0100)
committerKeith Busch <keith.busch@intel.com>
Thu, 17 Nov 2016 16:51:57 +0000 (11:51 -0500)
Document the --host-traddr option, and add the missing description of
the --raw command to the connect-all man page.

Signed-off-by: Christoph Hellwig <hch@lst.de>
[Removed old/duplicate option entry]
Signed-off-by: Keith Busch <keith.busch@intel.com>
Conflicts:
Documentation/nvme-connect-all.txt
Documentation/nvme-discover.txt

Documentation/nvme-connect-all.txt
Documentation/nvme-discover.txt

index 40d0913ba5a00f3454b3f669c3b4fd6d3154d5a0..b4b3e40c10612f6a7448b9d7dbcfcfc54c96b97b 100644 (file)
@@ -9,12 +9,12 @@ SYNOPSIS
 --------
 [verse]
 'nvme connect-all'
-               [--transport=<trtype> | -t <trtype>]
-               [--traddr=<traddr>    | -a <traddr>]
-               [--host-traddr=<traddr>| -w <host-traddr>]
-               [--trsvcid=<trsvcid>  | -s <trsvcid>]
-               [--hostnqn=<hostnqn>  | -q <hostnqn>]
-               [--raw=<filename>     | -r <filename>]
+               [--transport=<trtype>     | -t <trtype>]
+               [--traddr=<traddr>        | -a <traddr>]
+               [--trsvcid=<trsvcid>      | -s <trsvcid>]
+               [--host-traddr=<traddr>   | -w <traddr>]
+               [--hostnqn=<hostnqn>      | -q <hostnqn>]
+               [--raw=<filename>         | -r <filename>]
 
 DESCRIPTION
 -----------
@@ -54,16 +54,17 @@ OPTIONS
        For transports using IP addressing (e.g. rdma) this should be an
        IP-based address (ex. IPv4).
 
--w <traddr>::
---host-traddr=<traddr>::
-       This field specificies the host traddr. Eg.: FC WWN's.
-
 -s <trsvcid>::
 --trsvcid=<trsvcid>::
        This field specifies the transport service id.  For transports using IP
        addressing (e.g. rdma) this field is the port number. By default, the IP
        port number for the RDMA transport is 4420.
+
+-w <traddr>::
+--host-traddr=<traddr>::
+       This field specifies the network address used on the host to connect
+       to the Discovery Controller.
+
 -q <hostnqn>::
 --hostnqn=<hostnqn>::
        Overrides the default Host NQN that identifies the NVMe Host.
@@ -74,6 +75,12 @@ OPTIONS
        the Discovery Controller to control what NVMe Target resources are
        allocated to the NVMe Host for a connection.
 
+-r <filename>::
+--raw=<filename>::
+       This field will take the output of the 'nvme connect-all' command
+       and dump it to a raw binary file. By default 'nvme connect-all' will
+       dump the output to stdout.
+
 EXAMPLES
 --------
 * Connect to all records returned by the Discover Controller with IP4 address
index aba71c475a360e0d1754accc86b9d27be7859b20..36a1a90df771fbbb0895c8bf54d6c98525e2f91a 100644 (file)
@@ -9,12 +9,12 @@ SYNOPSIS
 --------
 [verse]
 'nvme discover'
-               [--transport=<trtype> | -t <trtype>]
-               [--traddr=<traddr>    | -a <traddr>]
-               [--host-traddr=<traddr>| -w <host-traddr>]
-               [--trsvcid=<trsvcid>  | -s <trsvcid>]
-               [--hostnqn=<hostnqn>  | -q <hostnqn>]
-               [--raw=<filename>     | -r <filename>]
+               [--transport=<trtype>     | -t <trtype>]
+               [--traddr=<traddr>        | -a <traddr>]
+               [--trsvcid=<trsvcid>      | -s <trsvcid>]
+               [--host-traddr=<traddr>   | -w <traddr>]
+               [--hostnqn=<hostnqn>      | -q <hostnqn>]
+               [--raw=<filename>         | -r <filename>]
 
 DESCRIPTION
 -----------
@@ -75,10 +75,6 @@ OPTIONS
        For transports using IP addressing (e.g. rdma) this should be an
        IP-based (ex. IPv4) address.
 
--w <traddr>::
---host-traddr=<traddr>::
-       This field specificies the host traddr. Eg.: FC WWN's.
-
 -s <trsvcid>::
 --trsvcid=<trsvcid>::
        This field specifies the transport service id.  For transports using IP
@@ -92,6 +88,11 @@ OPTIONS
        /etc/nvme/hostnqn first. If that does not exist, the autogenerated
        NQN value from the NVMe Host kernel module is used next.
 
+-w <traddr>::
+--host-traddr=<traddr>::
+       This field specifies the network address used on the host to connect
+       to the Discovery Controller.
+
 -r <filename>::
 --raw=<filename>::
        This field will take the output of the 'nvme discover' command