diff mbox series

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

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

Commit Message

Antonin Godard Dec. 17, 2024, 9:27 a.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 | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Quentin Schulz Dec. 17, 2024, 2:14 p.m. UTC | #1
Hi Antonin,

On 12/17/24 10:27 AM, Antonin Godard via lists.yoctoproject.org wrote:
> 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 | 7 +++++++
>   1 file changed, 7 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index d54e1365fcf3dabd3868aa80089afda727b1415a..66ecece8b2658b304e17c9c4a1492e42a8a313d4 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -1251,6 +1251,13 @@ 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. 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.
> +

I don't think anything prevents us from modifying this variable to 
"pass" the test. Maybe we should say that this is meant to be a 
read-only variable essentially? And that modifications to the variable 
may only be done with approval from Yocto TSC?

Otherwise, looks good to me.

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index d54e1365fcf3dabd3868aa80089afda727b1415a..66ecece8b2658b304e17c9c4a1492e42a8a313d4 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1251,6 +1251,13 @@  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. 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