From 7d74bd70729c222a9f996e7b1b619c4832b0c23c Mon Sep 17 00:00:00 2001 From: Daniel Verkamp Date: Tue, 29 Mar 2016 10:26:28 -0700 Subject: [PATCH] nvme: remove duplicated doc comment spdk_nvme_qpair_process_completions() is already documented in spdk/nvme.h, so merge the doc comment from nvme_qpair.c into the public header. Change-Id: Id7722d99d209852ee64286e0a3fa127b863e10aa Signed-off-by: Daniel Verkamp --- include/spdk/nvme.h | 5 +++++ lib/nvme/nvme_qpair.c | 8 -------- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/include/spdk/nvme.h b/include/spdk/nvme.h index fcc7301dc..53111f0c8 100644 --- a/include/spdk/nvme.h +++ b/include/spdk/nvme.h @@ -246,12 +246,17 @@ int spdk_nvme_ctrlr_cmd_io_raw(struct spdk_nvme_ctrlr *ctrlr, * processes completions that are ready at the time of this function call. It does not * wait for outstanding commands to finish. * + * For each completed command, the request's callback function will + * be called if specified as non-NULL when the request was submitted. + * * \param qpair Queue pair to check for completions. * \param max_completions Limit the number of completions to be processed in one call, or 0 * for unlimited. * * \return Number of completions processed (may be 0) or negative on error. * + * \sa spdk_nvme_cmd_cb + * * This function may be called at any point while the controller is attached to * the SPDK NVMe driver. * diff --git a/lib/nvme/nvme_qpair.c b/lib/nvme/nvme_qpair.c index 462e9576f..6afdfaa8c 100644 --- a/lib/nvme/nvme_qpair.c +++ b/lib/nvme/nvme_qpair.c @@ -454,14 +454,6 @@ nvme_qpair_check_enabled(struct spdk_nvme_qpair *qpair) * using its own synchronization method. */ -/** - * \brief Checks for and processes completions on the specified qpair. - * - * For each completed command, the request's callback function will - * be called if specified as non-NULL when the request was submitted. - * - * \sa nvme_cb_fn_t - */ int32_t spdk_nvme_qpair_process_completions(struct spdk_nvme_qpair *qpair, uint32_t max_completions) {