mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-09 17:39:31 +00:00
Code Issues Projects Releases Wiki Activity

ref-manual/classes: document the yocto-check-layer class

Browse Source 
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 <quentin.schulz@cherry.de>
(From yocto-docs rev: b3fd3c268ac3f15e4050a983289fc63e62f4c823)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Antonin Godard
2024-12-20 13:16:38 +01:00
committed by Richard Purdie
parent 9fba2b4a82
commit 30ab6f4153
1 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/classes.rst
+20
View File
@@ -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 </openembedded-core/tree/scripts/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.