diff options
| author | Paul E. McKenney <paulmck@kernel.org> | 2023-06-05 09:01:23 +0200 |
|---|---|---|
| committer | Peter Zijlstra <peterz@infradead.org> | 2023-06-05 09:57:24 +0200 |
| commit | e74f4059d11f36e936b08e98bc96f654c308807a (patch) | |
| tree | 9f0d3fbbc84b3de048f7c3a7ba29468d238dd00c /Documentation | |
| parent | locking/atomic: scripts: generate kerneldoc comments (diff) | |
| download | linux-e74f4059d11f36e936b08e98bc96f654c308807a.tar.xz linux-e74f4059d11f36e936b08e98bc96f654c308807a.zip | |
locking/atomic: docs: Add atomic operations to the driver basic API documentation
Add the generated atomic headers to driver-api/basics.rst in order to
provide documentation for the Linux kernel's atomic operations.
At the same time, dtop the x86 atomic header, which provides kerneldoc
comments for some arch_atomic*_*() operations. The arch_atomic*_*()
operations are now purely an implenentation detail of the
raw_atomic*_*() ops, and outside of implementing the atomics, code
should use the raw_atomic*_*() forms.
[Mark: add atomic-{instrumented,long}.h, update commit message]
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Signed-off-by: Mark Rutland <mark.rutland@arm.com>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Reviewed-by: Kees Cook <keescook@chromium.org>
Link: https://lore.kernel.org/r/20230605070124.3741859-27-mark.rutland@arm.com
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/driver-api/basics.rst | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/Documentation/driver-api/basics.rst b/Documentation/driver-api/basics.rst index 4b4d8e28d3be..7671b531ba1a 100644 --- a/Documentation/driver-api/basics.rst +++ b/Documentation/driver-api/basics.rst @@ -84,7 +84,13 @@ Reference counting Atomics ------- -.. kernel-doc:: arch/x86/include/asm/atomic.h +.. kernel-doc:: include/linux/atomic/atomic-instrumented.h + :internal: + +.. kernel-doc:: include/linux/atomic/atomic-arch-fallback.h + :internal: + +.. kernel-doc:: include/linux/atomic/atomic-long.h :internal: Kernel objects manipulation |