Commit de976cf3 authored by Xiaodong Liu's avatar Xiaodong Liu Committed by Changpeng Liu
Browse files

nbd: correct notes of spdk_nbd_start API 



Change-Id: I19fddd5345224ebee8d5e942378af1f6d60eb9da
Signed-off-by: default avatarXiaodong Liu <xiaodong.liu@intel.com>
Reviewed-on: https://review.gerrithub.io/c/445060


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarPawel Wodkowski <pawelx.wodkowski@intel.com>
Reviewed-by: default avatarDarek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
parent 954728e9

include/spdk/nbd.h

+2 −3
Original line number Diff line number Diff line
@@ -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);