[PATCH 1/3] update discover and connect-all man pages

Christoph Hellwig hch at lst.de
Thu Nov 17 08:26:25 PST 2016


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 at lst.de>

Conflicts:
	Documentation/nvme-connect-all.txt
	Documentation/nvme-discover.txt
---
 Documentation/nvme-connect-all.txt | 25 ++++++++++++++++++-------
 Documentation/nvme-discover.txt    | 17 +++++++++++------
 2 files changed, 29 insertions(+), 13 deletions(-)

diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt
index 40d0913..d85ebb9 100644
--- a/Documentation/nvme-connect-all.txt
+++ b/Documentation/nvme-connect-all.txt
@@ -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
 -----------
@@ -63,7 +63,12 @@ OPTIONS
 	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.
- 
+
+-s <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 +79,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
diff --git a/Documentation/nvme-discover.txt b/Documentation/nvme-discover.txt
index aba71c4..fb6a33f 100644
--- a/Documentation/nvme-discover.txt
+++ b/Documentation/nvme-discover.txt
@@ -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
 -----------
@@ -92,6 +92,11 @@ OPTIONS
 	/etc/nvme/hostnqn first. If that does not exist, the autogenerated
 	NQN value from the NVMe Host kernel module is used next.
 
+-s <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
-- 
2.1.4




More information about the Linux-nvme mailing list