[PATCH v5] ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variable

[PATCH v5] ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variable

[Christos Gavros]

This variable specifies the maximum allowed size
of the initramfs image in Kbytes.
Fixes [YOCTO #15797]

CC: Yoann Congal <yoann.congal@smile.fr>
CC: Randy MacLeod <randy.macleod@windriver.com>
CC: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Christos Gavros <gavrosc@yahoo.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
---
v4->v5
* add Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
---
 documentation/ref-manual/variables.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 643a3e7ae..3962be578 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4708,6 +4708,20 @@ system and gives an overview of their function and contents.
       See the :term:`MACHINE` variable for additional
       information.
 
+   :term:`INITRAMFS_MAXSIZE`
+      Defines the maximum allowed size of the :term:`Initramfs` image in Kbytes.
+      The build will fail if the :term:`Initramfs` image size exceeds this value.
+
+      The :term:`Initramfs` image size undergoes several calculation steps before
+      being compared to :term:`INITRAMFS_MAXSIZE`.
+      These steps are the same as those used for :term:`IMAGE_ROOTFS_MAXSIZE`
+      and are described in detail in that entry.
+
+      Thus, :term:`INITRAMFS_MAXSIZE` is compared with the result of the calculations
+      and is independent of the final image type (e.g. compressed) .
+      A default value for :term:`INITRAMFS_MAXSIZE` is set in
+      :oe_git:`meta/conf/bitbake.conf </openembedded-core/tree/meta/conf/bitbake.conf>`.
+
    :term:`INITRAMFS_MULTICONFIG`
       Defines the multiconfig to create a multiconfig dependency to be used by
       the :ref:`ref-classes-kernel` class.
-- 
2.34.1

Re: [PATCH v5] ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variable

[Quentin Schulz]

Hi Christos,

On 5/20/25 12:19 PM, Christos Gavros wrote:
> This variable specifies the maximum allowed size
> of the initramfs image in Kbytes.
> Fixes [YOCTO #15797]
> 
> CC: Yoann Congal <yoann.congal@smile.fr>
> CC: Randy MacLeod <randy.macleod@windriver.com>
> CC: Antonin Godard <antonin.godard@bootlin.com>
> Signed-off-by: Christos Gavros <gavrosc@yahoo.com>
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
> ---
> v4->v5
> * add Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

No need to send a new version just for that, the maintainer will (may) 
add it when applying the patch.

If a new version is necessary because of feedback, then please add the 
Reviewed-by and other tags when sending the new version.

Thanks!
Quentin

Re: [PATCH v5] ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variable

[Antonin Godard]

Hi,

On Tue May 20, 2025 at 12:58 PM CEST, Quentin Schulz wrote:
> Hi Christos,
>
> On 5/20/25 12:19 PM, Christos Gavros wrote:
>> This variable specifies the maximum allowed size
>> of the initramfs image in Kbytes.
>> Fixes [YOCTO #15797]
>> 
>> CC: Yoann Congal <yoann.congal@smile.fr>
>> CC: Randy MacLeod <randy.macleod@windriver.com>
>> CC: Antonin Godard <antonin.godard@bootlin.com>
>> Signed-off-by: Christos Gavros <gavrosc@yahoo.com>
>> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
>> ---
>> v4->v5
>> * add Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
>
> No need to send a new version just for that, the maintainer will (may) 
> add it when applying the patch.
>
> If a new version is necessary because of feedback, then please add the 
> Reviewed-by and other tags when sending the new version.

Indeed, thanks Quentin. :)

Christos, do you plan on working on updating the documentation for
IMAGE_ROOTFS_MAXSIZE like we discussed, or are you out of time? Completely fine
if you're out of time, I'll handle it later and merge your patch as-is, just let
me know.

As a reminder, the idea was to propagate the documentation you wrote for
INITRAMFS_MAXSIZE to IMAGE_ROOTFS_MAXSIZE.

Thanks,
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [PATCH v5] ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variable

[Christos Gavros]

[-- Attachment #1: Type: text/plain, Size: 148 bytes --]

hi

thank you Quentin for clarifying!

Antonin , i have already sent a patch for this!
I sent 2 patches together on Saturday.

Br
Christos

[-- Attachment #2: Type: text/html, Size: 265 bytes --]

Re: [PATCH v5] ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variable

[Christos Gavros]

[-- Attachment #1: Type: text/plain, Size: 77 bytes --]

here it is: https://lists.yoctoproject.org/g/docs/topic/patch/113161969
:)

[-- Attachment #2: Type: text/html, Size: 216 bytes --]

Re: [docs] [PATCH v5] ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variable

[Antonin Godard]

On Tue May 20, 2025 at 1:25 PM CEST, Christos Gavros via lists.yoctoproject.org wrote:
> here it is: https://lists.yoctoproject.org/g/docs/topic/patch/113161969
> :)

Indeed, sorry! I did not understand it was this one, I was expecting a
series of patches.

I'll have a look, thanks!

Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [PATCH v5] ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variable

[Christos Gavros]

[-- Attachment #1: Type: text/plain, Size: 120 bytes --]

ooo i see!

I was not aware that i should do it this way!

I should have a look on how to do that.

Br
Christos

[-- Attachment #2: Type: text/html, Size: 226 bytes --]

Re: [PATCH v5] ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variable

[Antonin Godard]

On Tue, 20 May 2025 12:19:52 +0200, Christos Gavros wrote:
> This variable specifies the maximum allowed size
> of the initramfs image in Kbytes.
> Fixes [YOCTO #15797]
> 
> 

Applied, thanks!

[1/1] ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variable
      commit: 07bcdddaf71c76cdec186cf0ddd97a47eec54972

Best regards,
-- 
Antonin Godard <antonin.godard@bootlin.com>