diff mbox series

doc: document dependency tracking associated with addpylib

Message ID 1791793541.8631fc262581453bbf619ec5b2062170.1a12f37b16e00080d7@vates.tech
State New
Headers show
Series doc: document dependency tracking associated with addpylib | expand

Commit Message

Yann Dirson Oct. 12, 2026, 8:25 a.m. UTC
Reported-by: Claude Opus 5.5
Signed-off-by: Yann Dirson <yann.dirson@vates.tech>
---
 doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Antonin Godard Oct. 12, 2026, 1:08 p.m. UTC | #1
Hi,

On Mon Oct 12, 2026 at 10:25 AM CEST, Yann Dirson via lists.openembedded.org wrote:
> Reported-by: Claude Opus 5.5
> Signed-off-by: Yann Dirson <yann.dirson@vates.tech>
> ---
>  doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
>
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> index 621aab253..eef1f9624 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> @@ -2264,6 +2264,14 @@ The specified <namespace> is imported automatically, and if the imported
>  module specifies an attribute named ``BBIMPORTS``, that list of
>  sub-modules is iterated and imported too.
>  
> +Additionally, Bitbake will detect usage of functions from such a
> +library and include them in task hashes, so changes in those functions
> +trigger task rebuilds.  Note that only functions inside modules
> +declared using ``BBIMPORTS`` benefit from this dependency tracking,
> +any name defined directly in the specified namespace (e.g. in
> +`<namespace>/__init__.py`, or in a library hat would be defined as

s/hat/that/

> +`<namespace>.py`) would *not* benefit from this tracking.

Otherwise, this is clear to me. I did not know about this limitation/feature,
and this is definitely important to document, thanks!

Antonin
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 621aab253..eef1f9624 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -2264,6 +2264,14 @@  The specified <namespace> is imported automatically, and if the imported
 module specifies an attribute named ``BBIMPORTS``, that list of
 sub-modules is iterated and imported too.
 
+Additionally, Bitbake will detect usage of functions from such a
+library and include them in task hashes, so changes in those functions
+trigger task rebuilds.  Note that only functions inside modules
+declared using ``BBIMPORTS`` benefit from this dependency tracking,
+any name defined directly in the specified namespace (e.g. in
+`<namespace>/__init__.py`, or in a library hat would be defined as
+`<namespace>.py`) would *not* benefit from this tracking.
+
 Testing and Debugging BitBake Python code
 -----------------------------------------