Re: [PATCH v2 1/2] dev-manual/layers.rst: yocto-check-layer: mention --machines and --dependency

Quentin Schulz
2025-09-19T12:45:17Z

On 9/19/25 2:18 PM, Antonin Godard wrote:
> The yocto-check-layer script should be run with the --machines arguments
> to test the different machines present in a BSP layer. Mention it in the
> documentation. The --dependency can also be used so also mention that.
>
> [YOCTO #15974]
>
> Cc: Mark Hatle <mark.hatle@kernel.crashing.org>
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
> documentation/dev-manual/layers.rst | 15 +++++++++++++++
> 1 file changed, 15 insertions(+)
>
> diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst
> index fbf3f1a33..bba46b1d6 100644
> --- a/documentation/dev-manual/layers.rst
> +++ b/documentation/dev-manual/layers.rst
> @@ -376,6 +376,21 @@ directory::
> Be sure to provide the actual directory for your
> layer as part of the command.
>
> +For :term:`BSP <Board Support Package (BSP)>` layers, the ``--machines``
> +argument should be passed as part of the command::
> +
> + $ source oe-init-build-env
> + $ yocto-check-layer --machines <machine1> <machine2> ... -- your_layer_directory
> +
> +These machines are the ones present in your BSP layer, in the ``conf/machine/``
> +directory.
> +
> +You should also pass the dependencies of your layer using the ``--dependency``
> +argument::
> +
> + $ source oe-init-build-env
> + $ yocto-check-layer --dependency <layer1_directory> <layer2_directory> ... -- your_layer_directory
> +

question: relevant for other kind of layers?

I guess it is also relevant for other layers (distro and "common")? If
that's the case (it seems to be, I removed --dependency and --machines
and it still complained about missing dependencies), then maybe we
should put the --dependencies "example" above the BSP one?

I'm also wondering why we don't automatically include all files in
conf/machine as options to --machines instead of having to include them
by hand? But that's not a question for the docs people to answer :)

Finally, it seems we're missing a few tests in the list of tests, e.g. I
could quickly identify test_world, test_security,
test_world_inherit_class, test_patches_upstream_status for example.

Cheers,
Quentin