From: Andrew Jeffery <andrew@aj.id.au>
To: linux-doc@vger.kernel.org
Cc: dwaipayanray1@gmail.com, lukas.bulwahn@gmail.com,
joe@perches.com, corbet@lwn.net, linux-kernel@vger.kernel.org,
openbmc@lists.ozlabs.org, Jiri Slaby <jirislaby@kernel.org>
Subject: [PATCH] Documentation: checkpatch: Tweak BIT() macro include
Date: Thu, 20 May 2021 11:27:04 +0930 [thread overview]
Message-ID: <20210520015704.489737-1-andrew@aj.id.au> (raw)
While include/linux/bitops.h brings in the BIT() macro, it was moved to
include/linux/bits.h in [1]. Since [1] BIT() has moved again into
include/vdso/bits.h via [2].
I think the move to the vDSO header can be considered a implementation
detail, so for now update the checkpatch documentation to recommend use
of include/linux/bits.h.
[1] commit 8bd9cb51daac ("locking/atomics, asm-generic: Move some macros from <linux/bitops.h> to a new <linux/bits.h> file")
[2] commit 3945ff37d2f4 ("linux/bits.h: Extract common header for vDSO")
Cc: Jiri Slaby <jirislaby@kernel.org>
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
---
Documentation/dev-tools/checkpatch.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
index 51fed1bd72ec..59fcc9f627ea 100644
--- a/Documentation/dev-tools/checkpatch.rst
+++ b/Documentation/dev-tools/checkpatch.rst
@@ -472,7 +472,7 @@ Macros, Attributes and Symbols
**BIT_MACRO**
Defines like: 1 << <digit> could be BIT(digit).
- The BIT() macro is defined in include/linux/bitops.h::
+ The BIT() macro is defined via include/linux/bits.h::
#define BIT(nr) (1UL << (nr))
--
2.30.2
next reply other threads:[~2021-05-20 1:57 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-20 1:57 Andrew Jeffery [this message]
2021-05-20 5:24 ` [PATCH] Documentation: checkpatch: Tweak BIT() macro include Jiri Slaby
2021-05-20 6:58 ` Lukas Bulwahn
2021-05-20 7:24 ` Andrew Jeffery
2021-05-20 9:17 ` Dwaipayan Ray
2021-05-20 9:44 ` Andrew Jeffery
2021-05-20 10:21 ` Dwaipayan Ray
2021-05-20 12:06 ` Lukas Bulwahn
2021-05-20 13:02 ` Dwaipayan Ray
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210520015704.489737-1-andrew@aj.id.au \
--to=andrew@aj.id.au \
--cc=corbet@lwn.net \
--cc=dwaipayanray1@gmail.com \
--cc=jirislaby@kernel.org \
--cc=joe@perches.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
--cc=openbmc@lists.ozlabs.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).