[tip: locking/core] docs: futex: Fix kernel-doc references

From: tip-bot2 for André Almeida
Date: Tue Oct 19 2021 - 11:35:49 EST


The following commit has been merged into the locking/core branch of tip:

Commit-ID: bc67f1c454fbc79b148f0b47227929da82f4b026
Gitweb: https://git.kernel.org/tip/bc67f1c454fbc79b148f0b47227929da82f4b026
Author: André Almeida <andrealmeid@xxxxxxxxxxxxx>
AuthorDate: Tue, 12 Oct 2021 10:55:49 -03:00
Committer: Peter Zijlstra <peterz@xxxxxxxxxxxxx>
CommitterDate: Tue, 19 Oct 2021 17:27:05 +02:00

docs: futex: Fix kernel-doc references

Since the futex code was restructured, there's no futex.c file anymore
and the implementation is split in various files. Point kernel-doc
references to the new files.

Signed-off-by: André Almeida <andrealmeid@xxxxxxxxxxxxx>
Signed-off-by: Peter Zijlstra (Intel) <peterz@xxxxxxxxxxxxx>
Link: https://lkml.kernel.org/r/20211012135549.14451-1-andrealmeid@xxxxxxxxxxxxx
---
Documentation/kernel-hacking/locking.rst | 14 ++++++-
Documentation/translations/it_IT/kernel-hacking/locking.rst | 14 ++++++-
2 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/Documentation/kernel-hacking/locking.rst b/Documentation/kernel-hacking/locking.rst
index 90bc3f5..e6cd406 100644
--- a/Documentation/kernel-hacking/locking.rst
+++ b/Documentation/kernel-hacking/locking.rst
@@ -1352,7 +1352,19 @@ Mutex API reference
Futex API reference
===================

-.. kernel-doc:: kernel/futex.c
+.. kernel-doc:: kernel/futex/core.c
+ :internal:
+
+.. kernel-doc:: kernel/futex/futex.h
+ :internal:
+
+.. kernel-doc:: kernel/futex/pi.c
+ :internal:
+
+.. kernel-doc:: kernel/futex/requeue.c
+ :internal:
+
+.. kernel-doc:: kernel/futex/waitwake.c
:internal:

Further reading
diff --git a/Documentation/translations/it_IT/kernel-hacking/locking.rst b/Documentation/translations/it_IT/kernel-hacking/locking.rst
index 1efb829..163f1bd 100644
--- a/Documentation/translations/it_IT/kernel-hacking/locking.rst
+++ b/Documentation/translations/it_IT/kernel-hacking/locking.rst
@@ -1396,7 +1396,19 @@ Riferimento per l'API dei Mutex
Riferimento per l'API dei Futex
===============================

-.. kernel-doc:: kernel/futex.c
+.. kernel-doc:: kernel/futex/core.c
+ :internal:
+
+.. kernel-doc:: kernel/futex/futex.h
+ :internal:
+
+.. kernel-doc:: kernel/futex/pi.c
+ :internal:
+
+.. kernel-doc:: kernel/futex/requeue.c
+ :internal:
+
+.. kernel-doc:: kernel/futex/waitwake.c
:internal:

Approfondimenti