[PATCH -next] Documentation: futex: handle source file rename

[PATCH -next] Documentation: futex: handle source file rename

[Randy Dunlap]

Handle the move/rename of kernel/futex.c to kernel/futex/core.c.

Prevents docs build errors and warnings:

Error: Cannot open file ../kernel/futex.c
Error: Cannot open file ../kernel/futex.c
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 1.8.5 -internal ../kernel/futex.c' failed with return code 2
WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno -sphinx-version 1.8.5 -internal ../kernel/futex.c' failed with return code 2

Fixes: 77e52ae35463 ("futex: Move to kernel/futex/")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Darren Hart <dvhart@infradead.org>
Cc: Davidlohr Bueso <dave@stgolabs.net>
Cc: André Almeida <andrealmeid@collabora.com>
Cc: linux-doc@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
---
 Documentation/kernel-hacking/locking.rst                    |    2 +-
 Documentation/translations/it_IT/kernel-hacking/locking.rst |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20211018.orig/Documentation/kernel-hacking/locking.rst
+++ linux-next-20211018/Documentation/kernel-hacking/locking.rst
@@ -1352,7 +1352,7 @@ Mutex API reference
 Futex API reference
 ===================
 
-.. kernel-doc:: kernel/futex.c
+.. kernel-doc:: kernel/futex/core.c
    :internal:
 
 Further reading
--- linux-next-20211018.orig/Documentation/translations/it_IT/kernel-hacking/locking.rst
+++ linux-next-20211018/Documentation/translations/it_IT/kernel-hacking/locking.rst
@@ -1396,7 +1396,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

Re: [PATCH -next] Documentation: futex: handle source file rename

[André Almeida]

Hi Randy,

Às 23:22 de 18/10/21, Randy Dunlap escreveu:
> Handle the move/rename of kernel/futex.c to kernel/futex/core.c.
> 
> Prevents docs build errors and warnings:
> 
> Error: Cannot open file ../kernel/futex.c
> Error: Cannot open file ../kernel/futex.c
> 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 1.8.5 -internal ../kernel/futex.c' failed with return code 2
> WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno -sphinx-version 1.8.5 -internal ../kernel/futex.c' failed with return code 2
> 
> Fixes: 77e52ae35463 ("futex: Move to kernel/futex/")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Thomas Gleixner <tglx@linutronix.de>
> Cc: Ingo Molnar <mingo@redhat.com>
> Cc: Peter Zijlstra <peterz@infradead.org>
> Cc: Darren Hart <dvhart@infradead.org>
> Cc: Davidlohr Bueso <dave@stgolabs.net>
> Cc: André Almeida <andrealmeid@collabora.com>
> Cc: linux-doc@vger.kernel.org
> Cc: Jonathan Corbet <corbet@lwn.net>

Thanks for your patch. I had already sent a fix:
https://lore.kernel.org/lkml/20211012135549.14451-1-andrealmeid@collabora.com/


Peter, can you get my fix at tip/locking/core?