diff mbox series

[v2,07/16] ref-manual/variables.rst: document the REQUIRED_MACHINE_FEATURES variable

Message ID 20251024-release-note-5-3-second-hunk-v2-7-d15dabc095d0@bootlin.com
State Under Review
Headers show
Series Updates for 5.3 | expand

Commit Message

Antonin Godard Oct. 24, 2025, 8:19 a.m. UTC
Added in OE-Core commit: 5f4875b950ce ("distro_features_check: expand
with MACHINE_FEATURES and COMBINED_FEATURES, rename").

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

Comments

Quentin Schulz Oct. 24, 2025, 3:24 p.m. UTC | #1
Hi Antonin,

On 10/24/25 10:19 AM, Antonin Godard wrote:
> Added in OE-Core commit: 5f4875b950ce ("distro_features_check: expand
> with MACHINE_FEATURES and COMBINED_FEATURES, rename").
> 
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
> 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 27f761b72..5b8e0f7ce 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -7886,6 +7886,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_MACHINE_FEATURES`
> +      When inheriting the :ref:`ref-classes-features_check` class, this variable
> +      identifies :term:`MACHINE` features that must exist in the current

I'm not sure we should use MACHINE here as that implies at first read 
that it's related to the MACHINE variable (ok it is at some degree..) 
instead of MACHINE_FEATURES like explained a few lines below.

Looks good to me otherwise, thus

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 27f761b72..5b8e0f7ce 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7886,6 +7886,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_MACHINE_FEATURES`
+      When inheriting the :ref:`ref-classes-features_check` class, this variable
+      identifies :term:`MACHINE` 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_MACHINE_FEATURES` variable
+      lists a feature that does not appear in :term:`MACHINE_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_TUNE_FEATURES`
       When inheriting the :ref:`ref-classes-features_check` class, this variable
       identifies tune features that must exist in the current configuration in