summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@microsoft.com>2020-10-27 18:18:30 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-10-30 12:09:21 +0000
commit249e789fedff88ecb16175d823fa8bc0d4383181 (patch)
tree5f1575d3ee8beed7968406b003ef0a4f485fca76 /documentation/ref-manual
parent266e1d6ae83e3a7b1ba75f6360e744dab1ad2d10 (diff)
downloadpoky-249e789fedff88ecb16175d823fa8bc0d4383181.tar.gz
ref-manual: fix for features_check class change
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>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-classes.rst41
-rw-r--r--documentation/ref-manual/ref-variables.rst26
2 files changed, 46 insertions, 21 deletions
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst
index 028729ffe9..249b58e60c 100644
--- a/documentation/ref-manual/ref-classes.rst
+++ b/documentation/ref-manual/ref-classes.rst
@@ -501,21 +501,6 @@ Support for other version control systems such as Subversion is limited
501due to BitBake's automatic fetch dependencies (e.g. 501due to BitBake's automatic fetch dependencies (e.g.
502``subversion-native``). 502``subversion-native``).
503 503
504.. _ref-classes-distro_features_check:
505
506``distro_features_check.bbclass``
507=================================
508
509The ``distro_features_check`` class allows individual recipes to check
510for required and conflicting
511:term:`DISTRO_FEATURES`.
512
513This class provides support for the
514:term:`REQUIRED_DISTRO_FEATURES` and
515:term:`CONFLICT_DISTRO_FEATURES`
516variables. If any conditions specified in the recipe using the above
517variables are not met, the recipe will be skipped.
518
519.. _ref-classes-distutils: 504.. _ref-classes-distutils:
520 505
521``distutils*.bbclass`` 506``distutils*.bbclass``
@@ -656,6 +641,32 @@ Finally, here is an example that sets the root password to "1876*18":
656 usermod -P 1876*18 root; \ 641 usermod -P 1876*18 root; \
657 " 642 "
658 643
644.. _ref-classes-features_check:
645
646``features_check.bbclass``
647=================================
648
649The ``features_check`` class allows individual recipes to check
650for required and conflicting
651:term:`DISTRO_FEATURES`, :term:`MACHINE_FEATURES` or :term:`COMBINED_FEATURES`.
652
653This class provides support for the following variables:
654
655- :term:`REQUIRED_DISTRO_FEATURES`
656- :term:`CONFLICT_DISTRO_FEATURES`
657- :term:`ANY_OF_DISTRO_FEATURES`
658- ``REQUIRED_MACHINE_FEATURES``
659- ``CONFLICT_MACHINE_FEATURES``
660- ``ANY_OF_MACHINE_FEATURES``
661- ``REQUIRED_COMBINED_FEATURES``
662- ``CONFLICT_COMBINED_FEATURES``
663- ``ANY_OF_COMBINED_FEATURES``
664
665If any conditions specified in the recipe using the above
666variables are not met, the recipe will be skipped, and if the
667build system attempts to build the recipe then an error will be
668triggered.
669
659.. _ref-classes-fontcache: 670.. _ref-classes-fontcache:
660 671
661``fontcache.bbclass`` 672``fontcache.bbclass``
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 0603ba93c5..a7315cf6f7 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -132,6 +132,18 @@ system and gives an overview of their function and contents.
132 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" 132 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
133 section. 133 section.
134 134
135 :term:`ANY_OF_DISTRO_FEATURES`
136 When inheriting the
137 :ref:`features_check <ref-classes-features_check>`
138 class, this variable identifies a list of distribution features where
139 at least one must be enabled in the current configuration in order
140 for the OpenEmbedded build system to build the recipe. In other words,
141 if none of the features listed in ``ANY_OF_DISTRO_FEATURES``
142 appear in ``DISTRO_FEATURES`` within the current configuration, then
143 the recipe will be skipped, and if the build system attempts to build
144 the recipe then an error will be triggered.
145
146
135 :term:`APPEND` 147 :term:`APPEND`
136 An override list of append strings for each target specified with 148 An override list of append strings for each target specified with
137 :term:`LABELS`. 149 :term:`LABELS`.
@@ -1300,12 +1312,13 @@ system and gives an overview of their function and contents.
1300 1312
1301 :term:`CONFLICT_DISTRO_FEATURES` 1313 :term:`CONFLICT_DISTRO_FEATURES`
1302 When inheriting the 1314 When inheriting the
1303 :ref:`distro_features_check <ref-classes-distro_features_check>` 1315 :ref:`features_check <ref-classes-features_check>`
1304 class, this variable identifies distribution features that would be 1316 class, this variable identifies distribution features that would be
1305 in conflict should the recipe be built. In other words, if the 1317 in conflict should the recipe be built. In other words, if the
1306 ``CONFLICT_DISTRO_FEATURES`` variable lists a feature that also 1318 ``CONFLICT_DISTRO_FEATURES`` variable lists a feature that also
1307 appears in ``DISTRO_FEATURES`` within the current configuration, an 1319 appears in ``DISTRO_FEATURES`` within the current configuration, then
1308 error occurs and the build stops. 1320 the recipe will be skipped, and if the build system attempts to build
1321 the recipe then an error will be triggered.
1309 1322
1310 :term:`COPYLEFT_LICENSE_EXCLUDE` 1323 :term:`COPYLEFT_LICENSE_EXCLUDE`
1311 A space-separated list of licenses to exclude from the source 1324 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.
6122 6135
6123 :term:`REQUIRED_DISTRO_FEATURES` 6136 :term:`REQUIRED_DISTRO_FEATURES`
6124 When inheriting the 6137 When inheriting the
6125 :ref:`distro_features_check <ref-classes-distro_features_check>` 6138 :ref:`features_check <ref-classes-features_check>`
6126 class, this variable identifies distribution features that must exist 6139 class, this variable identifies distribution features that must exist
6127 in the current configuration in order for the OpenEmbedded build 6140 in the current configuration in order for the OpenEmbedded build
6128 system to build the recipe. In other words, if the 6141 system to build the recipe. In other words, if the
6129 ``REQUIRED_DISTRO_FEATURES`` variable lists a feature that does not 6142 ``REQUIRED_DISTRO_FEATURES`` variable lists a feature that does not
6130 appear in ``DISTRO_FEATURES`` within the current configuration, an 6143 appear in ``DISTRO_FEATURES`` within the current configuration, then
6131 error occurs and the build stops. 6144 the recipe will be skipped, and if the build system attempts to build
6145 the recipe then an error will be triggered.
6132 6146
6133 :term:`RM_WORK_EXCLUDE` 6147 :term:`RM_WORK_EXCLUDE`
6134 With ``rm_work`` enabled, this variable specifies a list of recipes 6148 With ``rm_work`` enabled, this variable specifies a list of recipes