diff mbox series

ref-manual: Add missing variable IMAGE_ROOTFS_MAXSIZE

Message ID 20250206132012.359126-1-pascal.weisser.ext@karlstorz.com
State Superseded
Headers show
Series ref-manual: Add missing variable IMAGE_ROOTFS_MAXSIZE | expand

Commit Message

Weisser, Pascal Feb. 6, 2025, 1:20 p.m. UTC
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 | 3 +++
 1 file changed, 3 insertions(+)

Comments

Quentin Schulz Feb. 6, 2025, 3:16 p.m. UTC | #1
Hi Pascal,

On 2/6/25 2:20 PM, Weisser, Pascal.ext via lists.yoctoproject.org wrote:
> This patch adds the missing documentation of variable IMAGE_ROOTFS_MAXSIZE
> to the reference manual.
> 

Thanks for the patch!

Don't forget to add the v2 after PATCH in the title when sending the v2 
(this is the v2 but it's named the same as v1, so it's a bit difficult 
to know which patch to review :) ). This is usually done via git 
send-email -v2 for example :) (or git format-patch -v2)

> Signed-off-by: Weisser, Pascal <pascal.weisser.ext@karlstorz.com>
> ---
>   documentation/ref-manual/variables.rst | 3 +++
>   1 file changed, 3 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 47d4e814f..c80696b64 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -3984,6 +3984,9 @@ 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.
> +

I think we could say that if the generated image size is above that, the 
build will fail. We could say also that it's a good idea for images that 
need to fit on a limited space (e.g. SD card, a fixed-size partition, ...).

It seems like we have another variable that has virtually the same 
behavior: INITRAMFS_MAXSIZE, is this something you could contribute a 
patch for too?

Thanks!
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 47d4e814f..c80696b64 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3984,6 +3984,9 @@  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.
+
    :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