[PATCH] RECIPE-API-CHANGELOG: Fix entry for IMAGE_INITRD

[PATCH] RECIPE-API-CHANGELOG: Fix entry for IMAGE_INITRD

['Jan Kiszka' via isar-users]

From: Jan Kiszka <jan.kiszka@siemens.com>

The provided isar-cip-core example was wrong as it neglected the special
dependencies of that build. Drop it, leaving only a note that standard
cases do not need to worry about hooking up the initramfs manually.

Furthermore fix the image file name.

Fixes: c3c4e72cbfc4 ("image: introduce IMAGE_INITRD, deprecate INITRD_IMAGE")
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
---
 RECIPE-API-CHANGELOG.md | 20 +++++---------------
 1 file changed, 5 insertions(+), 15 deletions(-)

diff --git a/RECIPE-API-CHANGELOG.md b/RECIPE-API-CHANGELOG.md
index 3556f091..a20b35f0 100644
--- a/RECIPE-API-CHANGELOG.md
+++ b/RECIPE-API-CHANGELOG.md
@@ -843,24 +843,14 @@ ROOTFS_FEATURE += "no-generate-initrd"
 
 INITRD_IMAGE could be set to the full name of an initrd image to be found in
 DEPLOY_DIR_IMAGE. Downstream layers had to assume how Isar names its image
-artifacts (presently adding a ${DISTRO}-${IMAGE}-initrd.img suffix to initrd
+artifacts (presently adding a ${DISTRO}-${IMAGE}.initrd.img suffix to initrd
 images) and insert the build of their initramfs recipe into the image build
 pipeline.
 
-IMAGE_INITRD is introduced to (1) have a constistent naming convention for
-variables consumed by the image class (IMAGE_ prefix) (2) only require
-this variable to be set when a custom initrd should be built and used by the
-imager.
-
-For instance, cip-core was doing the following:
-
-     INITRAMFS_RECIPE ?= "cip-core-initramfs"
-     INITRD_IMAGE = "${INITRAMFS_RECIPE}-${DISTRO}-${MACHINE}.initrd.img"
-     do_image_wic[depends] += "${INITRAMFS_RECIPE}:do_build"
-
-And it could now be changed to:
-
-     IMAGE_INITRD ?= "cip-core-initramfs"
+IMAGE_INITRD is introduced to have a consistent naming convention for
+variables consumed by the image class (IMAGE_ prefix). If no image type
+specific dependency exist, the automatically provided one will ensure the
+build of IMAGE_INITRD.
 
 INITRD_IMAGE is "only" deprecated; meaning that it may still be used (but
 build-time warnings will be raised). If both IMAGE_INITRD and INITRD_IMAGE
-- 
2.51.0

-- 
You received this message because you are subscribed to the Google Groups "isar-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to isar-users+unsubscribe@googlegroups.com.
To view this discussion visit https://groups.google.com/d/msgid/isar-users/17e5982b-208f-445b-80f2-2725b1dee8bc%40siemens.com.

Re: [PATCH] RECIPE-API-CHANGELOG: Fix entry for IMAGE_INITRD

[Zhihang Wei]

Applied to next, thanks.

Zhihang

On 11/29/25 16:13, Jan Kiszka wrote:
> From: Jan Kiszka <jan.kiszka@siemens.com>
>
> The provided isar-cip-core example was wrong as it neglected the special
> dependencies of that build. Drop it, leaving only a note that standard
> cases do not need to worry about hooking up the initramfs manually.
>
> Furthermore fix the image file name.
>
> Fixes: c3c4e72cbfc4 ("image: introduce IMAGE_INITRD, deprecate INITRD_IMAGE")
> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
> ---
>   RECIPE-API-CHANGELOG.md | 20 +++++---------------
>   1 file changed, 5 insertions(+), 15 deletions(-)
>
> diff --git a/RECIPE-API-CHANGELOG.md b/RECIPE-API-CHANGELOG.md
> index 3556f091..a20b35f0 100644
> --- a/RECIPE-API-CHANGELOG.md
> +++ b/RECIPE-API-CHANGELOG.md
> @@ -843,24 +843,14 @@ ROOTFS_FEATURE += "no-generate-initrd"
>   
>   INITRD_IMAGE could be set to the full name of an initrd image to be found in
>   DEPLOY_DIR_IMAGE. Downstream layers had to assume how Isar names its image
> -artifacts (presently adding a ${DISTRO}-${IMAGE}-initrd.img suffix to initrd
> +artifacts (presently adding a ${DISTRO}-${IMAGE}.initrd.img suffix to initrd
>   images) and insert the build of their initramfs recipe into the image build
>   pipeline.
>   
> -IMAGE_INITRD is introduced to (1) have a constistent naming convention for
> -variables consumed by the image class (IMAGE_ prefix) (2) only require
> -this variable to be set when a custom initrd should be built and used by the
> -imager.
> -
> -For instance, cip-core was doing the following:
> -
> -     INITRAMFS_RECIPE ?= "cip-core-initramfs"
> -     INITRD_IMAGE = "${INITRAMFS_RECIPE}-${DISTRO}-${MACHINE}.initrd.img"
> -     do_image_wic[depends] += "${INITRAMFS_RECIPE}:do_build"
> -
> -And it could now be changed to:
> -
> -     IMAGE_INITRD ?= "cip-core-initramfs"
> +IMAGE_INITRD is introduced to have a consistent naming convention for
> +variables consumed by the image class (IMAGE_ prefix). If no image type
> +specific dependency exist, the automatically provided one will ensure the
> +build of IMAGE_INITRD.
>   
>   INITRD_IMAGE is "only" deprecated; meaning that it may still be used (but
>   build-time warnings will be raised). If both IMAGE_INITRD and INITRD_IMAGE

-- 
You received this message because you are subscribed to the Google Groups "isar-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to isar-users+unsubscribe@googlegroups.com.
To view this discussion visit https://groups.google.com/d/msgid/isar-users/85254d17-e37d-4dba-b426-895510c268a5%40ilbers.de.