[PATCH v2 1/3] ref-manual: classes: kernel-fitimage: fix source of imagetype

[PATCH v2 1/3] ref-manual: classes: kernel-fitimage: fix source of imagetype

[Ulrich Ölmann]

The actual code in kernel-fitimage.bbclass checks if "fitImage" is listed in
KERNEL_IMAGETYPES (see e.g. [1]) which is a merge of KERNEL_IMAGETYPE,
KERNEL_ALT_IMAGETYPE and KERNEL_IMAGETYPES (see [2]).

[1] https://git.yoctoproject.org/poky/tree/meta/classes-recipe/kernel-fitimage.bbclass?h=4.3_M1&id=cc97d775cb402df0d4122bf54eab1a5198c98471#n9
[2] https://git.yoctoproject.org/poky/tree/meta/classes-recipe/kernel.bbclass?h=4.3_M1&id=cc97d775cb402df0d4122bf54eab1a5198c98471#n74

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 documentation/ref-manual/classes.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index e555a80b5af9..6ab80b10b747 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1599,8 +1599,8 @@ an optional :term:`Initramfs` bundle, an optional RAM disk, 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 :term:`KERNEL_IMAGETYPE`
-is set to "fitImage".
+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 options for the device tree compiler passed to ``mkimage -D``
 when creating the FIT image are specified using the
-- 
2.39.2

[PATCH v2 2/3] ref-manual: classes: kernel-fitimage: fix typos

[Ulrich Ölmann]

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 documentation/ref-manual/classes.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 6ab80b10b747..dc30419a1e7f 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1623,8 +1623,8 @@ Only a single RAM disk can be added to the FIT image created by
 :ref:`ref-classes-kernel-fitimage` and the RAM disk in FIT is optional.
 The address where the RAM disk image is to be loaded by U-Boot
 is specified by :term:`UBOOT_RD_LOADADDRESS` and the entrypoint by
-:term:`UBOOT_RD_ENTRYPOINT`. The ramdisk is added to FIT image when
-:term:`INITRAMFS_IMAGE` is specified and that :term:`INITRAMFS_IMAGE_BUNDLE`
+:term:`UBOOT_RD_ENTRYPOINT`. The ramdisk is added to the FIT image when
+:term:`INITRAMFS_IMAGE` is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE`
 is set to 0.
 
 Only a single :term:`Initramfs` bundle can be added to the FIT image created by
@@ -1633,7 +1633,7 @@ In case of :term:`Initramfs`, the kernel is configured to be bundled with the ro
 in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin).
 When the kernel is copied to RAM and executed, it unpacks the :term:`Initramfs` root filesystem.
 The :term:`Initramfs` bundle can be enabled when :term:`INITRAMFS_IMAGE`
-is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1.
+is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1.
 The address where the :term:`Initramfs` bundle is to be loaded by U-boot is specified
 by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`.
 
@@ -1644,14 +1644,14 @@ U-boot commands. When using a boot script the user should configure the
 U-boot :ref:`ref-tasks-install` task to copy the script to sysroot.
 So the script can be included in the FIT image by the :ref:`ref-classes-kernel-fitimage`
 class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to
-load the boot script from the FIT image and executes it.
+load the boot script from the FIT image and execute it.
 
-The FIT image generated by :ref:`ref-classes-kernel-fitimage` class is signed when the
+The FIT image generated by the :ref:`ref-classes-kernel-fitimage` class is signed when the
 variables :term:`UBOOT_SIGN_ENABLE`, :term:`UBOOT_MKIMAGE_DTCOPTS`,
 :term:`UBOOT_SIGN_KEYDIR` and :term:`UBOOT_SIGN_KEYNAME` are set
 appropriately. The default values used for :term:`FIT_HASH_ALG` and
 :term:`FIT_SIGN_ALG` in :ref:`ref-classes-kernel-fitimage` are "sha256" and
