[PATCH v2 0/2] Update yocto-check-layer documentation

[PATCH v2 0/2] Update yocto-check-layer documentation

[Antonin Godard]

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Changes in v2:
- Mention --dependency
- Pass layer dir as last argument after --
- Link to v1: https://lore.kernel.org/r/20250919-update-compatible-doc-v1-0-f3a343914503@bootlin.com

---
Antonin Godard (2):
      dev-manual/layers.rst: yocto-check-layer: mention --machines and --dependency
      test-manual/yocto-project-compatible.rst: fix a typo

 documentation/dev-manual/layers.rst                    | 15 +++++++++++++++
 documentation/test-manual/yocto-project-compatible.rst |  2 +-
 2 files changed, 16 insertions(+), 1 deletion(-)
---
base-commit: e77139b5c616e6e5ad436eb91416fd804389425f
change-id: 20250919-update-compatible-doc-651debba8dfa

Best regards,
--  
Antonin Godard <antonin.godard@bootlin.com>

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

[Antonin Godard]

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
+
 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:

-- 
2.51.0

[PATCH v2 2/2] test-manual/yocto-project-compatible.rst: fix a typo

[Antonin Godard]

Fix a typo in yocto-project-compatible.rst.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/test-manual/yocto-project-compatible.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/test-manual/yocto-project-compatible.rst b/documentation/test-manual/yocto-project-compatible.rst
index 65d924fad9..7a2e00a99e 100644
--- a/documentation/test-manual/yocto-project-compatible.rst
+++ b/documentation/test-manual/yocto-project-compatible.rst
@@ -38,7 +38,7 @@ Benefits
 and flexible: it gives users the ultimate power to change pretty much any
 aspect of the system but as with most things, power comes with responsibility.
 The Yocto Project would like to see people able to mix and match BSPs with
-distro configs or software stacks and be able to merge succesfully.
+distro configs or software stacks and be able to merge successfully.
 Over time, the project identified characteristics in layers that allow them
 to operate well together. "anti-patterns" were also found, preventing layers
 from working well together.

-- 
2.51.0

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

[Quentin Schulz]

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

Re: [PATCH v2 0/2] Update yocto-check-layer documentation

[Antonin Godard]

On Fri, 19 Sep 2025 14:18:42 +0200, Antonin Godard wrote:
> 


Applied, thanks!

[1/2] dev-manual/layers.rst: yocto-check-layer: mention --machines and --dependency
      (no commit info)
[2/2] test-manual/yocto-project-compatible.rst: fix a typo
      commit: a84c234acfedfa714419006c743405e2f9acaedc

Best regards,
-- 
Antonin Godard <antonin.godard@bootlin.com>