From b3c330339d17d0efea84e4c51b53bf731cf5e4e4 Mon Sep 17 00:00:00 2001
From: Jim Harris <james.r.harris@intel.com>
Date: Thu, 4 Oct 2018 08:27:44 -0700
Subject: [PATCH] bit_array: clarify initial bit values for create()

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: If0ee1ebfcf3400efcf79185adf55dc9308f06fc4

Reviewed-on: https://review.gerrithub.io/428079
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
---
 include/spdk/bit_array.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/include/spdk/bit_array.h b/include/spdk/bit_array.h
index fb28a0f93..a69047ff7 100644
--- a/include/spdk/bit_array.h
+++ b/include/spdk/bit_array.h
@@ -63,6 +63,8 @@ uint32_t spdk_bit_array_capacity(const struct spdk_bit_array *ba);
  *
  * \param num_bits Number of bits that the bit array is sized to hold.
  *
+ * All bits in the array will be cleared.
+ *
  * \return a pointer to the new bit array.
  */
 struct spdk_bit_array *spdk_bit_array_create(uint32_t num_bits);