-"rsa2048" respectively. The keys for signing fitImage can be generated using
+"rsa2048" respectively. The keys for signing the FIT image can be generated using
 the :ref:`ref-classes-kernel-fitimage` class when both :term:`FIT_GENERATE_KEYS` and
 :term:`UBOOT_SIGN_ENABLE` are set to "1".
 
-- 
2.39.2

[PATCH v2 3/3] ref-manual: classes: kernel-fitimage: refine role of INITRAMFS_IMAGE_BUNDLE

[Ulrich Ölmann]

Although it might seem a little bit pedantic this patch describes what the class
actually checks (see e.g. [1]) and kernel.bbclass per default sets the parameter
INITRAMFS_IMAGE_BUNDLE to the empty string (see [2]) which already satisfies
that check without the need of additionally explicitly setting it to '0'.

[1] https://git.yoctoproject.org/poky/tree/meta/classes-recipe/kernel-fitimage.bbclass?h=4.3_M1&id=cc97d775cb402df0d4122bf54eab1a5198c98471#n667
[2] https://git.yoctoproject.org/poky/tree/meta/classes-recipe/kernel.bbclass?h=4.3_M1&id=cc97d775cb402df0d4122bf54eab1a5198c98471#n37

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 documentation/ref-manual/classes.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index dc30419a1e7f..4577baba3e66 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1625,7 +1625,7 @@ The address where the RAM disk image is to be loaded by U-Boot
 is specified by :term:`UBOOT_RD_LOADADDRESS` and the entrypoint by
 :term:`UBOOT_RD_ENTRYPOINT`. The ramdisk is added to the FIT image when
 :term:`INITRAMFS_IMAGE` is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE`
-is set to 0.
+is not set to 1.
 
 Only a single :term:`Initramfs` bundle can be added to the FIT image created by
 :ref:`ref-classes-kernel-fitimage` and the :term:`Initramfs` bundle in FIT is optional.
-- 
2.39.2

Re: [docs] [PATCH v2 3/3] ref-manual: classes: kernel-fitimage: refine role of INITRAMFS_IMAGE_BUNDLE

[Michael Opdenacker]

Hi Ulrich,

On 14.07.23 at 11:35, Ulrich Ölmann wrote:
> Although it might seem a little bit pedantic this patch describes what the class
> actually checks (see e.g. [1]) and kernel.bbclass per default sets the parameter
> INITRAMFS_IMAGE_BUNDLE to the empty string (see [2]) which already satisfies
> that check without the need of additionally explicitly setting it to '0'.
>
> [1] https://git.yoctoproject.org/poky/tree/meta/classes-recipe/kernel-fitimage.bbclass?h=4.3_M1&id=cc97d775cb402df0d4122bf54eab1a5198c98471#n667
> [2] https://git.yoctoproject.org/poky/tree/meta/classes-recipe/kernel.bbclass?h=4.3_M1&id=cc97d775cb402df0d4122bf54eab1a5198c98471#n37
>
> Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
> ---
>   documentation/ref-manual/classes.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index dc30419a1e7f..4577baba3e66 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -1625,7 +1625,7 @@ The address where the RAM disk image is to be loaded by U-Boot
>   is specified by :term:`UBOOT_RD_LOADADDRESS` and the entrypoint by
>   :term:`UBOOT_RD_ENTRYPOINT`. The ramdisk is added to the FIT image when
>   :term:`INITRAMFS_IMAGE` is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE`
> -is set to 0.
> +is not set to 1.
>   
>   Only a single :term:`Initramfs` bundle can be added to the FIT image created by
>   :ref:`ref-classes-kernel-fitimage` and the :term:`Initramfs` bundle in FIT is optional.


Many thanks for the 3 patches, much appreciated as always.
For the 3 patches: Reviewed-by: Michael Opdenacker 
<michael.opdenacker@bootlin.com>
Merged into master-next.

Thanks again
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com