linux-nvme.lists.infradead.org archive mirror
 help / color / mirror / Atom feed
From: hch@lst.de (Christoph Hellwig)
Subject: [PATCH 1/3] update discover and connect-all man pages
Date: Thu, 17 Nov 2016 15:52:21 +0100	[thread overview]
Message-ID: <1479394343-4940-2-git-send-email-hch@lst.de> (raw)
In-Reply-To: <1479394343-4940-1-git-send-email-hch@lst.de>

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>
---
 Documentation/nvme-connect-all.txt | 24 ++++++++++++++++++------
 Documentation/nvme-discover.txt    | 16 +++++++++++-----
 2 files changed, 29 insertions(+), 11 deletions(-)

diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt
index 1dc1782..9a65148 100644
--- a/Documentation/nvme-connect-all.txt
+++ b/Documentation/nvme-connect-all.txt
@@ -9,11 +9,12 @@ SYNOPSIS
 --------
 [verse]
 'nvme connect-all'
-		[--transport=<trtype> | -t <trtype>]
-		[--traddr=<traddr>    | -a <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>   | -s <traddr>]
+		[--hostnqn=<hostnqn>      | -q <hostnqn>]
+		[--raw=<filename>         | -r <filename>]
 
 DESCRIPTION
 -----------
@@ -58,7 +59,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.
@@ -69,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
diff --git a/Documentation/nvme-discover.txt b/Documentation/nvme-discover.txt
index e9f04b2..6862bdb 100644
--- a/Documentation/nvme-discover.txt
+++ b/Documentation/nvme-discover.txt
@@ -9,11 +9,12 @@ SYNOPSIS
 --------
 [verse]
 'nvme discover'
-		[--transport=<trtype> | -t <trtype>]
-		[--traddr=<traddr>    | -a <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>   | -s <traddr>]
+		[--hostnqn=<hostnqn>      | -q <hostnqn>]
+		[--raw=<filename>         | -r <filename>]
 
 DESCRIPTION
 -----------
@@ -87,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.
 
+-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

  reply	other threads:[~2016-11-17 14:52 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-11-17 14:52 nvme-cli fabrics man pages updates Christoph Hellwig
2016-11-17 14:52 ` Christoph Hellwig [this message]
2016-11-17 16:29   ` [PATCH 1/3] update discover and connect-all man pages Keith Busch
2016-11-17 14:52 ` [PATCH 2/3] add a full blown connect man page Christoph Hellwig
2016-11-17 14:52 ` [PATCH 3/3] add a disconnet " Christoph Hellwig
  -- strict thread matches above, loose matches on Subject: below --
2016-11-17 16:26 nvme-cli fabrics man pages updates V2 Christoph Hellwig
2016-11-17 16:26 ` [PATCH 1/3] update discover and connect-all man pages Christoph Hellwig

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1479394343-4940-2-git-send-email-hch@lst.de \
    --to=hch@lst.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).