diff mbox series

[v3,1/3] dev-manual/layers.rst: yocto-check-layer: mention --machines and --dependency

Message ID 20250926-update-compatible-doc-v3-1-3740c44e49b2@bootlin.com
State Under Review
Headers show
Series Update yocto-check-layer documentation | expand

Commit Message

Antonin Godard Sept. 26, 2025, 7:54 a.m. UTC 
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 mbox series

Patch

diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst
index fbf3f1a33..4224a02b2 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.
 
+You should 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
+
+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.
+
 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: