diff mbox series

[master-next] bitbake-user-manual-environment-setup: Document "{THISDIR}" in bb-layers

Message ID 20251105232718.2801446-1-yoann.congal@smile.fr
State New
Headers show
Series [master-next] bitbake-user-manual-environment-setup: Document "{THISDIR}" in bb-layers | expand

Commit Message

Yoann Congal Nov. 5, 2025, 11:27 p.m. UTC 
From: Yoann Congal <yoann.congal@smile.fr>

A "bb-layers" element can either:
* start with "{THISDIR}/meta-xxx", then "meta-xxx" is found relative to
  the configuration file,
* or not, the layer is found where bitbake-setup has cloned
  the layer from the "sources" list (usually a layers/ directory)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Cc: Antonin Godard <antonin.godard@bootlin.com>
---
 .../bitbake-user-manual-environment-setup.rst                  | 3 +++
 1 file changed, 3 insertions(+)
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
index ad8143711..d9b7492b9 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
@@ -593,6 +593,9 @@  These files are written in the JSON file format and are stored in a
       variables to include in :term:`BB_ENV_PASSTHROUGH_ADDITIONS`.
 
    -  ``bb-layers`` (*optional*): Layers to add to the ``bblayers.conf`` file.
+      If the path starts by ``{THISDIR}/``, it will be relative to the directory
+      containing the configuration file. If not, it will be relative to the
+      directory used by ``bitbake-setup`` to store the sources.
       This cannot be used in conjunction with the ``oe-template`` option.
 
    -  ``oe-template`` (*optional*, OpenEmbedded specific): OpenEmbedded template