Re: [docs] [PATCH v2 1/3] ref-manual: replace kernel-fitimage by kernel-fit-image

["Antonin Godard" <antonin.godard@bootlin.com>]

Hi Adrian,

Patch series looks good. Only one thing I noticed below, but I'll amend that
before merging your series on master-next.

Thanks!

On Mon Jun 16, 2025 at 10:36 PM CEST, Adrian Freihofer via lists.yoctoproject.org wrote:
> From: Adrian Freihofer <adrian.freihofer@siemens.com>
>
> Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
> ---
>  documentation/ref-manual/classes.rst   | 201 +++++++++++++++++--------
>  documentation/ref-manual/variables.rst |  60 ++++----
>  2 files changed, 170 insertions(+), 91 deletions(-)
>
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index 54a98bf24f3..a6e74819dd7 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -1732,77 +1732,158 @@ Its behavior is mainly controlled by the following variables:
>  -  :term:`KERNEL_DTC_FLAGS`: flags for ``dtc``, the Device Tree Compiler
>  -  :term:`KERNEL_PACKAGE_NAME`: base name of the kernel packages
>  
> -.. _ref-classes-kernel-fitimage:
> +.. _ref-classes-kernel-fit-image:
>  
> -``kernel-fitimage``
> -===================
> +``kernel-fit-image``
> +====================
>  
> -The :ref:`ref-classes-kernel-fitimage` class provides support to pack a kernel image,
> -device trees, a U-boot script, an :term:`Initramfs` bundle and a RAM disk
> -into a single FIT image. In theory, a FIT image can support any number
> -of kernels, U-boot scripts, :term:`Initramfs` bundles, RAM disks and device-trees.
> -However, :ref:`ref-classes-kernel-fitimage` currently only supports
> +The :ref:`ref-classes-kernel-fit-image` class provides support to pack a kernel image,
> +device trees, a U-boot script, and an :term:`Initramfs` into a single FIT image.
> +In theory, a FIT image can support any number of kernels, U-boot scripts,
> +:term:`Initramfs`, and device trees.
> +However, :ref:`ref-classes-kernel-fit-image` currently only supports
>  limited usecases: just one kernel image, an optional U-boot script,
> -an optional :term:`Initramfs` bundle, an optional RAM disk, and any number of
> -device trees.
> +an optional :term:`Initramfs`, and any number of device trees.
>  
> -To create a FIT image, it is required that :term:`KERNEL_CLASSES`
> -is set to include ":ref:`ref-classes-kernel-fitimage`" and one of :term:`KERNEL_IMAGETYPE`,
> -:term:`KERNEL_ALT_IMAGETYPE` or :term:`KERNEL_IMAGETYPES` to include "fitImage".
> +The FIT image is created by a recipe which inherits the
> +:ref:`ref-classes-kernel-fit-image` class.
> +One such example is the ``linux-yocto-fitimage`` recipe which creates a FIT
> +image for the Linux Yocto kernel.
> +Additionally, it is required that :term:`KERNEL_CLASSES` is set to include
> +:ref:`ref-classes-kernel-fit-extra-artifacts`.
> +The :ref:`ref-classes-kernel-fit-extra-artifacts` class exposes the required kernel
> +artifacts to the :term:`DEPLOY_DIR_IMAGE` which are used by the
> +:ref:`ref-classes-kernel-fit-image` class to create the FIT image.
>  
> -The options for the device tree compiler passed to ``mkimage -D``
> -when creating the FIT image are specified using the
> -:term:`UBOOT_MKIMAGE_DTCOPTS` variable.
> +The simplest example for building a FIT image is to add::
>  
> -Only a single kernel can be added to the FIT image created by
> -:ref:`ref-classes-kernel-fitimage` and the kernel image in FIT is mandatory. The
> -address where the kernel image is to be loaded by U-Boot is
> -specified by :term:`UBOOT_LOADADDRESS` and the entrypoint by
> -:term:`UBOOT_ENTRYPOINT`. Setting :term:`FIT_ADDRESS_CELLS` to "2"
> -is necessary if such addresses are 64 bit ones.
> +   KERNEL_CLASSES += "kernel-fit-extra-artifacts"
>  
> -Multiple device trees can be added to the FIT image created by
> -:ref:`ref-classes-kernel-fitimage` and the device tree is optional.
> -The address where the device tree is to be loaded by U-Boot is
> -specified by :term:`UBOOT_DTBO_LOADADDRESS` for device tree overlays
> -and by :term:`UBOOT_DTB_LOADADDRESS` for device tree binaries.
> +to the machine conf file and to execute::

s/conf file/:term:`configuration file`/


Antonin

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