diff mbox series

[yocto-docs,v2,03/14] ref-manual/variables: document the FIRMWARE_COMPRESSION variable

Message ID 20241220-release-note-5-2-updates-v2-3-df29527f3fc5@bootlin.com
State New
Headers show
Series Updates from recent core changes | expand

Commit Message

Antonin Godard Dec. 20, 2024, 12:16 p.m. UTC 
Added in oecore after the 20241017 update.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/variables.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index b31abeced4cc9b692f8bed814891a267c73f29b7..21c4c78873e67786e09ac49a0ac15efedfb0240e 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3038,6 +3038,16 @@  system and gives an overview of their function and contents.
       tables, examine the existing ``fs-perms.txt``,
       ``fs-perms-volatile-log.txt`` and ``fs-perms-volatile-tmp.txt`` files.
 
+   :term:`FIRMWARE_COMPRESSION`
+      The :term:`FIRMWARE_COMPRESSION` allows compressing the firmware provided
+      by the ``linux-firmware`` recipe. The default value of this variable is an
+      empty string (no compression), and the possible values it can take are
+      ``xz`` and ``zst``. This can allow significant disk space savings.
+
+      For this to work, the Linux Kernel requires the
+      ``CONFIG_FW_LOADER_COMPRESS_XZ`` or ``CONFIG_FW_LOADER_COMPRESS_ZSTD``
+      configuration options to be set.
+
    :term:`FIT_ADDRESS_CELLS`
       Specifies the value of the ``#address-cells`` value for the
       description of the FIT image.