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

Quentin Schulz
2025-03-31T08:52:10Z

Hi Christos,

Thanks for the patch!

On 3/28/25 9:52 PM, Christos Gavros via lists.yoctoproject.org wrote:
> This variable specifies the maximum allowed size
> of the initramfs image in bytes.
> 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>
> ---
> documentation/ref-manual/variables.rst | 7 +++++++
> 1 file changed, 7 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 62e339ed8..c9c042096 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -4474,6 +4474,13 @@ system and gives an overview of their function and contents.
> See the :term:`MACHINE` variable for additional
> information.
>
> + :term:`INITRAMFS_MAXSIZE`
> + Specifies the maximum allowed size of the initramfs image in bytes.

Is it really in bytes? The error message specifies "(K)" which I assume
means those are Kilobytes?

> + The build will fail in case the initramfs image size is bigger than
> + the value of this variable.
> + There is a week default value assignment (INITRAMFS_MAXSIZE ??= "131072" )

s/week/weak/

> + in bitbake.conf.
> +

I would suggest to reword like this:

"""
The default value is set as follows in the BitBake configuration file::

INITRAMFS_MAXSIZE ??= "131072"

"""

to follow the same convention we used for other variables' default value.

It's not entirely clear on what this limit applies when compression is
enabled, on the uncompressed content or compressed? This needs to be
made explicit.

Cheers,
Quentin