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 <csm10495@gmail.com> Change-Id: I88d4399bc0872e73bc1e04b3f09834afd7d56c53 Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/483306 Reviewed-by: Paul Luse <paul.e.luse@intel.com> Reviewed-by: Alexey Marchuk <alexeymar@mellanox.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Community-CI: Broadcom SPDK FC-NVMe CI <spdk-ci.pdl@broadcom.com> Community-CI: SPDK CI Jenkins <sys_sgci@intel.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
This commit is contained in:
parent
ac26fec9c6
commit
cf8b06ef66
@ -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 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
|
* \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
|
* \param opts_size Must be set to sizeof(struct spdk_nvme_io_qpair_opts), or 0
|
||||||
* if opts is NULL.
|
* if opts is NULL.
|
||||||
*
|
*
|
||||||
|
Loading…
Reference in New Issue
Block a user