poky/documentation/ref-manual
Joao Marcos Costa 8b9ff99208 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: 987929b349a927d6b243d351aebebfd160d1b097)

Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b9040e20b015e9b02683ec3014e4ade5eb59d41a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2025-09-17 15:32:27 -07:00
..
figures
svg ref-manual/release-process: update releases.svg 2025-05-19 08:57:20 -07:00
classes.rst ref-manual/classes.rst: document the testexport class 2025-08-13 08:42:58 -07:00
devtool-reference.rst sphinx-lint: unbalanced inline literal markup 2025-06-02 10:26:30 -07:00
faq.rst ref-manual/faq: add q&a on systemd as default 2025-02-07 17:52:48 +00:00
features.rst ref-manual/features.rst: drop ld-is-gold 2025-03-27 15:25:05 +00:00
images.rst Remove all mention of core-image-lsb 2025-03-07 17:04:26 +00:00
index.rst manuals: delete unmaintained history sections 2021-09-18 13:03:45 +01:00
kickstart.rst manuals: split dev-manual/common-tasks.rst 2022-12-01 19:20:29 +00:00
qa-checks.rst ref-manual/packages: move ptest section to the test-manual 2025-01-09 13:58:17 +00:00
release-process.rst Update autobuilder URLs to valkyrie 2025-01-20 13:45:06 +00:00
resources.rst manuals: refer to new yocto-patches mailing list wherever appropriate 2024-04-08 14:36:38 +01:00
structure.rst ref-manual/structure.rst: remove shared PERSISTENT_DIR mentions 2025-07-17 13:57:58 -07:00
system-requirements.rst ref-manual/system-requirements.rst: update supported distributions 2025-08-13 08:42:58 -07:00
tasks.rst sphinx-lint: unbalanced inline literal markup 2025-06-02 10:26:30 -07:00
terms.rst sphinx-lint: unbalanced inline literal markup 2025-06-02 10:26:30 -07:00
variables.rst ref-manual/variables.rst: expand IMAGE_OVERHEAD_FACTOR glossary entry 2025-09-17 15:32:27 -07:00
varlocality.rst manuals: replace hyphens with em dashes 2022-06-27 14:55:08 +01:00