diff mbox series

bitbake-user-manual: details about variable flags starting with underscore

Message ID 20220921133118.109417-1-michael.opdenacker@bootlin.com
State Accepted, archived
Commit 0f3e9d87168813ce49995ff04bccdce11c5f7b47
Headers show
Series bitbake-user-manual: details about variable flags starting with underscore | expand

Commit Message

Michael Opdenacker Sept. 21, 2022, 1:31 p.m. UTC 
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Fixes [YOCTO #14140]

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 6 ++++++
 1 file changed, 6 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 33782161..94e457f3 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -421,6 +421,12 @@  documentation to a BitBake variable as follows::
 
    CACHE[doc] = "The directory holding the cache of the metadata."
 
+.. note::
+
+   Variable flag names starting with an underscore (``_``) character
+   are allowed but are ignored by ``d.getVarFlags("VAR")``
+   in Python code. Such flag names are used internally by BitBake.
+
 Inline Python Variable Expansion
 --------------------------------