| Message ID | 20250206153529.2546767-1-pascal.weisser.ext@karlstorz.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v3] ref-manual: Add missing variable IMAGE_ROOTFS_MAXSIZE | expand |
Hi Pascal, On 2/6/25 4:35 PM, Weisser, Pascal.ext via lists.yoctoproject.org wrote: > This patch adds the missing documentation of variable IMAGE_ROOTFS_MAXSIZE > to the reference manual. > > Signed-off-by: Weisser, Pascal <pascal.weisser.ext@karlstorz.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Thanks! Quentin
Hi Pascal, On Thu Feb 6, 2025 at 4:35 PM CET, Pascal.ext via lists.yoctoproject.org Weisser wrote: > This patch adds the missing documentation of variable IMAGE_ROOTFS_MAXSIZE > to the reference manual. > > Signed-off-by: Weisser, Pascal <pascal.weisser.ext@karlstorz.com> > --- > documentation/ref-manual/variables.rst | 6 ++++++ > 1 file changed, 6 insertions(+) > > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst > index 47d4e814f..889944b0a 100644 > --- a/documentation/ref-manual/variables.rst > +++ b/documentation/ref-manual/variables.rst > @@ -3984,6 +3984,12 @@ system and gives an overview of their function and contents. > > IMAGE_ROOTFS_EXTRA_SPACE = "41943040" > > + :term:`IMAGE_ROOTFS_MAXSIZE` > + Defines the maximum size in Kbytes for the generated image. If the > + generated image size is above that, the build will fail. It's a good > + idea to set this variable for images that need to fit on a limited > + space (e.g. SD card, a fixed-size partition, ...). Here the indentation should be three spaces (compared to ":term:"), not four. > + > :term:`IMAGE_ROOTFS_SIZE` > Defines the size in Kbytes for the generated image. The OpenEmbedded > build system determines the final size for the generated image using Thanks for this, I'm surprised this wasn't documented already :) Antonin
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 47d4e814f..889944b0a 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3984,6 +3984,12 @@ system and gives an overview of their function and contents. IMAGE_ROOTFS_EXTRA_SPACE = "41943040" + :term:`IMAGE_ROOTFS_MAXSIZE` + Defines the maximum size in Kbytes for the generated image. If the + generated image size is above that, the build will fail. It's a good + idea to set this variable for images that need to fit on a limited + space (e.g. SD card, a fixed-size partition, ...). + :term:`IMAGE_ROOTFS_SIZE` Defines the size in Kbytes for the generated image. The OpenEmbedded build system determines the final size for the generated image using
This patch adds the missing documentation of variable IMAGE_ROOTFS_MAXSIZE to the reference manual. Signed-off-by: Weisser, Pascal <pascal.weisser.ext@karlstorz.com> --- documentation/ref-manual/variables.rst | 6 ++++++ 1 file changed, 6 insertions(+)