diff mbox series

[10/41] bitfield: add explicit inclusions to the example

Message ID	20220323230548.3A593C340EE@smtp.kernel.org (mailing list archive)
State	New
Headers	show Return-Path: <owner-linux-mm@kvack.org> Date: Wed, 23 Mar 2022 16:05:47 -0700 To: peterz@infradead.org,jsd@semihalf.com,andriy.shevchenko@linux.intel.com,akpm@linux-foundation.org,patches@lists.linux.dev,linux-mm@kvack.org,mm-commits@vger.kernel.org,torvalds@linux-foundation.org,akpm@linux-foundation.org From: Andrew Morton <akpm@linux-foundation.org> In-Reply-To: <20220323160453.65922ced539cbf445b191555@linux-foundation.org> Subject: [patch 10/41] bitfield: add explicit inclusions to the example Message-Id: <20220323230548.3A593C340EE@smtp.kernel.org> Sender: owner-linux-mm@kvack.org Precedence: bulk
Series	[01/41] proc: alloc PATH_MAX bytes for /proc/${pid}/fd/ symlinks \| expand [01/41] proc: alloc PATH_MAX bytes for /proc/${pid}/fd/ symlinks [02/41] proc/vmcore: fix possible deadlock on concurrent mmap and read [03/41] proc/vmcore: fix vmcore_alloc_buf() kernel-doc comment [04/41] linux/types.h: remove unnecessary __bitwise__ [05/41] Documentation/sparse: add hints about __CHECKER__ [06/41] kernel/ksysfs.c: use helper macro __ATTR_RW [07/41] Kconfig.debug: make DEBUG_INFO selectable from a choice [08/41] include: drop pointless __compiler_offsetof indirection [09/41] ilog2: force inlining of __ilog2_u32() and __ilog2_u64() [10/41] bitfield: add explicit inclusions to the example [11/41] lib/Kconfig.debug: add ARCH dependency for FUNCTION_ALIGN option [12/41] lib: bitmap: fix many kernel-doc warnings [13/41] checkpatch: prefer MODULE_LICENSE("GPL") over MODULE_LICENSE("GPL v2") [14/41] checkpatch: add --fix option for some TRAILING_STATEMENTS [15/41] checkpatch: add early_param exception to blank line after struct/function test [16/41] checkpatch: use python3 to find codespell dictionary [17/41] init: use ktime_us_delta() to make initcall_debug log more precise [18/41] init.h: improve __setup and early_param documentation [19/41] init/main.c: return 1 from handled __setup() functions [20/41] fs/pipe: use kvcalloc to allocate a pipe_buffer array [21/41] fs/pipe.c: local vars have to match types of proper pipe_inode_info fields [22/41] minix: fix bug when opening a file with O_DIRECT [23/41] fat: use pointer to simple type in put_user() [24/41] cgroup: use irqsave in cgroup_rstat_flush_locked(). [25/41] kexec: make crashk_res, crashk_low_res and crash_notes symbols always visible [26/41] riscv: mm: init: use IS_ENABLED(CONFIG_KEXEC_CORE) instead of #ifdef [27/41] x86/setup: use IS_ENABLED(CONFIG_KEXEC_CORE) instead of #ifdef [28/41] arm64: mm: use IS_ENABLED(CONFIG_KEXEC_CORE) instead of #ifdef [29/41] docs: kdump: update description about sysfs file system support [30/41] docs: kdump: add scp example to write out the dump file [31/41] panic: unset panic_on_warn inside panic() [32/41] ubsan: no need to unset panic_on_warn in ubsan_epilogue() [33/41] kasan: no need to unset panic_on_warn in end_report() [34/41] taskstats: remove unneeded dead assignment [35/41] docs: sysctl/kernel: add missing bit to panic_print [36/41] panic: add option to dump all CPUs backtraces in panic_print [37/41] panic: move panic_print before kmsg dumpers [38/41] kcov: split ioctl handling into locked and unlocked parts [39/41] kcov: properly handle subsequent mmap calls [40/41] kernel/resource: fix kfree() of bootmem memory again [41/41] Revert "ubsan, kcsan: Don't combine sanitizer with kcov on clang"

Commit Message

Andrew Morton March 23, 2022, 11:05 p.m. UTC

From: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Subject: 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.

Link: https://lkml.kernel.org/r/20220207123341.47533-1-andriy.shevchenko@linux.intel.com
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")
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Reported-by: Jan Dąbroś <jsd@semihalf.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
---

 include/linux/bitfield.h |    3 +++
 1 file changed, 3 insertions(+)

diff mbox series

Patch

--- a/include/linux/bitfield.h~bitfield-add-explicit-inclusions-to-the-example
+++ a/include/linux/bitfield.h
@@ -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)