aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJon Loeliger <jdl@netgate.com>2022-08-18 09:19:43 -0500
committerMatthew Smith <mgsmith@netgate.com>2022-08-18 15:32:28 +0000
commit32b93d4800bf6165708b068e12b63cebb5bdc1fe (patch)
tree6ea88b7ee849689d905bce0f300f5e21f6ab5638
parent07c42c0eea2d7ad3081f10df62f9502219301a6e (diff)
vppinfra: correct clib_bitmap_set() return comment
Fix a copy-n-paste issue that left clib_bitmap_set()'s return type documentation incorrect. Chnage it to indicate that the function returns a new pointer for the bitmap that could be different due to a possible reallocation. Type: docs Signed-off-by: Jon Loeliger <jdl@netgate.com> Change-Id: Ia193c4673c0e4d1760e91cd7f80ebe1868a3c9b5
-rw-r--r--src/vppinfra/bitmap.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/vppinfra/bitmap.h b/src/vppinfra/bitmap.h
index 02f9c7e55ab..ec3f0a03891 100644
--- a/src/vppinfra/bitmap.h
+++ b/src/vppinfra/bitmap.h
@@ -178,7 +178,7 @@ clib_bitmap_set_no_check (uword * a, uword i, uword new_value)
@param ai - pointer to the bitmap
@param i - the bit position to interrogate
@param value - new value for the bit
- @returns the old value of the bit
+ @returns the (possibly reallocated) bitmap object pointer
*/
always_inline uword *
clib_bitmap_set (uword * ai, uword i, uword value)