From 30ab6f415361a5e9eb8b3096a0435e8892287991 Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Fri, 20 Dec 2024 13:16:38 +0100 Subject: [PATCH] ref-manual/classes: document the yocto-check-layer class This class is used by the yocto-check-layer script to check if a layer complies to the Yocto Project Compatible status. Reviewed-by: Quentin Schulz (From yocto-docs rev: b3fd3c268ac3f15e4050a983289fc63e62f4c823) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/ref-manual/classes.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) 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 :term:`PACKAGECONFIG_CONFARGS` variables to specify additional configuration options to be passed on the Waf command line. + +.. _ref-classes-yocto-check-layer: + +``yocto-check-layer`` +===================== + +The :ref:`ref-classes-yocto-check-layer` class is used by the +:oe_git:`yocto-check-layer ` +script to ensure that packages from Yocto Project Compatible layers don't skip +required QA checks listed in :term:`CHECKLAYER_REQUIRED_TESTS` defined by the +:ref:`ref-classes-insane` class. + +It adds an anonymous python function with extra processing to all recipes, +and globally inheriting this class with :term:`INHERIT` is not advised. Instead +the ``yocto-check-layer`` script should be used as it handles usage of this +class. + +For more information on the Yocto Project +Compatible layers, see the :ref:`dev-manual/layers:Making Sure Your Layer is +Compatible With Yocto Project` section of the Yocto Project Development Manual.