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>
This commit is contained in:
Jim Harris 2018-10-04 08:27:44 -07:00
parent 74a28c199f
commit b3c330339d

View File

@ -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. * \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. * \return a pointer to the new bit array.
*/ */
struct spdk_bit_array *spdk_bit_array_create(uint32_t num_bits); struct spdk_bit_array *spdk_bit_array_create(uint32_t num_bits);