From: Antonin Godard <antonin.godard@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
Quentin Schulz <quentin.schulz@cherry.de>
Subject: [PATCH v2 1/2] dev-manual/layers.rst: yocto-check-layer: mention --machines and --dependency
Date: Fri, 19 Sep 2025 14:18:43 +0200 [thread overview]
Message-ID: <20250919-update-compatible-doc-v2-1-c428da260487@bootlin.com> (raw)
In-Reply-To: <20250919-update-compatible-doc-v2-0-c428da260487@bootlin.com>
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
next prev parent reply other threads:[~2025-09-19 12:19 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-19 12:18 [PATCH v2 0/2] Update yocto-check-layer documentation Antonin Godard
2025-09-19 12:18 ` Antonin Godard [this message]
2025-09-19 12:45 ` [PATCH v2 1/2] dev-manual/layers.rst: yocto-check-layer: mention --machines and --dependency Quentin Schulz
2025-09-19 12:18 ` [PATCH v2 2/2] test-manual/yocto-project-compatible.rst: fix a typo Antonin Godard
2025-09-29 6:44 ` [PATCH v2 0/2] Update yocto-check-layer documentation Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250919-update-compatible-doc-v2-1-c428da260487@bootlin.com \
--to=antonin.godard@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=quentin.schulz@cherry.de \
--cc=thomas.petazzoni@bootlin.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox