Skip to contentSkip to conversation

docs: futex: Fix kernel-doc references after code split-up preparation

PATCH In review Salvatore Bonaccorso 3 participants 5 messages Apr 21, 2023 – Apr 22, 2023

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 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/")

---
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(-)
Documentation/kernel-hacking/locking.rst +1 -1
index 6ed806e6061b..a6d89efede79 100644
@@ -1358,7 +1358,7 @@ Mutex API reference
 Futex API reference
 ===================
 
-.. kernel-doc:: kernel/futex.c
+.. kernel-doc:: kernel/futex/core.c
    :internal:
 
 Further reading
Documentation/translations/it_IT/kernel-hacking/locking.rst +1 -1
index bf1acd6204ef..192ab8e28125 100644
@@ -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
Signature · 1 line
2.40.0
reviewer
#1 lore raw

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

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

Quoted 55 lines · Salvatore Bonaccorso

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/")

---
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(-)
Documentation/kernel-hacking/locking.rst +1 -1
index 6ed806e6061b..a6d89efede79 100644
@@ -1358,7 +1358,7 @@ Mutex API reference
 Futex API reference
 ===================
 
-.. kernel-doc:: kernel/futex.c
+.. kernel-doc:: kernel/futex/core.c
    :internal:
 
 Further reading
Documentation/translations/it_IT/kernel-hacking/locking.rst +1 -1
index bf1acd6204ef..192ab8e28125 100644
@@ -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
Signature · 1 line
~Randy
#2 lore raw

Hi Randy,

Quoted 3 lines · Randy Dunlap

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:

Quoted 14 lines · Salvatore Bonaccorso
Quoted 13 lines

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

Quoted 4 lines
Quoted 4 lines

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

#3 lore raw
In reply to Salvatore Bonaccorso
Quoted 20 lines · Salvatore Bonaccorso

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/")
Quoted 8 lines

---
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>

#4 lore raw
Quoted 30 lines · Greg Kroah-Hartman
Quoted 20 lines · Salvatore Bonaccorso

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/")
Quoted 8 lines

---
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(-)
Quoted 6 lines

<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...