eal: fix bitmap documentation
diff mbox series

Message ID 20180717171417.31425-1-jerin.jacob@caviumnetworks.com
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • eal: fix bitmap documentation
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Jerin Jacob July 17, 2018, 5:14 p.m. UTC
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@dpdk.org

Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
---
 lib/librte_eal/common/include/rte_bitmap.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Thomas Monjalon Aug. 1, 2018, 3:55 p.m. UTC | #1
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@dpdk.org
> 
> Signed-off-by: Jerin Jacob <jerin.jacob@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.
>   */
>
Dumitrescu, Cristian Aug. 2, 2018, 2:34 p.m. UTC | #2
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Wednesday, August 1, 2018 4:56 PM
> To: Dumitrescu, Cristian <cristian.dumitrescu@intel.com>
> Cc: stable@dpdk.org; Jerin Jacob <jerin.jacob@caviumnetworks.com>;
> dev@dpdk.org
> Subject: Re: [dpdk-stable] [dpdk-dev] [PATCH] eal: fix bitmap documentation
> 
> 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@dpdk.org
> >
> > Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> > ---

Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
Thomas Monjalon Aug. 5, 2018, 6:12 p.m. UTC | #3
02/08/2018 16:34, Dumitrescu, Cristian:
> > 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@dpdk.org
> > >
> > > Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> > > ---
> 
> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>

Applied, thanks

Patch
diff mbox series

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.
  */