Skip to contentSkip to conversation

ref-manual: add "KERNEL_IMAGE_STRIP_EXTRA_SECTIONS" to variables

PATCH Superseded Robert P. J. Day 2 participants 2 messages Jul 9 – Jul 10

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ref-manual: add "KERNEL_IMAGE_STRIP_EXTRA_SECTIONS" to variables

Add this variable to the variables glossary, and add links to it and back to the do_strip() task for completeness.

---

documentation/ref-manual/tasks.rst +1 -1
index e1db2d5ed..ea0899f53 100644
@@ -848,7 +848,7 @@ the kernel build produces a warning to that effect.
 ``do_strip``
 ------------
 
-If ``KERNEL_IMAGE_STRIP_EXTRA_SECTIONS`` is defined, this task strips
+If :term:`KERNEL_IMAGE_STRIP_EXTRA_SECTIONS` is defined, this task strips
 the sections named in that variable from ``vmlinux``. This stripping is
 typically used to remove nonessential sections such as ``.comment``
 sections from a size-sensitive configuration.
documentation/ref-manual/variables.rst +5 -0
index c92b195ff..1629df99f 100644
@@ -5623,6 +5623,11 @@ system and gives an overview of their function and contents.
 
       See :term:`KERNEL_ARTIFACT_NAME` for additional information.
 
+   :term:`KERNEL_IMAGE_STRIP_EXTRA_SECTIONS`
+      If this variable is set, it should contain the sections to be
+      stripped from the ``vmlinux`` image by the kernel-related
+      :ref:`ref-tasks-strip` task.
+
    :term:`KERNEL_IMAGETYPE`
       The type of kernel to build for a device, usually set by the machine
       configuration files and defaults to "zImage". This variable is used
#1 lore raw

Hi,

Quoted 26 lines · Robert P. J. Day

Add this variable to the variables glossary, and add links to it and back to the do_strip() task for completeness.

---

documentation/ref-manual/tasks.rst +1 -1
index e1db2d5ed..ea0899f53 100644
@@ -848,7 +848,7 @@ the kernel build produces a warning to that effect.
 ``do_strip``
 ------------
 
-If ``KERNEL_IMAGE_STRIP_EXTRA_SECTIONS`` is defined, this task strips
+If :term:`KERNEL_IMAGE_STRIP_EXTRA_SECTIONS` is defined, this task strips
 the sections named in that variable from ``vmlinux``. This stripping is
 typically used to remove nonessential sections such as ``.comment``
 sections from a size-sensitive configuration.
documentation/ref-manual/variables.rst +0 -0
index c92b195ff..1629df99f 100644

documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 5629

Quoted 7 lines
documentation/ref-manual/variables.rst +4 -0
@@ -5623,6 +5623,11 @@ system and gives an overview of their function and contents.
 
       See :term:`KERNEL_ARTIFACT_NAME` for additional information.
 
+   :term:`KERNEL_IMAGE_STRIP_EXTRA_SECTIONS`
+      If this variable is set, it should contain the sections to be
+      stripped from the ``vmlinux`` image by the kernel-related
+      :ref:`ref-tasks-strip` task.

An example would be nice:

"""
For example::

KERNEL_IMAGE_STRIP_EXTRA_SECTIONS = ".comment"
"""

Thanks,
Antonin