diff mbox series

[v4] ref-manual: Add missing variable IMAGE_ROOTFS_MAXSIZE

Message ID 20250207095540.186588-1-pascal.weisser.ext@karlstorz.com
State Accepted
Headers show
Series [v4] ref-manual: Add missing variable IMAGE_ROOTFS_MAXSIZE | expand

Commit Message

Weisser, Pascal Feb. 7, 2025, 9:55 a.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 | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Antonin Godard March 3, 2025, 9:31 a.m. UTC | #1
On Fri, 07 Feb 2025 10:55:40 +0100, Weisser, Pascal wrote:
> This patch adds the missing documentation of variable IMAGE_ROOTFS_MAXSIZE
> to the reference manual.

Applied, thanks!

[1/1] ref-manual: Add missing variable IMAGE_ROOTFS_MAXSIZE
      commit: 1dcc8cf7c49da449b324a7bd6bb22effe1d53d70

Best regards,
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 47d4e814f..16413f80b 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