diff mbox series

ref-manual/variables.rst: expand IMAGE_OVERHEAD_FACTOR glossary entry

Message ID 20250819160431.382820-1-joaomarcos.costa@bootlin.com
State New
Headers show
Series ref-manual/variables.rst: expand IMAGE_OVERHEAD_FACTOR glossary entry | expand

Commit Message

Joao Marcos Costa Aug. 19, 2025, 4:04 p.m. UTC 
From: Joao Marcos Costa <joaomarcos.costa@bootlin.com>

There's a (second) overhead factor applied in images generated with Wic,
and this is already documented in the .wks reference. However, the
IMAGE_OVERHEAD_FACTOR entry does not mention it, and by looking at the
partition sizes (e.g. with parted) one may find it confusing that they
don't match with the expected rootfs size (e.g. in a scenario where the
extra space is "0" and IMAGE_OVERHEAD_FACTOR="1.0").

This second overhead is already documented, though:
https://docs.yoctoproject.org/ref-manual/kickstart.html#command-part-or-partition

Mention the '--overhead-factor' option in the glossary entry and add a
reference to the wks documentation.

Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
---
 documentation/ref-manual/variables.rst | 5 +++++
 1 file changed, 5 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index d559899c6..c18bc7ba4 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4166,6 +4166,11 @@  system and gives an overview of their function and contents.
       added to the image by using the :term:`IMAGE_ROOTFS_EXTRA_SPACE`
       variable.
 
+      When using Wic tool, beware that a second overhead factor is also applied.
+      This overhead's value is defined by the ``--overhead-factor`` option, and
+      not by :term:`IMAGE_OVERHEAD_FACTOR`. See the
+      ":doc:`/ref-manual/kickstart`" chapter for details.
+
    :term:`IMAGE_PKGTYPE`
       Defines the package type (i.e. DEB, RPM or IPK) used by the
       OpenEmbedded build system. The variable is defined appropriately by