| From carnil@debian.org Sun Apr 23 12:27:47 2023 |
| From: Salvatore Bonaccorso <carnil@debian.org> |
| Date: Sat, 22 Apr 2023 00:17:42 +0200 |
| Subject: docs: futex: Fix kernel-doc references after code split-up preparation |
| To: stable <stable@vger.kernel.org>, Greg Kroah-Hartman <gregkh@linuxfoundation.org>, Sasha Levin <sashal@kernel.org> |
| Cc: "Peter Zijlstra" <peterz@infradead.org>, "Thomas Gleixner" <tglx@linutronix.de>, "André Almeida" <andrealmeid@collabora.com>, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, "Jonathan Corbet" <corbet@lwn.net>, "Salvatore Bonaccorso" <carnil@debian.org> |
| Message-ID: <20230421221741.1827866-1-carnil@debian.org> |
| |
| From: Salvatore Bonaccorso <carnil@debian.org> |
| |
| 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> |
| Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> |
| --- |
| Documentation/kernel-hacking/locking.rst | 2 +- |
| Documentation/translations/it_IT/kernel-hacking/locking.rst | 2 +- |
| 2 files changed, 2 insertions(+), 2 deletions(-) |
| |
| --- a/Documentation/kernel-hacking/locking.rst |
| +++ b/Documentation/kernel-hacking/locking.rst |
| @@ -1358,7 +1358,7 @@ Mutex API reference |
| Futex API reference |
| =================== |
| |
| -.. kernel-doc:: kernel/futex.c |
| +.. kernel-doc:: kernel/futex/core.c |
| :internal: |
| |
| Further reading |
| --- a/Documentation/translations/it_IT/kernel-hacking/locking.rst |
| +++ b/Documentation/translations/it_IT/kernel-hacking/locking.rst |
| @@ -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 |