From: Jay Freyensee Date: Fri, 21 Oct 2016 15:50:03 +0000 (-0700) Subject: nvme-cli: follow-on discovery tweaks from thread X-Git-Tag: v1.0~15 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=e650fab75f63c040eb558be40162d9a5ea6e3490;p=users%2Fsagi%2Fnvme-cli.git nvme-cli: follow-on discovery tweaks from thread Follow-on doc patch tweaks from discovery documentation discussion. Signed-off-by: Jay Freyensee Reviewed-by: Christoph Hellwig --- diff --git a/Documentation/nvme-discover.txt b/Documentation/nvme-discover.txt index d43f088c..e9f04b2b 100644 --- a/Documentation/nvme-discover.txt +++ b/Documentation/nvme-discover.txt @@ -3,7 +3,7 @@ nvme-discover(1) NAME ---- -nvme-discover - Send Discovery requests to Fabrics Discovery Controllers. +nvme-discover - Send Get Log Page request to Discovery Controller. SYNOPSIS -------- @@ -17,7 +17,7 @@ SYNOPSIS DESCRIPTION ----------- -Send one or more Discovery requests to a NVMe over Fabrics Discovery +Send one or more Get Log Page requests to a NVMe-over-Fabrics Discovery Controller. If no parameters are given, then 'nvme discover' will attempt to @@ -25,9 +25,9 @@ find a /etc/nvme/discovery.conf file to use to supply a list of Discovery 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 -request will be sent to the specified Discovery Controller. +Otherwise, a specific Discovery Controller should be specified using the +--transport, --traddr, and if necessary the --trsvcid flags. A Diѕcovery +request will then be sent to the specified Discovery Controller. BACKGROUND ---------- @@ -44,6 +44,9 @@ contained in that NVMe subsystem on the NVMe Target. Note that the base NVMe specfication defines the NQN (NVMe Qualified Name) format which an NVMe endpoint (device, subsystem, etc) must follow to guarantee a unique name under the NVMe standard. +In particular, 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. A Discovery Controller has it's own NQN defined in the NVMe-over-Fabrics specification, *nqn.2014-08.org.nvmexpress.discovery*. All Discovery @@ -68,8 +71,8 @@ OPTIONS -a :: --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 (ex. IPv4) address. -s :: --trsvcid=:: @@ -79,12 +82,10 @@ OPTIONS -q :: --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). - 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. + 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. -r :: --raw=::