Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <c38c6875-7ca2-55dd-a1ec-ce7f903b795d@gmail.com>
Date:   Wed, 24 May 2023 23:10:48 +0900
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.11.0
Subject: Re: [PATCH 25/26] locking/atomic: docs: Add atomic operations to the
 driver basic API documentation
Content-Language: en-US
To:     Mark Rutland <mark.rutland@arm.com>, linux-kernel@vger.kernel.org
Cc:     boqun.feng@gmail.com, corbet@lwn.net, keescook@chromium.org,
        linux-arch@vger.kernel.org, linux@armlinux.org.uk,
        linux-doc@vger.kernel.org, paulmck@kernel.org,
        peterz@infradead.org, sstabellini@kernel.org, will@kernel.org,
        Akira Yokosawa <akiyks@gmail.com>
References: <20230522122429.1915021-1-mark.rutland@arm.com>
 <20230522122429.1915021-26-mark.rutland@arm.com>
From:   Akira Yokosawa <akiyks@gmail.com>
In-Reply-To: <20230522122429.1915021-26-mark.rutland@arm.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

On Mon, 22 May 2023 13:24:28 +0100, Mark Rutland wrote:
> From: "Paul E. McKenney" <paulmck@kernel.org>
> 
> Add the generated atomic headers to driver-api/basics.rst in order to
> provide documentation for the Linux kernel's atomic operations.
> 
> Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Kees Cook <keescook@chromium.org>
> Cc: Akira Yokosawa <akiyks@gmail.com>
> Cc: Will Deacon <will@kernel.org>
> Cc: Peter Zijlstra <peterz@infradead.org>
> Cc: Boqun Feng <boqun.feng@gmail.com>
> Cc: Mark Rutland <mark.rutland@arm.com>
> Cc: <linux-doc@vger.kernel.org>
> Reviewed-by: Kees Cook <keescook@chromium.org>
> [Mark: add atomic-long.h]
> Signed-off-by: Mark Rutland <mark.rutland@arm.com>
> ---
>  Documentation/driver-api/basics.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/driver-api/basics.rst b/Documentation/driver-api/basics.rst
> index 4b4d8e28d3be4..a1fbd97fb79fb 100644
> --- a/Documentation/driver-api/basics.rst
> +++ b/Documentation/driver-api/basics.rst
> @@ -87,6 +87,12 @@ Atomics
>  .. kernel-doc:: arch/x86/include/asm/atomic.h
>     :internal:
>  
> +.. kernel-doc:: include/linux/atomic/atomic-arch-fallback.h
> +   :internal:
> +
> +.. kernel-doc:: include/linux/atomic/atomic-long.h
> +   :internal:
> +

Why not add

  .. kernel-doc:: include/linux/atomic/atomic-instrumented.h
     :internal:

as well ??

I think those kernel-doc comments are the most relevant ones
for driver writers.

        Thanks, Akira

>  Kernel objects manipulation
>  ---------------------------
>