| Message ID | 20251024-release-note-5-3-second-hunk-v2-9-d15dabc095d0@bootlin.com |
|---|---|
| State | Under Review |
| Headers | show |
| Series | Updates for 5.3 | expand |
Hi Antonin, On 10/24/25 10:19 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 | 17 +++++++++++++++++ > 1 file changed, 17 insertions(+) > > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst > index 167f38e86..9d2889877 100644 > --- a/documentation/ref-manual/variables.rst > +++ b/documentation/ref-manual/variables.rst > @@ -7896,6 +7896,23 @@ 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 other ``REQUIRED_*_FEATURES`` variables, the > + :term:`REQUIRED_IMAGE_FEATURES` varible only targets image recipes, as the > + :term:`IMAGE_FEATURES` variable is handled by the :ref:`ref-classes-core-image` > + class). However, the :term:`REQUIRED_IMAGE_FEATURES` varible can also be > + set from a :term:`Configuration File`, such as a :term:`DISTRO` Not sure we should use DISTRO link here or rather use a lowercase "distro" (without the link) which I believe is what we use most over the source code? Otherwise, looks good to me, thus Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Thanks! Quentin
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 167f38e86..9d2889877 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -7896,6 +7896,23 @@ 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 other ``REQUIRED_*_FEATURES`` variables, the + :term:`REQUIRED_IMAGE_FEATURES` varible only targets image recipes, as the + :term:`IMAGE_FEATURES` variable is handled by the :ref:`ref-classes-core-image` + class). However, the :term:`REQUIRED_IMAGE_FEATURES` varible can also be + set from a :term:`Configuration File`, such as a :term:`DISTRO` + configuration file, if the list of required image features should apply to + all images using this :term:`DISTRO`. + :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
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 | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)