]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
nvme-cli: follow-on doc tweaks to nvme-connect-all
authorJay Freyensee <james_p_freyensee@linux.intel.com>
Fri, 21 Oct 2016 15:50:04 +0000 (08:50 -0700)
committerKeith Busch <keith.busch@intel.com>
Fri, 21 Oct 2016 16:02:51 +0000 (12:02 -0400)
Minor massaging and typo fixes.

Signed-off-by: Jay Freyensee <james_p_freyensee@linux.intel.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Documentation/nvme-connect-all.txt

index f07ef93e175b77f4e990e60601ea63c869be3a66..1dc17826105ea5166b5fb77c65853a3e607539c7 100644 (file)
@@ -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.