diff mbox series

ref-manual/variables.rst: cover FIT_LINUX_BIN variable

Message ID 20251019164740.3795019-1-adrian.freihofer@siemens.com
State New
Headers show
Series ref-manual/variables.rst: cover FIT_LINUX_BIN variable | expand

Commit Message

AdrianF Oct. 19, 2025, 4:47 p.m. UTC 
From: Adrian Freihofer <adrian.freihofer@siemens.com>

Document the FIT_LINUX_BIN variable used in the fit-image class to specify
the kernel binary name included in the FIT image.

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
---
 documentation/ref-manual/variables.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Comments

Antonin Godard Oct. 20, 2025, 6:47 a.m. UTC | #1 
Hi,

On Sun Oct 19, 2025 at 6:47 PM CEST, Adrian Freihofer via lists.yoctoproject.org wrote:
> From: Adrian Freihofer <adrian.freihofer@siemens.com>
>
> Document the FIT_LINUX_BIN variable used in the fit-image class to specify
> the kernel binary name included in the FIT image.

Thanks for the patch. I also sent a patch for this last week:
https://lore.kernel.org/yocto-docs/20251016-release-note-5-3-second-hunk-v1-14-20f21db1f93c@bootlin.com/

Quentin had interesting comments on it, and I think your patch more or less
matches mine, so the comments still apply. Can you have a look?

Antonin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 591c03028ce..8a10dfc54e6 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3430,6 +3430,18 @@  system and gives an overview of their function and contents.
       The default value is set to "x509" by the
       :ref:`ref-classes-kernel-fit-image` class.
 
+   :term:`FIT_LINUX_BIN`
+      This variable is used in the :ref:`ref-classes-kernel-fit-image` class to
+      specify the name of the Linux kernel binary which gets included in the
+      FIT image.
+      The default value is set to "linux.bin".
+
+      If :term:`FIT_LINUX_BIN` is set to an empty string, no kernel binary
+      is included in the FIT image.
+      This might be useful when the FIT image only provides specific components
+      like device trees, while the kernel is delivered as a UKI artifact
+      (see :ref:`ref-classes-uki`).
+
    :term:`FIT_PAD_ALG`
       Specifies the padding algorithm used in creating the FIT Image.
       The default value is set to "pkcs-1.5" by the