diff mbox series

RECIPE-API-CHANGELOG: Fix entry for IMAGE_INITRD

Message ID 17e5982b-208f-445b-80f2-2725b1dee8bc@siemens.com
State New
Headers show
Series RECIPE-API-CHANGELOG: Fix entry for IMAGE_INITRD | expand

Commit Message

Jan Kiszka Nov. 29, 2025, 3:13 p.m. UTC 
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 mbox series

Patch

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