Skip to contentSkip to conversation

kbuild: lto: documentation fixes

PATCH In review Bagas Sanjaya 3 participants 8 messages Jul 16, 2022 – Jul 19, 2022

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

cover kbuild: lto: documentation fixes

Here is documentation fixes for kbuild LTO feature tree [1]. Two patches fixes warnings reported by kernel test robot, the others are formatting improvements.

[1]: https://git.kernel.org/pub/scm/linux/kernel/git/jirislaby/linux.git

Bagas Sanjaya (4):
Documentation: lto: add blank line padding before single requirement
list
Documentation: lto: use bullet list for FAQ
Documentation: lto: use bullet lists for external link references list
Documentation: lto: add LTO documentation to toc index

 Documentation/kbuild/index.rst     |  2 ++
 Documentation/kbuild/lto-build.rst | 36 +++++++++++++++++-------------
 2 files changed, 23 insertions(+), 15 deletions(-)

base-commit: 79a278f10955da2801240f52efb828d158b2b36c

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw

PATCH 1/4 Documentation: lto: add blank line padding before single requirement list

kernel test robot reported a warning on LTO requirements list:

Documentation/kbuild/lto-build.rst:40: WARNING: Bullet list ends without a blank line; unexpected unindent.

The warning is caused by missing padding between the subheading and the list.

Add blank line padding to fix the warning.

Fixes 0350b4dd55922f ("Kbuild, lto: Add Link Time Optimization support")
---
 Documentation/kbuild/lto-build.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/kbuild/lto-build.rst +3 -2
index e8a0f149e8ceaf..39cbdb12295051 100644
@@ -36,9 +36,10 @@ the compiler version.
 
 Requirements:
 -------------
+
 - Enough memory: 4GB for a standard build, more for allyesconfig
-The peak memory usage happens single threaded (when lto-wpa merges types),
-so dialing back -j options will not help much.
+  The peak memory usage happens single threaded (when lto-wpa merges types),
+  so dialing back -j options will not help much.
 
 A 32bit hosted compiler is unlikely to work due to the memory requirements.
 You can however build a kernel targeted at 32bit on a 64bit host.
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#2 lore raw

PATCH 2/4 Documentation: lto: use bullet list for FAQ

In reply to Bagas Sanjaya

The only FAQ item is rendered as a continuous paragraph, although it is formatted as Q&A field pair. Use bullet list instead, as in other FAQs in kernel documentation.

---
 Documentation/kbuild/lto-build.rst | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)
Documentation/kbuild/lto-build.rst +6 -4
index 39cbdb12295051..9e3e14042dda4c 100644
@@ -46,10 +46,12 @@ You can however build a kernel targeted at 32bit on a 64bit host.
 
 FAQs:
 -----
-Q: I get a section type attribute conflict
-A: Usually because of someone doing
-const __initdata (should be const __initconst) or const __read_mostly
-(should be just const). Check both symbols reported by gcc.
+
+* I get a section type attribute conflict
+
+  Usually because of someone doing const __initdata (should be
+  const __initconst) or const __read_mostly (should be just const). Check
+  both symbols reported by gcc.
 
 References:
 -----------
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#3 lore raw

PATCH 3/4 Documentation: lto: use bullet lists for external link references list

In reply to Bagas Sanjaya

Similar to the FAQ, use bullet lists in References section since it contains list of external reference links.

---
 Documentation/kbuild/lto-build.rst | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)
Documentation/kbuild/lto-build.rst +12 -9
index 9e3e14042dda4c..3fb17342e72fd6 100644
@@ -56,17 +56,20 @@ FAQs:
 References:
 -----------
 
-Presentation on Kernel LTO
-(note, performance numbers/details totally outdated.)
-http://halobates.de/kernel-lto.pdf
+* Presentation on Kernel LTO
+  (note, performance numbers/details totally outdated.)
 
-Generic gcc LTO:
-http://www.ucw.cz/~hubicka/slides/labs2013.pdf
-http://www.hipeac.net/system/files/barcelona.pdf
+  http://halobates.de/kernel-lto.pdf
 
