summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/classes.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index af9aac9281..aee0d55c30 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -3602,3 +3602,23 @@ the Waf build system. You can use the
3602:term:`PACKAGECONFIG_CONFARGS` variables 3602:term:`PACKAGECONFIG_CONFARGS` variables
3603to specify additional configuration options to be passed on the Waf 3603to specify additional configuration options to be passed on the Waf
3604command line. 3604command line.
3605
3606.. _ref-classes-yocto-check-layer:
3607
3608``yocto-check-layer``
3609=====================
3610
3611The :ref:`ref-classes-yocto-check-layer` class is used by the
3612:oe_git:`yocto-check-layer </openembedded-core/tree/scripts/yocto-check-layer>`
3613script to ensure that packages from Yocto Project Compatible layers don't skip
3614required QA checks listed in :term:`CHECKLAYER_REQUIRED_TESTS` defined by the
3615:ref:`ref-classes-insane` class.
3616
3617It adds an anonymous python function with extra processing to all recipes,
3618and globally inheriting this class with :term:`INHERIT` is not advised. Instead
3619the ``yocto-check-layer`` script should be used as it handles usage of this
3620class.
3621
3622For more information on the Yocto Project
3623Compatible layers, see the :ref:`dev-manual/layers:Making Sure Your Layer is
3624Compatible With Yocto Project` section of the Yocto Project Development Manual.