Bug 15640 - The "inherit_defer" directive is not documented
Summary: The "inherit_defer" directive is not documented
Status: RESOLVED FIXED
Alias: None
Product: BitBake User Manual
Classification: Documentation
Component: bitbake-manual (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Medium+ normal
Target Milestone: 5.2 M2
Assignee: Antonin Godard
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2024-11-05 08:23 UTC by Yoann Congal
Modified: 2024-12-04 08:20 UTC (History)
4 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Yes (doc changes required)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Yoann Congal 2024-11-05 08:23:48 UTC
Maybe as a note in the "3.4.2 inherit Directive" section?
https://docs.yoctoproject.org/bitbake/dev/bitbake-user-manual/bitbake-user-manual-metadata.html#inherit-directive
Comment 1 Yoann Congal 2024-11-05 08:26:51 UTC
The best existing doc I could find: 
Scarthgap release notes: https://docs.yoctoproject.org/5.0.4/migration-guides/release-notes-5.0.html#new-features-enhancements-in-5-0

> BitBake improvements:
> New inherit_defer statement which works as inherit does, except that it is only evaluated at the end of parsing — recommended where a conditional expression is used, e.g.:
>    inherit_defer ${@bb.utils.contains('PACKAGECONFIG', 'python', 'python3targetconfig', '', d)}
> This allows conditional expressions to be evaluated ‘late’ meaning changes to the variable after the line is parsed will take effect - with inherit this is not the case.
Comment 2 Antonin Godard 2024-11-21 12:51:56 UTC
Patch sent on mailing list:

https://lists.openembedded.org/g/bitbake-devel/topic/bitbake_devel_patch_v2_doc/109681504

Awaiting review.
Comment 3 Antonin Godard 2024-12-04 08:20:29 UTC
We now have documentation for inherit_defer, after this commit was merged:
https://git.openembedded.org/bitbake/commit/?id=eb10df5a9619e243e28e0f4cd6122c24ed668f52

Closing this bug