2021-05-20 16:40:05

by Andrew Jeffery

Subject: [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include

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 <[email protected]>
Acked-by: Jiri Slaby <[email protected]>
Signed-off-by: Andrew Jeffery <[email protected]>
---
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

2021-05-21 02:44:47

by Lukas Bulwahn

Subject: Re: [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include

On Thu, May 20, 2021 at 11:40 AM Andrew Jeffery <[email protected]> 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 <[email protected]>
> Acked-by: Jiri Slaby <[email protected]>
> Signed-off-by: Andrew Jeffery <[email protected]>


Acked-by: Lukas Bulwahn <[email protected]>

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
>

2021-05-21 07:53:53

by Jonathan Corbet

Subject: Re: [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include

Andrew Jeffery <[email protected]> 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 <[email protected]>
> Acked-by: Jiri Slaby <[email protected]>
> Signed-off-by: Andrew Jeffery <[email protected]>
> ---
> 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

2021-05-21 08:57:33

by Joel Stanley

Subject: Re: [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include

On Thu, 20 May 2021 at 17:14, Andrew Jeffery <[email protected]> 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 <[email protected]>
> Acked-by: Jiri Slaby <[email protected]>
> Signed-off-by: Andrew Jeffery <[email protected]>

Reviewed-by: Joel Stanley <[email protected]>

...just a little bit