CaROS/poky
3
1
Fork 0
mirror of https://git.yoctoproject.org/git/poky synced 2026-01-01 13:58:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: fix for features_check class change

Browse Source 
distro_features_check was renamed to features_check and extended to
support MACHINE_FEATURES, COMBINED_FEATURES and ANY_OF_*_FEATURES in
dunfell, but the documentation still needed to be updated.

(From yocto-docs rev: 274eb596582a22883e8b386a07cf32ed45a77d79)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Paul Eggleton 2020-10-27 18:18:30 -07:00 committed by Richard Purdie
parent 266e1d6ae8
commit 249e789fed
2 changed files with 46 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
documentation/ref-manual/ref-classes.rst
View File

@ -501,21 +501,6 @@ Support for other version control systems such as Subversion is limited
due to BitBake's automatic fetch dependencies (e.g.
``subversion-native``).
.. _ref-classes-distro_features_check:
``distro_features_check.bbclass``
=================================
The ``distro_features_check`` class allows individual recipes to check
for required and conflicting
:term:`DISTRO_FEATURES`.
This class provides support for the
:term:`REQUIRED_DISTRO_FEATURES` and
:term:`CONFLICT_DISTRO_FEATURES`
variables. If any conditions specified in the recipe using the above
variables are not met, the recipe will be skipped.
.. _ref-classes-distutils:
``distutils*.bbclass``
@ -656,6 +641,32 @@ Finally, here is an example that sets the root password to "1876*18":
usermod -P 1876*18 root; \
"
.. _ref-classes-features_check:
``features_check.bbclass``
=================================
The ``features_check`` class allows individual recipes to check
for required and conflicting
:term:`DISTRO_FEATURES`, :term:`MACHINE_FEATURES` or :term:`COMBINED_FEATURES`.
This class provides support for the following variables:
- :term:`REQUIRED_DISTRO_FEATURES`
- :term:`CONFLICT_DISTRO_FEATURES`
- :term:`ANY_OF_DISTRO_FEATURES`
- ``REQUIRED_MACHINE_FEATURES``
- ``CONFLICT_MACHINE_FEATURES``
- ``ANY_OF_MACHINE_FEATURES``
- ``REQUIRED_COMBINED_FEATURES``
- ``CONFLICT_COMBINED_FEATURES``
- ``ANY_OF_COMBINED_FEATURES``
If any conditions specified in the recipe using the above
variables are not met, the recipe will be skipped, and if the
build system attempts to build the recipe then an error will be
triggered.
.. _ref-classes-fontcache:
``fontcache.bbclass``

26
documentation/ref-manual/ref-variables.rst
View File

@ -132,6 +132,18 @@ system and gives an overview of their function and contents.
":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
section.
:term:`ANY_OF_DISTRO_FEATURES`
When inheriting the
:ref:`features_check <ref-classes-features_check>`
class, this variable identifies a list of distribution features where
at least one must be enabled in the current configuration in order
for the OpenEmbedded build system to build the recipe. In other words,
if none of the features listed in ``ANY_OF_DISTRO_FEATURES``
appear in ``DISTRO_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:`APPEND`
An override list of append strings for each target specified with
:term:`LABELS`.
@ -1300,12 +1312,13 @@ system and gives an overview of their function and contents.
:term:`CONFLICT_DISTRO_FEATURES`
When inheriting the
:ref:`distro_features_check <ref-classes-distro_features_check>`
:ref:`features_check <ref-classes-features_check>`
class, this variable identifies distribution features that would be
in conflict should the recipe be built. In other words, if the
``CONFLICT_DISTRO_FEATURES`` variable lists a feature that also
appears in ``DISTRO_FEATURES`` within the current configuration, an
error occurs and the build stops.
appears in ``DISTRO_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:`COPYLEFT_LICENSE_EXCLUDE`
A space-separated list of licenses to exclude from the source
@ -6122,13 +6135,14 @@ system and gives an overview of their function and contents.
:term:`REQUIRED_DISTRO_FEATURES`
When inheriting the
:ref:`distro_features_check <ref-classes-distro_features_check>`
:ref:`features_check <ref-classes-features_check>`
class, this variable identifies distribution features that must exist
in the current configuration in order for the OpenEmbedded build
system to build the recipe. In other words, if the
``REQUIRED_DISTRO_FEATURES`` variable lists a feature that does not
appear in ``DISTRO_FEATURES`` within the current configuration, an
error occurs and the build stops.
appear in ``DISTRO_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:`RM_WORK_EXCLUDE`
With ``rm_work`` enabled, this variable specifies a list of recipes