Skip to contentSkip to conversation

bitfield: Add explicit inclusions to the example

PATCH Applied Andy Shevchenko 1 participant 1 message Feb 7, 2022 Bitmap API

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 bitfield: Add explicit inclusions to the example

It's not obvious that bitfield.h doesn't guarantee the bits.h inclusion and the example in the former is confusing. Some developers think that it's okay to just include bitfield.h to get it working. Change example to explicitly include necessary headers in order to avoid confusion.

Fixes 3e9b3112ec74 ("add basic register-field manipulation macros")

Depends-on: 8bd9cb51daac ("locking/atomics, asm-generic: Move some macros from <linux/bitops.h> to a new <linux/bits.h> file")

---
v2: used full paths

 include/linux/bitfield.h | 3 +++
 1 file changed, 3 insertions(+)
include/linux/bitfield.h +3 -0
index 6093fa6db260..c9be1657f03d 100644
@@ -19,6 +19,9 @@
  *
  * Example:
  *
+ *  #include <linux/bitfield.h>
+ *  #include <linux/bits.h>
+ *
  *  #define REG_FIELD_A  GENMASK(6, 0)
  *  #define REG_FIELD_B  BIT(7)
  *  #define REG_FIELD_C  GENMASK(15, 8)
Signature · 1 line
2.34.1