[PATCH] ref-manual/variables.rst: cover FIT_LINUX_BIN variable

[PATCH] ref-manual/variables.rst: cover FIT_LINUX_BIN variable

[AdrianF]

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(+)

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

Re: [docs] [PATCH] ref-manual/variables.rst: cover FIT_LINUX_BIN variable

[Antonin Godard]

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

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH] ref-manual/variables.rst: cover FIT_LINUX_BIN variable

[Freihofer, Adrian]

[-- Attachment #1: Type: text/plain, Size: 2408 bytes --]

Hi Antonin,

Sorry for not checking the queued patches before sending my patch.

Indeed, Quentin's comment is valid. FIT_LINUX_BIN refers to a file. I am confident that my patch is correct. Therefore, you are welcome to either take my patch or simply apply that single-word correction to your own. Both options are appreciated. Thank you.

Regards,
Adrian
________________________________
From: Antonin Godard <antonin.godard@bootlin.com>
Sent: Monday, October 20, 2025 08:47
To: Freihofer, Adrian (SI B PRO TI EAC CCP) <adrian.freihofer@siemens.com>; docs@lists.yoctoproject.org <docs@lists.yoctoproject.org>
Cc: kavinaya@qti.qualcomm.com <kavinaya@qti.qualcomm.com>
Subject: Re: [docs] [PATCH] ref-manual/variables.rst: cover FIT_LINUX_BIN variable

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://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Flore.kernel.org%2Fyocto-docs%2F20251016-release-note-5-3-second-hunk-v1-14-20f21db1f93c%40bootlin.com%2F&data=05%7C02%7Cadrian.freihofer%40siemens.com%7C0ad15534d3614def82cb08de0fa4a2bf%7C38ae3bcd95794fd4addab42e1495d55a%7C1%7C0%7C638965396937776315%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=F8KN667flkk3CMCj0u%2Fv5zZOOO13E02pwB7csZ5UIEc%3D&reserved=0<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

--
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbootlin.com%2F&data=05%7C02%7Cadrian.freihofer%40siemens.com%7C0ad15534d3614def82cb08de0fa4a2bf%7C38ae3bcd95794fd4addab42e1495d55a%7C1%7C0%7C638965396937802952%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=MsnMf7OsDmqPIuh8Lc7C2zlz6gDvGyV43Yu6Xn9K7qM%3D&reserved=0<https://bootlin.com/>


[-- Attachment #2: Type: text/html, Size: 4409 bytes --]

Re: [docs] [PATCH] ref-manual/variables.rst: cover FIT_LINUX_BIN variable

[Quentin Schulz]

Hi Adrian,

On 10/19/25 6:47 PM, 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.
> 
> Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
> ---
>   documentation/ref-manual/variables.rst | 12 ++++++++++++
>   1 file changed, 12 insertions(+)
> 
> 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.

That is not true.

> +      The default value is set to "linux.bin".
> +

You have two choices. The empty string or anything not empty (including 
the default "linux.bin"). The value of the non empty string does not 
matter at all.

The wording here implies something that does not happen. It does not 
represent the name of the Linux kernel binary which gets included in the 
FIT image, it is merely sort of a boolean to decide whether to include 
linux.bin binary in the kernel FIT image.

linux.bin is generated by uboot_prep_kimage() in 
meta/classes-recipe/kernel-uboot.bbclass which is called in 
kernel_do_deploy:append() in 
meta/classes-recipe/kernel-fit-extra-artifacts.bbclass which is 
inherited whenever it is present in KERNEL_CLASSES variable. Its 
compression is stored in linux_comp file which is also read whenever 
FIT_LINUX_BIN is set. So changing FIT_LINUX_BIN logic would require a 
change for the compression field in the FIT as well.

Cheers,
Quentin