d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

nvme: remove duplicated doc comment

Browse Source 
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 <daniel.verkamp@intel.com>
This commit is contained in:
Daniel Verkamp 2016-03-29 10:26:28 -07:00
parent e7499dc328
commit 7d74bd7072
2 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/spdk/nvme.h
View File

@ -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.
*

8
lib/nvme/nvme_qpair.c
View File

@ -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)
{