diff mbox series

[yocto-docs,v2,10/14] ref-manual/variables: document the CHECKLAYER_REQUIRED_TESTS variable

Message ID 20241220-release-note-5-2-updates-v2-10-df29527f3fc5@bootlin.com
State New
Headers show
Series Updates from recent core changes | expand

Commit Message

Antonin Godard Dec. 20, 2024, 12:16 p.m. UTC 
This was introduced in oecore by commit
ce2e42ace2d15fb6745437cf0a7f07d28398ca12 ("insane: Split ERROR_QA into
CHECKLAYER_REQUIRED_TESTS").

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/variables.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 5c2920603fbf12657ab8f84dda027b8f26a75ce2..2a97ff98d3f0cb178ab2b6463980cf5a354acfc5 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1250,6 +1250,17 @@  system and gives an overview of their function and contents.
       -  :term:`BUILDSDK_CFLAGS` when building for
          an SDK (i.e. ``nativesdk-``)
 
+   :term:`CHECKLAYER_REQUIRED_TESTS`
+      The :term:`CHECKLAYER_REQUIRED_TESTS` variable lists the QA tests that are
+      required to be enabled to pass the Yocto Project Compatible status for a
+      layer. It is meant to be a read-only variable and any change to the
+      variable may be done with the approval of the :oe_wiki:`Technical Steering
+      Committee (TSC) </TSC>`.
+
+      For more information on the Yocto Project Compatible status, see
+      the :ref:`dev-manual/layers:Making Sure Your Layer is Compatible With
+      Yocto Project` section of the Yocto Project Development Manual.
+
    :term:`CLASSOVERRIDE`
       An internal variable specifying the special class override that
       should currently apply (e.g. "class-target", "class-native", and so