From 81412adb5e80a34cb2eb4a36df9da3c54b99e80a Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Fri, 20 Dec 2024 13:16:30 +0100 Subject: ref-manual/variables: document the FIRMWARE_COMPRESSION variable Added in oecore after the 20241017 update. (From yocto-docs rev: 9073f575f169ab545198d82b69cca5f9e3db152f) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/ref-manual/variables.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'documentation') diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index b31abeced4..21c4c78873 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. -- cgit v1.2.3-54-g00ecf