All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
To: Andrew Jeffery <andrew@aj.id.au>,
	"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Cc: Dwaipayan Ray <dwaipayanray1@gmail.com>,
	Joe Perches <joe@perches.com>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	openbmc@lists.ozlabs.org, Jiri Slaby <jirislaby@kernel.org>
Subject: Re: [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include
Date: Thu, 20 May 2021 13:56:24 +0200	[thread overview]
Message-ID: <CAKXUXMy0CziXXHJBzz8bJBj-wE0f6L1JSK2KuHwBzkbk_F+4iA@mail.gmail.com> (raw)
In-Reply-To: <20210520093949.511471-1-andrew@aj.id.au>

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
>

WARNING: multiple messages have this Message-ID (diff)
From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
To: Andrew Jeffery <andrew@aj.id.au>,
	"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
	 Jonathan Corbet <corbet@lwn.net>
Cc: Joe Perches <joe@perches.com>,
	Dwaipayan Ray <dwaipayanray1@gmail.com>,
	openbmc@lists.ozlabs.org, Jiri Slaby <jirislaby@kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include
Date: Thu, 20 May 2021 13:56:24 +0200	[thread overview]
Message-ID: <CAKXUXMy0CziXXHJBzz8bJBj-wE0f6L1JSK2KuHwBzkbk_F+4iA@mail.gmail.com> (raw)
In-Reply-To: <20210520093949.511471-1-andrew@aj.id.au>

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
>

  parent reply	other threads:[~2021-05-20 12:39 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-20  9:39 [PATCH v2] Documentation: checkpatch: Tweak BIT() macro include Andrew Jeffery
2021-05-20  9:39 ` Andrew Jeffery
2021-05-20 10:15 ` Dwaipayan Ray
2021-05-20 10:15   ` Dwaipayan Ray
2021-05-20 11:56 ` Lukas Bulwahn [this message]
2021-05-20 11:56   ` Lukas Bulwahn
2021-05-20 20:27 ` Jonathan Corbet
2021-05-20 20:27   ` Jonathan Corbet
2021-05-21  0:59 ` Joel Stanley
2021-05-21  0:59   ` Joel Stanley

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=CAKXUXMy0CziXXHJBzz8bJBj-wE0f6L1JSK2KuHwBzkbk_F+4iA@mail.gmail.com \
    --to=lukas.bulwahn@gmail.com \
    --cc=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=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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.