diff mbox series

[v2] doc/bitbake-user-manual-ref-variables: improve INHERIT

Message ID 20251006161849.37351-1-adam.blank.g@gmail.com
State New
Headers show
Series [v2] doc/bitbake-user-manual-ref-variables: improve INHERIT | expand

Commit Message

Adam Blank Oct. 6, 2025, 4:18 p.m. UTC 
Current wording makes it difficult to understand what
exactly is done with INHERIT-ed anonymous functions and
when.

Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
---
Changes in v2:
- Added reference to Parsing The Base Configuration Metadata
- Emphasised how disjoint the cases are

---
 .../bitbake-user-manual-ref-variables.rst         | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)


       For more information on :term:`INHERIT`, see the
       ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`"
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index 810f88689..06d48dd47 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -1200,6 +1200,15 @@  overview of their function and contents.

    :term:`INHERIT`
       Causes the named class or classes to be inherited globally. Anonymous
-      functions in the class or classes are not executed for the base
-      configuration and in each individual recipe. The OpenEmbedded build
-      system ignores changes to :term:`INHERIT` in individual recipes.
+      functions in the class or classes are executed in two disjoint situations:
+
+      - When only the
+	:ref:`base configuration <bitbake-user-manual/bitbake-user-manual-execution:parsing the base configuration metadata>`
+	is parsed as a result of the following BitBake invocation::
+
+	  $ bitbake -e
+
+      - When recipes are parsed - then for each parsed recipe.
+
+      The OpenEmbedded build system ignores changes to :term:`INHERIT`
+      in individual recipes.