diff mbox series

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

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

Commit Message

Antonin Godard Dec. 17, 2024, 9:27 a.m. UTC
Added in oecore after the 20241017 update.

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

Comments

Quentin Schulz Dec. 17, 2024, 10:28 a.m. UTC | #1
Hi Antonin,

On 12/17/24 10:27 AM, Antonin Godard via lists.yoctoproject.org wrote:
> Added in oecore after the 20241017 update.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   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 c6d3d1bba9961704fca25921b346d5282e118db4..5875ee3e7c554ffedf4af86e61c207d10aa46ad9 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -3039,6 +3039,12 @@ 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-firmare`` recipe. The default value of this variable is an

s/linux-firmare/linux-firmware/

> +      empty string (no compression), and the possible values it can take are
> +      ``xz`` and ``zst``. This can allow significant disk space savings.
> +

I believe it'd be good to state that the kernel needs to be configured 
such that it can make use of those compressed firmware files.

I believe the config options are FW_LOADER_COMPRESS_XZ and 
FW_LOADER_COMPRESS_ZSTD?

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index c6d3d1bba9961704fca25921b346d5282e118db4..5875ee3e7c554ffedf4af86e61c207d10aa46ad9 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3039,6 +3039,12 @@  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-firmare`` 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.
+
    :term:`FIT_ADDRESS_CELLS`
       Specifies the value of the ``#address-cells`` value for the
       description of the FIT image.