summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-02-23 09:18:08 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-03-03 17:33:59 +0000
commit4ebe55cb8c8db1c5cf5d127e213487c5a453a68a (patch)
tree1979a37b264a1f77c8748d46affe873a3626ef9a /doc
parent91cb52b1e77bba9d046239933b5c0513d01e6824 (diff)
downloadbitbake-contrib-4ebe55cb8c8db1c5cf5d127e213487c5a453a68a.tar.gz
bitbake-user-manual: Added note for Python variable ref expansion.
Fixes [YOCTO #9148] Added a note about Variable expressions (e.g. ${X}) are no longer expanded within Python functions. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-metadata.xml12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
index cfa85b379..359df8f75 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
@@ -840,6 +840,18 @@
is a global variable and is always automatically
available.
</para>
+
+ <note>
+ Variable expressions (e.g. <filename>${X}</filename>) are no
+ longer expanded within Python functions.
+ This behavior is intentional in order to allow you to freely
+ set variable values to expandable expressions without having
+ them expanded prematurely.
+ If you do wish to expand a variable within a Python function,
+ use <filename>d.getVar("X", True)</filename>.
+ Or, for more complicated expressions, use
+ <filename>d.expand()</filename>.
+ </note>
</section>
<section id='python-functions'>