[PATCH] linux/bitopts.h: Add for_each_set_clump8 documentation

[William Breathitt Gray]

Document in kerneldoc form the for_each_set_clump8 macro.

Signed-off-by: William Breathitt Gray <vilhelm.gray@xxxxxxxxx>
---
 include/linux/bitops.h | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/include/linux/bitops.h b/include/linux/bitops.h
index fb94a10f7853..76ec8f0ce3e8 100644
--- a/include/linux/bitops.h
+++ b/include/linux/bitops.h
@@ -40,6 +40,13 @@ extern unsigned long __sw_hweight64(__u64 w);
 	     (bit) < (size);					\
 	     (bit) = find_next_zero_bit((addr), (size), (bit) + 1))
 
+/**
+ * for_each_set_clump8 - iterate over bitmap for each 8-bit clump with set bits
+ * @start: bit offset to start search and to store the current iteration offset
+ * @clump: location to store copy of current 8-bit clump
+ * @bits: bitmap address to base the search on
+ * @size: bitmap size in number of bits
+ */
 #define for_each_set_clump8(start, clump, bits, size) \
 	for ((start) = find_first_clump8(&(clump), (bits), (size)); \
 	     (start) < (size); \
-- 
2.23.0