From 8b4438fe84d0d51d2ec0858182110744f89f8b9b Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Fri, 26 Sep 2025 09:54:25 +0200 Subject: [PATCH] dev-manual/layers.rst: yocto-check-layer: update list of test Update the lists of tests as found OE-Core as of commit 07747aa7390e ("piglit: rename virtual/opencl-icd to virtual/libopencl1"). Add a link to the test directory in case the list is update, users can still browse through the code. (From yocto-docs rev: c3783914d01d313a35e29e75e562eefba5e40df4) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/dev-manual/layers.rst | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst index 4224a02b28..cc7103ba61 100644 --- a/documentation/dev-manual/layers.rst +++ b/documentation/dev-manual/layers.rst @@ -392,12 +392,17 @@ These machines are the ones present in your BSP layer, in the ``conf/machine/`` directory. Entering the command causes the script to determine the type of layer -and then to execute a set of specific tests against the layer. The -following list overviews the test: +and then to execute a set of specific tests against the layer. + +The following list overviews the test: - ``common.test_readme``: Tests if a ``README`` file exists in the layer and the file is not empty. +- ``common.test_security``: Tests that the layer has a ``SECURITY.md`` + (or similar) file, either in the layer itself or at the top of the containing + git repository. + - ``common.test_parse``: Tests to make sure that BitBake can parse the files without error (i.e. ``bitbake -p``). @@ -406,6 +411,13 @@ following list overviews the test: - ``common.test_world``: Verifies that ``bitbake world`` works. +- ``common.test_world_inherit_class``: Verifies that ``bitbake world`` works + when the :ref:`ref-classes-yocto-check-layer` class is inherited. + +- ``common.test_patches_upstream_status``: Verifies that all the patch files + included in the layer contain a + :ref:`contributor-guide/recipe-style-guide:Patch Upstream Status`. + - ``common.test_signatures``: Tests to be sure that BSP and DISTRO layers do not come with recipes that change signatures. @@ -431,6 +443,10 @@ following list overviews the test: - ``distro.test_distro_no_set_distros``: Tests to ensure a DISTRO layer does not set the distribution when the layer is added. +For a complete list of tests, see the :oe_git:`scripts/lib/checklayer/cases +` directory in +:term:`OpenEmbedded-Core (OE-Core)`. + Enabling Your Layer ===================