[PATCH] docs: futex: Fix kernel-doc references after code split-up preparation
authorSalvatore Bonaccorso <carnil@debian.org>
Fri, 21 Apr 2023 20:14:43 +0000 (22:14 +0200)
committerSalvatore Bonaccorso <carnil@debian.org>
Sat, 22 Apr 2023 12:24:15 +0000 (13:24 +0100)
In upstream commit 77e52ae35463 ("futex: Move to kernel/futex/") the
futex code from kernel/futex.c was moved into kernel/futex/core.c in
preparation of the split-up of the implementation in various files.

Point kernel-doc references to the new files as otherwise the
documentation shows errors on build:

    [...]
    Error: Cannot open file ./kernel/futex.c
    Error: Cannot open file ./kernel/futex.c
    [...]
    WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -sphinx-version 3.4.3 -internal ./kernel/futex.c' failed with return code 2

There is no direct upstream commit for this change. It is made in
analogy to commit bc67f1c454fb ("docs: futex: Fix kernel-doc
references") applied as consequence of the restructuring of the futex
code.

Fixes: 77e52ae35463 ("futex: Move to kernel/futex/")
Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
Gbp-Pq: Topic bugfix/all
Gbp-Pq: Name docs-futex-Fix-kernel-doc-references-after-code-spli.patch

Documentation/kernel-hacking/locking.rst
Documentation/translations/it_IT/kernel-hacking/locking.rst

index 6ed806e6061bba317d67475c67586b4eeab7387c..a6d89efede790faf30ed8f859cb20704c9efc9c5 100644 (file)
@@ -1358,7 +1358,7 @@ Mutex API reference
 Futex API reference
 ===================
 
-.. kernel-doc:: kernel/futex.c
+.. kernel-doc:: kernel/futex/core.c
    :internal:
 
 Further reading
index bf1acd6204efab7fdde5e265803094180ec29b1a..192ab8e281252909c15cebd83d932306a13dd7b7 100644 (file)
@@ -1400,7 +1400,7 @@ Riferimento per l'API dei Mutex
 Riferimento per l'API dei Futex
 ===============================
 
-.. kernel-doc:: kernel/futex.c
+.. kernel-doc:: kernel/futex/core.c
    :internal:
 
 Approfondimenti