From de976cf33180050fb9a6b2bcd73c17c8c3976b80 Mon Sep 17 00:00:00 2001 From: Xiaodong Liu Date: Mon, 18 Feb 2019 21:16:11 +0800 Subject: [PATCH] nbd: correct notes of spdk_nbd_start API Change-Id: I19fddd5345224ebee8d5e942378af1f6d60eb9da Signed-off-by: Xiaodong Liu Reviewed-on: https://review.gerrithub.io/c/445060 Tested-by: SPDK CI Jenkins Reviewed-by: Pawel Wodkowski Reviewed-by: Darek Stojaczyk Reviewed-by: Shuhei Matsumoto Reviewed-by: Changpeng Liu --- include/spdk/nbd.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/include/spdk/nbd.h b/include/spdk/nbd.h index 00133fd5e..18b439810 100644 --- a/include/spdk/nbd.h +++ b/include/spdk/nbd.h @@ -61,6 +61,7 @@ void spdk_nbd_fini(void); /** * Called when an NBD device has been started. + * On success, rc is assigned 0; On failure, rc is assigned negated errno. */ typedef void (*spdk_nbd_start_cb)(void *cb_arg, struct spdk_nbd_disk *nbd, int rc); @@ -70,10 +71,8 @@ typedef void (*spdk_nbd_start_cb)(void *cb_arg, struct spdk_nbd_disk *nbd, * * \param bdev_name Name of bdev exposed as a network block device. * \param nbd_path Path to the registered network block device. - * \param cb_fn Called when the device has been started. + * \param cb_fn Callback to be always called. * \param cb_arg Passed to cb_fn. - * - * \return A negated error number is passed to cb_fn on failure. */ void spdk_nbd_start(const char *bdev_name, const char *nbd_path, spdk_nbd_start_cb cb_fn, void *cb_arg);