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

Akira Yokosawa
2023-05-24T14:11:02Z

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
> ---------------------------
>