From bba9e8dbca9ef8d0b447be26aea5d34c4234bc90 Mon Sep 17 00:00:00 2001
From: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Date: Sat, 10 Oct 2020 18:51:02 +0900
Subject: [PATCH] bdev/part: Fix wrong doc about return value of
 spdk_bdev_part_base_construct()

Signed-off-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Change-Id: I133f08648b783d3faa8e1a8d3655812630106dab
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/4586
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
---
 include/spdk/bdev_module.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/spdk/bdev_module.h b/include/spdk/bdev_module.h
index edf967897..9afc29390 100644
--- a/include/spdk/bdev_module.h
+++ b/include/spdk/bdev_module.h
@@ -1100,8 +1100,8 @@ void spdk_bdev_part_base_hotremove(struct spdk_bdev_part_base *part_base,
  * \param ch_create_cb Called after a new channel is allocated.
  * \param ch_destroy_cb Called upon channel deletion.
  *
- * \return 0 on success
- * \return -1 if the underlying bdev cannot be opened.
+ * \return The part object on top of the bdev if operation is successful, or
+ * NULL otherwise.
  */
 struct spdk_bdev_part_base *spdk_bdev_part_base_construct(struct spdk_bdev *bdev,
 		spdk_bdev_remove_cb_t remove_cb,