Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
From:   William Breathitt Gray <vilhelm.gray@gmail.com>
To:     akpm@linux-foundation.org
Cc:     linux-kernel@vger.kernel.org, andriy.shevchenko@linux.intel.com,
        William Breathitt Gray <vilhelm.gray@gmail.com>
Subject: [PATCH] linux/bitopts.h: Add for_each_set_clump8 documentation
Date:   Wed, 16 Oct 2019 12:18:25 -0400
Message-Id: <20191016161825.301082-1-vilhelm.gray@gmail.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

Document in kerneldoc form the for_each_set_clump8 macro.

Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com>
---
 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