* [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include
@ 2021-05-20 9:39 Andrew Jeffery
2021-05-20 10:15 ` Dwaipayan Ray
` (3 more replies)
0 siblings, 4 replies; 5+ messages in thread
From: Andrew Jeffery @ 2021-05-20 9:39 UTC (permalink / raw)
To: linux-doc
Cc: dwaipayanray1, lukas.bulwahn, joe, corbet, linux-kernel, openbmc,
Jiri Slaby
While include/linux/bitops.h brings in the BIT() macro, it was moved to
include/linux/bits.h in commit 8bd9cb51daac ("locking/atomics, asm-generic:
Move some macros from <linux/bitops.h> to a new <linux/bits.h> file").
Since that commit BIT() has moved again into include/vdso/bits.h via
commit 3945ff37d2f4 ("linux/bits.h: Extract common header for vDSO").
I think the move to the vDSO header can be considered an implementation
detail, so for now update the checkpatch documentation to recommend use
of include/linux/bits.h.
Cc: Jiri Slaby <jirislaby@kernel.org>
Acked-by: 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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include
2021-05-20 9:39 [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include Andrew Jeffery
@ 2021-05-20 10:15 ` Dwaipayan Ray
2021-05-20 11:56 ` Lukas Bulwahn
` (2 subsequent siblings)
3 siblings, 0 replies; 5+ messages in thread
From: Dwaipayan Ray @ 2021-05-20 10:15 UTC (permalink / raw)
To: Andrew Jeffery
Cc: open list:DOCUMENTATION, Lukas Bulwahn, Joe Perches,
Jonathan Corbet, linux-kernel, openbmc, Jiri Slaby
On Thu, May 20, 2021 at 3:10 PM Andrew Jeffery <andrew@aj.id.au> wrote:
>
> While include/linux/bitops.h brings in the BIT() macro, it was moved to
> include/linux/bits.h in commit 8bd9cb51daac ("locking/atomics, asm-generic:
> Move some macros from <linux/bitops.h> to a new <linux/bits.h> file").
>
> Since that commit BIT() has moved again into include/vdso/bits.h via
> commit 3945ff37d2f4 ("linux/bits.h: Extract common header for vDSO").
>
> I think the move to the vDSO header can be considered an implementation
> detail, so for now update the checkpatch documentation to recommend use
> of include/linux/bits.h.
>
> Cc: Jiri Slaby <jirislaby@kernel.org>
> Acked-by: Jiri Slaby <jirislaby@kernel.org>
Looks good to me. Thanks.
Acked-by: Dwaipayan Ray <dwaipayanray1@gmail.com>
> 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
>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include
2021-05-20 9:39 [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include Andrew Jeffery
2021-05-20 10:15 ` Dwaipayan Ray
@ 2021-05-20 11:56 ` Lukas Bulwahn
2021-05-20 20:27 ` Jonathan Corbet
2021-05-21 0:59 ` Joel Stanley
3 siblings, 0 replies; 5+ messages in thread
From: Lukas Bulwahn @ 2021-05-20 11:56 UTC (permalink / raw)
To: Andrew Jeffery, open list:DOCUMENTATION, Jonathan Corbet
Cc: Dwaipayan Ray, Joe Perches, Linux Kernel Mailing List, openbmc,
Jiri Slaby
On Thu, May 20, 2021 at 11:40 AM Andrew Jeffery <andrew@aj.id.au> wrote:
>
> While include/linux/bitops.h brings in the BIT() macro, it was moved to
> include/linux/bits.h in commit 8bd9cb51daac ("locking/atomics, asm-generic:
> Move some macros from <linux/bitops.h> to a new <linux/bits.h> file").
>
> Since that commit BIT() has moved again into include/vdso/bits.h via
> commit 3945ff37d2f4 ("linux/bits.h: Extract common header for vDSO").
>
> I think the move to the vDSO header can be considered an implementation
> detail, so for now update the checkpatch documentation to recommend use
> of include/linux/bits.h.
>
> Cc: Jiri Slaby <jirislaby@kernel.org>
> Acked-by: Jiri Slaby <jirislaby@kernel.org>
> Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Acked-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Jonathan, can you please pick this patch into your doc-next tree? Thanks.
Lukas
> ---
> 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
>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include
2021-05-20 9:39 [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include Andrew Jeffery
2021-05-20 10:15 ` Dwaipayan Ray
2021-05-20 11:56 ` Lukas Bulwahn
@ 2021-05-20 20:27 ` Jonathan Corbet
2021-05-21 0:59 ` Joel Stanley
3 siblings, 0 replies; 5+ messages in thread
From: Jonathan Corbet @ 2021-05-20 20:27 UTC (permalink / raw)
To: Andrew Jeffery, linux-doc
Cc: dwaipayanray1, lukas.bulwahn, joe, linux-kernel, openbmc, Jiri Slaby
Andrew Jeffery <andrew@aj.id.au> writes:
> While include/linux/bitops.h brings in the BIT() macro, it was moved to
> include/linux/bits.h in commit 8bd9cb51daac ("locking/atomics, asm-generic:
> Move some macros from <linux/bitops.h> to a new <linux/bits.h> file").
>
> Since that commit BIT() has moved again into include/vdso/bits.h via
> commit 3945ff37d2f4 ("linux/bits.h: Extract common header for vDSO").
>
> I think the move to the vDSO header can be considered an implementation
> detail, so for now update the checkpatch documentation to recommend use
> of include/linux/bits.h.
>
> Cc: Jiri Slaby <jirislaby@kernel.org>
> Acked-by: 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::
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include
2021-05-20 9:39 [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include Andrew Jeffery
` (2 preceding siblings ...)
2021-05-20 20:27 ` Jonathan Corbet
@ 2021-05-21 0:59 ` Joel Stanley
3 siblings, 0 replies; 5+ messages in thread
From: Joel Stanley @ 2021-05-21 0:59 UTC (permalink / raw)
To: Andrew Jeffery
Cc: linux-doc, dwaipayanray1, Lukas Bulwahn, Joe Perches,
Jonathan Corbet, Linux Kernel Mailing List, OpenBMC Maillist,
Jiri Slaby
On Thu, 20 May 2021 at 17:14, Andrew Jeffery <andrew@aj.id.au> wrote:
>
> While include/linux/bitops.h brings in the BIT() macro, it was moved to
> include/linux/bits.h in commit 8bd9cb51daac ("locking/atomics, asm-generic:
> Move some macros from <linux/bitops.h> to a new <linux/bits.h> file").
>
> Since that commit BIT() has moved again into include/vdso/bits.h via
> commit 3945ff37d2f4 ("linux/bits.h: Extract common header for vDSO").
>
> I think the move to the vDSO header can be considered an implementation
> detail, so for now update the checkpatch documentation to recommend use
> of include/linux/bits.h.
>
> Cc: Jiri Slaby <jirislaby@kernel.org>
> Acked-by: Jiri Slaby <jirislaby@kernel.org>
> Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Reviewed-by: Joel Stanley <joel@jms.id.au>
...just a little bit
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2021-05-21 0:59 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-20 9:39 [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include Andrew Jeffery
2021-05-20 10:15 ` Dwaipayan Ray
2021-05-20 11:56 ` Lukas Bulwahn
2021-05-20 20:27 ` Jonathan Corbet
2021-05-21 0:59 ` Joel Stanley
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).