[oe-commits] [bitbake] 02/03: bitbake-user-manual: Added note for Python variable ref expansion.

[git at git.openembedded.org]

rpurdie pushed a commit to branch master
in repository bitbake.

commit 4ebe55cb8c8db1c5cf5d127e213487c5a453a68a
Author: Scott Rifenbark <srifenbark at gmail.com>
AuthorDate: Tue Feb 23 09:18:08 2016 -0800

    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 at gmail.com>
---
 doc/bitbake-user-manual/bitbake-user-manual-metadata.xml | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
index cfa85b3..359df8f 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'>

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.