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

Christos Gavros
2025-03-28T20:53:24Z

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.
+ 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" )
+ in 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