[PATCH v1 2/3] nvme-cli: follow-on doc tweaks to nvme-connect-all

Jay Freyensee james_p_freyensee at linux.intel.com
Fri Oct 21 08:50:04 PDT 2016


Minor massaging and typo fixes.

Signed-off-by: Jay Freyensee <james_p_freyensee at linux.intel.com>
Reviewed-by: Christoph Hellwig <hch at lst.de>

---
 Documentation/nvme-connect-all.txt | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt
index f07ef93..1dc1782 100644
--- a/Documentation/nvme-connect-all.txt
+++ b/Documentation/nvme-connect-all.txt
@@ -22,11 +22,11 @@ Controller, and create controllers for the returned discovery records.
 
 If no parameters are given, then 'nvme connect-all' will attempt to
 find a /etc/nvme/discovery.conf file to use to supply a list of
-Connect-all commands to run. If no /etc/nvme/discovery.conf file exists,
+connect-all commands to run. If no /etc/nvme/discovery.conf file exists,
 the command will quit with an error.
 
 Otherwise a specific Discovery Controller should be specified using the
---transport, --traddr and if nessecary the --trsvcid and a Diѕcovery
+--transport, --traddr and if necessary the --trsvcid and a Diѕcovery
 request will be sent to the specified Discovery Controller.
 
 See the documentation for the nvme-discover(1) command for further
@@ -50,8 +50,8 @@ OPTIONS
 -a <traddr>::
 --traddr=<traddr>::
 	This field specifies the network address of the Discovery Controller.
-	For transports using IP addressing (e.g. rdma) this should be an IPv4
-	address.
+	For transports using IP addressing (e.g. rdma) this should be an
+	IP-based address (ex. IPv4).
 
 -s <trsvcid>::
 --trsvcid=<trsvcid>::
@@ -61,9 +61,10 @@ OPTIONS
  
 -q <hostnqn>::
 --hostnqn=<hostnqn>::
-	Overrides the default host NQN that identifies the NVMe Host.  If this
-	option is not specified the default is read from /etc/nvme/hostnqn or
-	autogenerated by the kernel (in that order).
+	Overrides the default Host NQN that identifies the NVMe Host.
+	If this option is not specified, the default is read from
+	/etc/nvme/hostnqn first. If that does not exist, the autogenerated
+	NQN value from the NVMe Host kernel module is used next.
 	The Host NQN uniquely identifies the NVMe Host, and may be used by the
 	the Discovery Controller to control what NVMe Target resources are
 	allocated to the NVMe Host for a connection.
-- 
2.5.5




More information about the Linux-nvme mailing list