summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-classes.rst
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@microsoft.com>2020-10-27 18:18:30 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-01-04 10:55:02 +0000
commitb591dcd33e2ae939f95dd08ecc463687de22efae (patch)
tree7dc88ee08e71aaff071345202e6dcfeefa9ff939 /documentation/ref-manual/ref-classes.rst
parentbb16108231e83286ab74a34edbcbee83dd7fcda1 (diff)
downloadpoky-b591dcd33e2ae939f95dd08ecc463687de22efae.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: 3d565c61086c235f77d967acf7599e64f5944cb4) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 274eb596582a22883e8b386a07cf32ed45a77d79) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-classes.rst')
-rw-r--r--documentation/ref-manual/ref-classes.rst41
1 files changed, 26 insertions, 15 deletions
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst
index 3ac4aa482b..e657fe0e55 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``