[dpdk-stable] [dpdk-dev] [PATCH] eal: fix bitmap documentation
Thomas Monjalon
thomas at monjalon.net
Wed Aug 1 17:55:31 CEST 2018
Cristian, review please?
17/07/2018 19:14, Jerin Jacob:
> n_bits comes as first argument, align doxygen comment.
>
> n_bit need to not be multiple of 512 as n_bits
> are rounding to RTE_BITMAP_CL_BIT_SIZE.
>
> Fixes: 14456f59e9f7 ("doc: fix doxygen warnings in QoS API")
> Fixes: de3cfa2c9823 ("sched: initial import")
>
> Cc: stable at dpdk.org
>
> Signed-off-by: Jerin Jacob <jerin.jacob at caviumnetworks.com>
> ---
> lib/librte_eal/common/include/rte_bitmap.h | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/lib/librte_eal/common/include/rte_bitmap.h b/lib/librte_eal/common/include/rte_bitmap.h
> index 7d4935fcc..d9facc642 100644
> --- a/lib/librte_eal/common/include/rte_bitmap.h
> +++ b/lib/librte_eal/common/include/rte_bitmap.h
> @@ -198,12 +198,12 @@ rte_bitmap_get_memory_footprint(uint32_t n_bits) {
> /**
> * Bitmap initialization
> *
> - * @param mem_size
> - * Minimum expected size of bitmap.
> + * @param n_bits
> + * Number of pre-allocated bits in array2.
> * @param mem
> * Base address of array1 and array2.
> - * @param n_bits
> - * Number of pre-allocated bits in array2. Must be non-zero and multiple of 512.
> + * @param mem_size
> + * Minimum expected size of bitmap.
> * @return
> * Handle to bitmap instance.
> */
>
More information about the stable
mailing list