From cf8b06ef66be6e47ad1bd890ea24b2d11493d248 Mon Sep 17 00:00:00 2001 From: Charles Machalow Date: Wed, 29 Jan 2020 14:34:12 -0800 Subject: [PATCH] Docstrings: Fix docstring for spdk_nvme_ctrlr_alloc_io_qpair If NULL is passed as opts to spdk_nvme_ctrlr_alloc_io_qpair, the defaults will be obtained from spdk_nvme_ctrlr_get_default_io_qpair_opts instead of spdk_nvme_ctrlr_alloc_io_qpair. Fixes issue #1160 Signed-off-by: Charles Machalow Change-Id: I88d4399bc0872e73bc1e04b3f09834afd7d56c53 Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/483306 Reviewed-by: Paul Luse Reviewed-by: Alexey Marchuk Reviewed-by: Shuhei Matsumoto Reviewed-by: Ben Walker Community-CI: Broadcom SPDK FC-NVMe CI Community-CI: SPDK CI Jenkins Tested-by: SPDK CI Jenkins --- include/spdk/nvme.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/spdk/nvme.h b/include/spdk/nvme.h index a6881dedd..0151aae24 100644 --- a/include/spdk/nvme.h +++ b/include/spdk/nvme.h @@ -1149,7 +1149,7 @@ void spdk_nvme_ctrlr_get_default_io_qpair_opts(struct spdk_nvme_ctrlr *ctrlr, * * \param ctrlr NVMe controller for which to allocate the I/O queue pair. * \param opts I/O qpair creation options, or NULL to use the defaults as returned - * by spdk_nvme_ctrlr_alloc_io_qpair(). + * by spdk_nvme_ctrlr_get_default_io_qpair_opts(). * \param opts_size Must be set to sizeof(struct spdk_nvme_io_qpair_opts), or 0 * if opts is NULL. *