[PATCH] doc: Fix IMAGE_INITRD naming

[Jan Kiszka]

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

Fixes: c3c4e72cbfc4 ("image: introduce IMAGE_INITRD, deprecate INITRD_IMAGE")
Signed-off-by: Jan Kiszka <jan.k...@siemens.com>
---
doc/user_manual.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/user_manual.md b/doc/user_manual.md
index 4df122a8..d197ae7b 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -577,7 +577,7 @@ Every machine is described in its configuration file. The file defines the follo
- U-Boot or other boot loader.
- Machine-specific firmware.
- `KERNEL_IMAGE` - The name of kernel binary that it installed to `/boot` folder in target filesystem. This variable is used by Isar to extract the kernel binary and put it into the deploy folder. This makes sense for embedded devices, where kernel and root filesystem are written to different flash partitions. This variable is optional.
- - `INITRD_IMAGE` - The name of `initramfs` recipe to be built and used by the imager.
+ - `IMAGE_INITRD` - The name of `initramfs` recipe to be built and used by the imager.
- `MACHINE_SERIAL` - The name of serial device that will be used for console output.
- `IMAGE_FSTYPES` - The types of images to be generated for this machine.

--
2.51.0

[Zhihang Wei]

On 11/29/25 15:43, Jan Kiszka wrote:
> From: Jan Kiszka <jan.k...@siemens.com>
>
> Fixes: c3c4e72cbfc4 ("image: introduce IMAGE_INITRD, deprecate INITRD_IMAGE")
> Signed-off-by: Jan Kiszka <jan.k...@siemens.com>
> ---
> doc/user_manual.md | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/doc/user_manual.md b/doc/user_manual.md
> index 4df122a8..d197ae7b 100644
> --- a/doc/user_manual.md
> +++ b/doc/user_manual.md
> @@ -577,7 +577,7 @@ Every machine is described in its configuration file. The file defines the follo
> - U-Boot or other boot loader.
> - Machine-specific firmware.
> - `KERNEL_IMAGE` - The name of kernel binary that it installed to `/boot` folder in target filesystem. This variable is used by Isar to extract the kernel binary and put it into the deploy folder. This makes sense for embedded devices, where kernel and root filesystem are written to different flash partitions. This variable is optional.
> - - `INITRD_IMAGE` - The name of `initramfs` recipe to be built and used by the imager.

Does it make sense to still keep the `INITRD_IMAGE` variable? -
`INITRD_IMAGE` - The name of `ramdisk` binary. The meaning of this
variable is similar to `KERNEL_IMAGE`. This variable is optional.
This is the original description, so I suppose this variable is for some
built initrd binary that is ready to be used. And we can rename
`IMAGE_INITRD` as something like "INITRD_IMAGE_RECIPE"?

Zhihang

[Jan Kiszka]

It does not make sense to advertise a variable in the manual where isar
will bark at you with "INITRD_IMAGE is deprecated" during the build.

Jan

--
Siemens AG, Foundational Technologies
Linux Expert Center