2023-04-21 22:23:49

by Salvatore Bonaccorso

[permalink] [raw]
Subject: [PATCH v2 stable-5.10.y stable-5.15.y] docs: futex: Fix kernel-doc references after code split-up preparation

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 <[email protected]>
---
v1->v2:
- Fix typo in description about new target file for futex.c code
- Indent block with build log output

Documentation/kernel-hacking/locking.rst | 2 +-
Documentation/translations/it_IT/kernel-hacking/locking.rst | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/kernel-hacking/locking.rst b/Documentation/kernel-hacking/locking.rst
index 6ed806e6061b..a6d89efede79 100644
--- 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
diff --git a/Documentation/translations/it_IT/kernel-hacking/locking.rst b/Documentation/translations/it_IT/kernel-hacking/locking.rst
index bf1acd6204ef..192ab8e28125 100644
--- 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
--
2.40.0


2023-04-22 00:04:46

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH v2 stable-5.10.y stable-5.15.y] docs: futex: Fix kernel-doc references after code split-up preparation

Please see https://lore.kernel.org/all/[email protected]/

Don't know what has happened to it though. :(


On 4/21/23 15:17, Salvatore Bonaccorso wrote:
> 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 <[email protected]>
> ---
> v1->v2:
> - Fix typo in description about new target file for futex.c code
> - Indent block with build log output
>
> Documentation/kernel-hacking/locking.rst | 2 +-
> Documentation/translations/it_IT/kernel-hacking/locking.rst | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/kernel-hacking/locking.rst b/Documentation/kernel-hacking/locking.rst
> index 6ed806e6061b..a6d89efede79 100644
> --- 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
> diff --git a/Documentation/translations/it_IT/kernel-hacking/locking.rst b/Documentation/translations/it_IT/kernel-hacking/locking.rst
> index bf1acd6204ef..192ab8e28125 100644
> --- 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

--
~Randy

2023-04-22 06:20:39

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH v2 stable-5.10.y stable-5.15.y] docs: futex: Fix kernel-doc references after code split-up preparation

On Sat, Apr 22, 2023 at 12:17:42AM +0200, Salvatore Bonaccorso wrote:
> 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 <[email protected]>
> ---
> v1->v2:
> - Fix typo in description about new target file for futex.c code
> - Indent block with build log output
>
> Documentation/kernel-hacking/locking.rst | 2 +-
> Documentation/translations/it_IT/kernel-hacking/locking.rst | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)

<formletter>

This is not the correct way to submit patches for inclusion in the
stable kernel tree. Please read:
https://www.kernel.org/doc/html/latest/process/stable-kernel-rules.html
for how to do this properly.

</formletter>

2023-04-22 06:21:28

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH v2 stable-5.10.y stable-5.15.y] docs: futex: Fix kernel-doc references after code split-up preparation

On Sat, Apr 22, 2023 at 07:44:18AM +0200, Greg Kroah-Hartman wrote:
> On Sat, Apr 22, 2023 at 12:17:42AM +0200, Salvatore Bonaccorso wrote:
> > 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 <[email protected]>
> > ---
> > v1->v2:
> > - Fix typo in description about new target file for futex.c code
> > - Indent block with build log output
> >
> > Documentation/kernel-hacking/locking.rst | 2 +-
> > Documentation/translations/it_IT/kernel-hacking/locking.rst | 2 +-
> > 2 files changed, 2 insertions(+), 2 deletions(-)
>
> <formletter>
>
> This is not the correct way to submit patches for inclusion in the
> stable kernel tree. Please read:
> https://www.kernel.org/doc/html/latest/process/stable-kernel-rules.html
> for how to do this properly.

Oops, nope, this was sent just fine, my bot got it wrong, sorry for the
noise...

2023-04-22 07:03:21

by Salvatore Bonaccorso

[permalink] [raw]
Subject: Re: [PATCH v2 stable-5.10.y stable-5.15.y] docs: futex: Fix kernel-doc references after code split-up preparation

Hi Randy,

On Fri, Apr 21, 2023 at 05:03:15PM -0700, Randy Dunlap wrote:
> Please see https://lore.kernel.org/all/[email protected]/
>
> Don't know what has happened to it though. :(

It was applied, as bc67f1c454fb ("docs: futex: Fix kernel-doc
references") in 5.16-rc1. But 5.10.y and 5.15.y picked up from the
refactoring only 77e52ae35463 ("futex: Move to kernel/futex/").

So this change is a specific backport of subset of it, to 5.10.y and
5.15.y thus the commit message:

> On 4/21/23 15:17, Salvatore Bonaccorso wrote:
> > 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.

Here pointing out explicitly that there is no (direct) upstream commit
for it.

Hope this helps,

Regards,
Salvatore