From ef363542caaf7971360d54c503e73bbb838bf760 Mon Sep 17 00:00:00 2001 From: Joao Marcos Costa Date: Mon, 1 Sep 2025 18:07:59 +0200 Subject: ref-manual/variables.rst: expand IMAGE_OVERHEAD_FACTOR glossary entry 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. (From yocto-docs rev: 18a0dcefd4e688d60e57e8531b0ac283764e4e89) Signed-off-by: Joao Marcos Costa Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit b9040e20b015e9b02683ec3014e4ade5eb59d41a) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman --- 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 ef64bcad49..59b71a4ef7 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -4079,6 +4079,12 @@ 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 value is defined by the ``--overhead-factor`` option, which + defaults to "1.3" when omitted. See the + :ref:`ref-manual/kickstart:command: part or partition` chapter in + :doc:`/ref-manual/kickstart` 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 -- cgit v1.2.3-54-g00ecf