diff mbox series

[09/17] ref-manual/variables.rst: document the REQUIRED_IMAGE_FEATURES variable

Message ID 20251016-release-note-5-3-second-hunk-v1-9-20f21db1f93c@bootlin.com
State New
Headers show
Series Updates for 5.3 | expand

Commit Message

Antonin Godard Oct. 16, 2025, 8:53 a.m. UTC
Added by commit 96a9702a24a7 ("distro_features_check: expand with
IMAGE_FEATURES") in OE-Core.

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

Comments

Quentin Schulz Oct. 16, 2025, 10:20 a.m. UTC | #1
Hi Antonin,

On 10/16/25 10:53 AM, Antonin Godard via lists.yoctoproject.org wrote:
> Added by commit 96a9702a24a7 ("distro_features_check: expand with
> IMAGE_FEATURES") in OE-Core.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/variables.rst | 9 +++++++++
>   1 file changed, 9 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 6c94b0d10..bb24f2583 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -7946,6 +7946,15 @@ system and gives an overview of their function and contents.
>         the recipe will be skipped, and if the build system attempts to build
>         the recipe then an error will be triggered.
>   
> +   :term:`REQUIRED_IMAGE_FEATURES`
> +      When inheriting the :ref:`ref-classes-features_check` class, this variable
> +      identifies image features that must exist in the current
> +      configuration in order for the :term:`OpenEmbedded Build System` to build
> +      the recipe. In other words, if the :term:`REQUIRED_IMAGE_FEATURES` variable
> +      lists a feature that does not appear in :term:`IMAGE_FEATURES` within the
> +      current configuration, then the recipe will be skipped, and if the build
> +      system attempts to build the recipe then an error will be triggered.
> +

Compared to the other REQUIRED_.*_FEATURES, I think this one 
specifically targets image recipes no (as IMAGE_FEATURES is to be set at 
the image recipe or distro conf level?)?

What do you think about adding a few words on that maybe?

E.g. I won't be able to skip a package recipe if it has 
REQUIRED_IMAGE_FEATURES set to X and the image recipe that will pull 
this package recipe as part of its dependency tree sets IMAGE_FEATURES 
to not contain X? It however can work if IMAGE_FEATURES is set from a 
conf context (e.g. via a distro to have consistency between image 
recipes with the same distro, useful e.g. for using security features by 
default) but you likely shouldn't be using this variable in a package 
recipe no?

Otherwise looks good to me,
Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 6c94b0d10..bb24f2583 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7946,6 +7946,15 @@  system and gives an overview of their function and contents.
       the recipe will be skipped, and if the build system attempts to build
       the recipe then an error will be triggered.
 
+   :term:`REQUIRED_IMAGE_FEATURES`
+      When inheriting the :ref:`ref-classes-features_check` class, this variable
+      identifies image features that must exist in the current
+      configuration in order for the :term:`OpenEmbedded Build System` to build
+      the recipe. In other words, if the :term:`REQUIRED_IMAGE_FEATURES` variable
+      lists a feature that does not appear in :term:`IMAGE_FEATURES` within the
+      current configuration, then the recipe will be skipped, and if the build
+      system attempts to build the recipe then an error will be triggered.
+
    :term:`REQUIRED_MACHINE_FEATURES`
       When inheriting the :ref:`ref-classes-features_check` class, this variable
       identifies :term:`MACHINE` features that must exist in the current