diff mbox series

[yocto-docs,v2] dev-manual: Document yocto-check-layer --run-tests

Message ID 20261119122700.1695957-1-otavio@ossystems.tech
State New
Headers show
Series [yocto-docs,v2] dev-manual: Document yocto-check-layer --run-tests | expand

Commit Message

Otavio Salvador Nov. 19, 2026, 12:27 p.m. UTC
yocto-check-layer can now run a subset of its tests with --run-tests,
for example to split a long check of a BSP layer over several runs.
Document the option, and that a PASS from such a run doesn't make a
layer Yocto Project Compatible: that needs a single run with all the
tests and, for a BSP layer, all its machines.

AI-Generated: Claude Code, Opus 5.5
Signed-off-by: Otavio Salvador <otavio@ossystems.tech>
---
Changes in v2:
- Use the same address for the author and the Signed-off-by.

 documentation/dev-manual/layers.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

Comments

Quentin Schulz Nov. 19, 2026, 12:29 p.m. UTC | #1
Hi Otavio,

On 11/19/26 1:27 PM, Otavio Salvador via docs wrote:
> [You don't often get email from otavio.salvador=gmail.com@lists.yoctoproject.org. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]
> 
> yocto-check-layer can now run a subset of its tests with --run-tests,
> for example to split a long check of a BSP layer over several runs.
> Document the option, and that a PASS from such a run doesn't make a
> layer Yocto Project Compatible: that needs a single run with all the
> tests and, for a BSP layer, all its machines.
> 
> AI-Generated: Claude Code, Opus 5.5
> Signed-off-by: Otavio Salvador <otavio@ossystems.tech>
> ---
> Changes in v2:
> - Use the same address for the author and the Signed-off-by.
> 
>   documentation/dev-manual/layers.rst | 13 +++++++++++++
>   1 file changed, 13 insertions(+)
> 
> diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst
> index 5c8bf32b4..5a6577fd1 100644
> --- a/documentation/dev-manual/layers.rst
> +++ b/documentation/dev-manual/layers.rst
> @@ -405,6 +405,19 @@ argument should be passed as part of the command::
>   These machines are the ones present in your BSP layer, in the ``conf/machine/``
>   directory.
> 
> +To run only some of the tests, for example to split a long check over
> +several runs, pass their names to the ``--run-tests`` argument, as
> +``<module>[.<class>[.<name>]]``::
> +
> +   $ source oe-init-build-env
> +   $ yocto-check-layer --run-tests bsp --machines <machine1> <machine2> ... -- your_layer_directory
> +

Can you provide a more useful example where module.class.name, which you 
alluded to just before the code block, is used and potentially even link 
to the source code of the tests that are then run?

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst
index 5c8bf32b4..5a6577fd1 100644
--- a/documentation/dev-manual/layers.rst
+++ b/documentation/dev-manual/layers.rst
@@ -405,6 +405,19 @@  argument should be passed as part of the command::
 These machines are the ones present in your BSP layer, in the ``conf/machine/``
 directory.
 
+To run only some of the tests, for example to split a long check over
+several runs, pass their names to the ``--run-tests`` argument, as
+``<module>[.<class>[.<name>]]``::
+
+   $ source oe-init-build-env
+   $ yocto-check-layer --run-tests bsp --machines <machine1> <machine2> ... -- your_layer_directory
+
+.. note::
+
+   A "PASS" from such a run only covers the tests and machines it ran. A
+   layer is Yocto Project Compatible only if a single run with all the
+   tests, and with all the machines of a BSP layer, passes.
+
 Entering the command causes the script to determine the type of layer
 and then to execute a set of specific tests against the layer.