nvme-fabrics: document the poll function argument
authorBart Van Assche <bvanassche@acm.org>
Thu, 14 Feb 2019 22:50:53 +0000 (14:50 -0800)
committerChristoph Hellwig <hch@lst.de>
Wed, 20 Feb 2019 14:18:01 +0000 (07:18 -0700)
This patch avoids that the kernel-doc tool reports a warning when
building with W=1.

Fixes: 26c682274e0a ("nvme-fabrics: allow nvmf_connect_io_queue to poll") # v5.0-rc1
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
Reviewed-by: Sagi Grimberg <sagi@grimberg.me>
Reviewed-by: Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
Signed-off-by: Christoph Hellwig <hch@lst.de>
drivers/nvme/host/fabrics.c

index 3eb908c50e1a6199054fb0239a3e445ba3a439a9..70c09abcfcbf4d0defe3a2e5709908c0e65d9e5a 100644 (file)
@@ -430,6 +430,7 @@ EXPORT_SYMBOL_GPL(nvmf_connect_admin_queue);
  * @qid:       NVMe I/O queue number for the new I/O connection between
  *             host and target (note qid == 0 is illegal as this is
  *             the Admin queue, per NVMe standard).
+ * @poll:      Whether or not to poll for the completion of the connect cmd.
  *
  * This function issues a fabrics-protocol connection
  * of a NVMe I/O queue (via NVMe Fabrics "Connect" command)