public inbox for isar-users@googlegroups.com
 help / color / mirror / Atom feed
From: "'Jan Kiszka' via isar-users" <isar-users@googlegroups.com>
To: Zhihang Wei <wzh@ilbers.de>, isar-users <isar-users@googlegroups.com>
Cc: Cedric Hombourger <cedric.hombourger@siemens.com>
Subject: Re: [PATCH] doc: Fix IMAGE_INITRD naming
Date: Mon, 1 Dec 2025 20:55:11 +0100	[thread overview]
Message-ID: <5e513e5d-0428-4c63-aacb-125531927ff8@siemens.com> (raw)
In-Reply-To: <94380de5-7ab5-4395-a594-5a95e680f767@ilbers.de>

On 01.12.25 14:25, Zhihang Wei wrote:
> 
> 
> On 11/29/25 15:43, Jan Kiszka wrote:
>> From: Jan Kiszka <jan.kiszka@siemens.com>
>>
>> Fixes: c3c4e72cbfc4 ("image: introduce IMAGE_INITRD, deprecate
>> INITRD_IMAGE")
>> Signed-off-by: Jan Kiszka <jan.kiszka@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"?
> 

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

-- 
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/5e513e5d-0428-4c63-aacb-125531927ff8%40siemens.com.

  reply	other threads:[~2025-12-01 19:55 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-29 14:43 'Jan Kiszka' via isar-users
2025-12-01 13:25 ` Zhihang Wei
2025-12-01 19:55   ` 'Jan Kiszka' via isar-users [this message]
2025-12-11  9:05 ` Zhihang Wei

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=5e513e5d-0428-4c63-aacb-125531927ff8@siemens.com \
    --to=isar-users@googlegroups.com \
    --cc=cedric.hombourger@siemens.com \
    --cc=jan.kiszka@siemens.com \
    --cc=wzh@ilbers.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox