diff mbox series

[7/8] doc: bitbake-user-manual-metadata: expand on search paths for include directive

Message ID 20260112-doc-directives-v1-7-b23923cfce89@cherry.de
State New
Headers show
Series doc: bitbake-user-manual-metadata: misc improvements on sharing functionality | expand

Commit Message

Quentin Schulz Jan. 12, 2026, 4:36 p.m. UTC 
From: Quentin Schulz <quentin.schulz@cherry.de>

While it is made somewhat explicit in the require and include directive
sections, I believe we should provide an example as to which relative
directory the include/require directives apply to when in a bbappend.

Let's provide some example to make this even clearer as it wasn't what I
thought would happen.

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
 doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
index 719689150..cbad4df99 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -1112,6 +1112,18 @@  In this case, the following paths would be searched::
 
 This time, the second item of this list would be matched.
 
+Note that the first path is based on the location of the file with the
+``require`` (or ``include``) directive. Imagine there's a
+``/layers/meta-custom2/recipes-bbappend/example/example_0.1.bbappend`` with::
+
+   require myappend.inc
+
+In this case, the following paths would be searched::
+
+   /layers/meta-custom2/recipes-bbappend/example/myappend.inc
+   /layers/meta-custom1/myappend.inc
+   /layers/meta-custom2/myappend.inc
+
 .. note::
 
    In the above examples, the exact same search order applies for the