linux-kernel - Re: [PATCH 25/26] locking/atomic: docs: Add atomic operations to the driver basic API documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <c38c6875-7ca2-55dd-a1ec-ce7f903b795d@gmail.com>
Date:   Wed, 24 May 2023 23:10:48 +0900
From:   Akira Yokosawa <akiyks@...il.com>
To:     Mark Rutland <mark.rutland@....com>, linux-kernel@...r.kernel.org
Cc:     boqun.feng@...il.com, corbet@....net, keescook@...omium.org,
        linux-arch@...r.kernel.org, linux@...linux.org.uk,
        linux-doc@...r.kernel.org, paulmck@...nel.org,
        peterz@...radead.org, sstabellini@...nel.org, will@...nel.org,
        Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH 25/26] locking/atomic: docs: Add atomic operations to the
 driver basic API documentation

On Mon, 22 May 2023 13:24:28 +0100, Mark Rutland wrote:
> From: "Paul E. McKenney" <paulmck@...nel.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@...nel.org>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: Kees Cook <keescook@...omium.org>
> Cc: Akira Yokosawa <akiyks@...il.com>
> Cc: Will Deacon <will@...nel.org>
> Cc: Peter Zijlstra <peterz@...radead.org>
> Cc: Boqun Feng <boqun.feng@...il.com>
> Cc: Mark Rutland <mark.rutland@....com>
> Cc: <linux-doc@...r.kernel.org>
> Reviewed-by: Kees Cook <keescook@...omium.org>
> [Mark: add atomic-long.h]
> Signed-off-by: Mark Rutland <mark.rutland@....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
>  ---------------------------
>