bitops/find: clarify and extend documentation
Subsystems (2)
PATCH 1/1 bitops/find: clarify and extend documentation
Add return value documentation and clarify the units of the @size parameter.
Signed-off-by Cody P Schafer <[email protected]>
--- include/asm-generic/bitops/find.h | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-)
include/asm-generic/bitops/find.h +10 -2
@@ -7,6 +7,9 @@* @addr: The address to base the search on * @offset: The bitnumber to start searching at * @size: The bitmap size in bits +* +* Returns the bit number for the next set bit +* If no bits are set, returns @size. */ extern unsigned long find_next_bit (const unsigned long *addr,unsigned long size,unsigned long offset);
@@ -18,6 +21,9 @@ extern unsigned long find_next_bit(const unsigned long *addr, unsigned long* @addr: The address to base the search on * @offset: The bitnumber to start searching at * @size: The bitmap size in bits +* +* Returns the bit number of the next zero bit +* If no bits are zero, returns @size. */ extern unsigned long find_next_zero_bit (const unsigned long *addr,unsigned long size,unsigned long offset);
@@ -28,9 +34,10 @@ extern unsigned long find_next_zero_bit(const unsigned long *addr, unsigned/** * find_first_bit - find the first set bit in a memory region * @addr: The address to start the search at -* @size: The maximum size to search +* @size: The maximum number of bits to search * * Returns the bit number of the first set bit. +* If no bits are set, returns @size. */ extern unsigned long find_first_bit (const unsigned long *addr,unsigned long size);
@@ -38,9 +45,10 @@ extern unsigned long find_first_bit(const unsigned long *addr,/** * find_first_zero_bit - find the first cleared bit in a memory region * @addr: The address to start the search at -* @size: The maximum size to search +* @size: The maximum number of bits to search * * Returns the bit number of the first cleared bit. +* If no bits are zero, returns @size. */ extern unsigned long find_first_zero_bit (const unsigned long *addr,unsigned long size);
Signature · 1 line
1.8.1.5