-Somewhat outdated too:
-http://gcc.gnu.org/projects/lto/lto.pdf
-http://gcc.gnu.org/projects/lto/whopr.pdf
+* Generic gcc LTO:
+
+  * http://www.ucw.cz/~hubicka/slides/labs2013.pdf
+  * http://www.hipeac.net/system/files/barcelona.pdf
+
+* Somewhat outdated too (from GCC site):
+
+  * http://gcc.gnu.org/projects/lto/lto.pdf
+  * http://gcc.gnu.org/projects/lto/whopr.pdf
 
 Happy Link-Time-Optimizing!
 
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#4 lore raw

PATCH 4/4 Documentation: lto: add LTO documentation to toc index

In reply to Bagas Sanjaya

kernel test robot reported toctree warning:

Documentation/kbuild/lto-build.rst: WARNING: document isn't included in any toctree

Add LTO documentation (lto-build.rst) to kbuild table of contents.

Fixes 0350b4dd55922f ("Kbuild, lto: Add Link Time Optimization support")
---
 Documentation/kbuild/index.rst | 2 ++
 1 file changed, 2 insertions(+)
Documentation/kbuild/index.rst +2 -0
index cee2f99f734b5a..1937eee7c43705 100644
@@ -22,6 +22,8 @@ Kernel Build System
     gcc-plugins
     llvm
 
+    lto-build
+
 .. only::  subproject and html
 
    Indices
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#5 lore raw
In reply to Bagas Sanjaya
Quoted 4 lines · Bagas Sanjaya

Here is documentation fixes for kbuild LTO feature tree [1]. Two patches fixes warnings reported by kernel test robot, the others are formatting improvements.

Please do not submit patches unrelated to the mainline.

This series applies to the individual repository of Jiri Slaby.

Quoted 19 lines

[1]: https://git.kernel.org/pub/scm/linux/kernel/git/jirislaby/linux.git

Bagas Sanjaya (4):
Documentation: lto: add blank line padding before single requirement
list
Documentation: lto: use bullet list for FAQ
Documentation: lto: use bullet lists for external link references list
Documentation: lto: add LTO documentation to toc index

 Documentation/kbuild/index.rst     |  2 ++
 Documentation/kbuild/lto-build.rst | 36 +++++++++++++++++-------------
 2 files changed, 23 insertions(+), 15 deletions(-)

base-commit: 79a278f10955da2801240f52efb828d158b2b36c --
An old man doll... just what I always wanted! - Clara

Signature · 2 lines
Best Regards
Masahiro Yamada
#6 lore raw
Quoted 11 lines · Masahiro Yamada
Quoted 4 lines · Bagas Sanjaya

Here is documentation fixes for kbuild LTO feature tree [1]. Two patches fixes warnings reported by kernel test robot, the others are formatting improvements.

Please do not submit patches unrelated to the mainline.

This series applies to the individual repository of Jiri Slaby.

Quoted 1 line · which

Here is documentation fixes for kbuild LTO feature tree [1]

with link to the target tree, which is another way to say "The series is applied on top of this tree, not the mainline".

Thanks.

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#7 lore raw
Quoted 13 lines · Bagas Sanjaya
Quoted 11 lines · Masahiro Yamada
Quoted 4 lines · Bagas Sanjaya

Here is documentation fixes for kbuild LTO feature tree [1]. Two patches fixes warnings reported by kernel test robot, the others are formatting improvements.

Please do not submit patches unrelated to the mainline.

This series applies to the individual repository of Jiri Slaby.

Quoted 6 lines
Quoted 1 line · which

Here is documentation fixes for kbuild LTO feature tree [1]

with link to the target tree, which is another way to say "The series is applied on top of this tree, not the mainline".

Yeah, but why to send the patches to all those people provided they have no idea such a tree and changes exist at all?

Anyway, applied to my tree.

thanks,

Signature · 1 line
js