summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJerin Jacob <jerin.jacob@caviumnetworks.com>2018-07-17 22:44:17 +0530
committerYongseok Koh <yskoh@mellanox.com>2018-08-13 11:46:03 -0700
commit22d9bf3be5ed40f0c74c06323b3873d9137b6050 (patch)
tree6e0b84469dbde311b7d6f2da5d7162c0004d334d
parentd89f41e094fdbc5af2dcf2d7aa870b23f9491c56 (diff)
downloaddpdk-stable-22d9bf3be5ed40f0c74c06323b3873d9137b6050.zip
dpdk-stable-22d9bf3be5ed40f0c74c06323b3873d9137b6050.tar.gz
dpdk-stable-22d9bf3be5ed40f0c74c06323b3873d9137b6050.tar.xz
eal: fix bitmap documentation
[ upstream commit ebaa25f0700e95063d783911d30c476a1c86d336 ] 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") Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
-rw-r--r--lib/librte_eal/common/include/rte_bitmap.h8
1 files 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 b9067e6..13bfd9c 100644
--- a/lib/librte_eal/common/include/rte_bitmap.h
+++ b/lib/librte_eal/common/include/rte_bitmap.h
@@ -227,12 +227,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.
*/