Add the include/linux/atomic/atomic-arch-fallback.h file to the
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>
---
 Documentation/driver-api/basics.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/driver-api/basics.rst b/Documentation/driver-api/basics.rst
index 4b4d8e28d3be..0ae07f0d8601 100644
--- a/Documentation/driver-api/basics.rst
+++ b/Documentation/driver-api/basics.rst
@@ -87,6 +87,9 @@ Atomics
 .. kernel-doc:: arch/x86/include/asm/atomic.h
    :internal:
 
+.. kernel-doc:: include/linux/atomic/atomic-arch-fallback.h
+   :internal:
+
 Kernel objects manipulation
 ---------------------------
 
-- 
2.40.1

On Wed, May 10, 2023 at 11:17:17AM -0700, Paul E. McKenney wrote:
> Add the include/linux/atomic/atomic-arch-fallback.h file to the
> 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>

Reviewed-by: Kees Cook <keescook@chromium.org>

-- 
Kees Cook

On Tue, May 16, 2023 at 02:33:29PM -0700, Kees Cook wrote:
> On Wed, May 10, 2023 at 11:17:17AM -0700, Paul E. McKenney wrote:
> > Add the include/linux/atomic/atomic-arch-fallback.h file to the
> > 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>
> 
> Reviewed-by: Kees Cook <keescook@chromium.org>

Thank you, Kees, I will apply on my next rebase.

Given Mark's ongoing atomics rework, a later version of this patch is
likely to remove ".. kernel-doc:: arch/x86/include/asm/atomic.h" from
that same file.  (One of the benefits of Mark's rework is that all the
kernel-doc headers can be in the same file.)

Unless you tell me otherwise, I will retain your Reviewed-by across that
change.

							Thanx, Paul

On Wed, May 17, 2023 at 03:10:44AM -0700, Paul E. McKenney wrote:
> On Tue, May 16, 2023 at 02:33:29PM -0700, Kees Cook wrote:
> > On Wed, May 10, 2023 at 11:17:17AM -0700, Paul E. McKenney wrote:
> > > Add the include/linux/atomic/atomic-arch-fallback.h file to the
> > > 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>
> > 
> > Reviewed-by: Kees Cook <keescook@chromium.org>
> 
> Thank you, Kees, I will apply on my next rebase.
> 
> Given Mark's ongoing atomics rework, a later version of this patch is
> likely to remove ".. kernel-doc:: arch/x86/include/asm/atomic.h" from
> that same file.  (One of the benefits of Mark's rework is that all the
> kernel-doc headers can be in the same file.)

FWIW, I retained that in the series I just posted at:

  https://lore.kernel.org/lkml/20230522122429.1915021-1-mark.rutland@arm.com/

... which drops ".. kernel-doc:: arch/x86/include/asm/atomic.h" as mentioned
above.

Please let me know if you'd like that R-b dropped.

Thanks,
Mark.