nbd: correct notes of spdk_nbd_start API

Change-Id: I19fddd5345224ebee8d5e942378af1f6d60eb9da
Signed-off-by: Xiaodong Liu <xiaodong.liu@intel.com>
Reviewed-on: https://review.gerrithub.io/c/445060
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Pawel Wodkowski <pawelx.wodkowski@intel.com>
Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
This commit is contained in:
Xiaodong Liu 2019-02-18 21:16:11 +08:00 committed by Changpeng Liu
parent 954728e9df
commit de976cf331

View File

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