| Message ID | 20250517144959.5403-1-gavrosc@yahoo.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v3] ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variable | expand |
Hi Christos, On 5/17/25 4:49 PM, Christos Gavros via lists.yoctoproject.org wrote: > This variable specifies the maximum allowed size > of the initramfs image in kilobytes. > Fixes [YOCTO #15797] > > CC: Yoann Congal <yoann.congal@smile.fr> > CC: Randy MacLeod <randy.macleod@windriver.com> > CC: Antonin Godard <antonin.godard@bootlin.com> > CC: Quentin Schulz <quentin.schulz@cherry.de> > Signed-off-by: Christos Gavros <gavrosc@yahoo.com> > --- > v2->v3 > * the text is wrapped in less than 80 characters > * the syntax for hyperinks is used for variables > * the syntax for path of bitbake.conf is changed > * the calculation steps are moved in IMAGE_ROOTFS_MAXSIZE variable > --- > 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 d17f81036..33934c8ff 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 initramfs image in kilobytes. s/kilobytes/Kbytes/ to match IMAGE_ROOTFS_MAXSIZE (though I'm wondering if we shouldn't rather say KiB to highlight those are 1024B and not 1000B). Replace all initramfs with :term:`Initramfs` > + The build will fail if the initramfs image size exceeds this value. > + > + The 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. Maybe add "(e.g. compressed)" at the end of the sentence to highlight the typical confusion that will happen? Looks good to me otherwise! Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Thanks! Quentin
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index d17f81036..33934c8ff 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 initramfs image in kilobytes. + The build will fail if the initramfs image size exceeds this value. + + The 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. + 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.
This variable specifies the maximum allowed size of the initramfs image in kilobytes. Fixes [YOCTO #15797] CC: Yoann Congal <yoann.congal@smile.fr> CC: Randy MacLeod <randy.macleod@windriver.com> CC: Antonin Godard <antonin.godard@bootlin.com> CC: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Christos Gavros <gavrosc@yahoo.com> --- v2->v3 * the text is wrapped in less than 80 characters * the syntax for hyperinks is used for variables * the syntax for path of bitbake.conf is changed * the calculation steps are moved in IMAGE_ROOTFS_MAXSIZE variable --- documentation/ref-manual/variables.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+)