sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

bitbake: bitbake-user-manual: New section on functions you can call from Python 

Fixes [YOCTO #10100]

I added a new parent directory named "Functions You Can Call From
Within Python".  This section contains a couple new sub-sections.
One is the existing "Functions for Accessing Datastore Variables".
The other is called "Other Functions", and it is used to point
or reference some commonly used functions that the user can call
from within Python.

(Bitbake rev: ecbcedd74125ef00599f4af384ee303dae8af5b7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2016-09-07 07:52:26 -07:00 committed by Richard Purdie
parent 5503ed14ed
commit 39828d3ccc
1 changed files with 120 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

212
bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
View File

@ -1228,7 +1228,7 @@
</literallayout> </literallayout>
For methods you can use with anonymous Python functions, For methods you can use with anonymous Python functions,
see the see the
"<link linkend='accessing-datastore-variables-using-python'>Accessing Datastore Variables Using Python</link>" "<link linkend='functions-you-can-call-from-within-python'>Functions You Can Call From Within Python</link>"
section. section.
For a different method to run Python code during parsing, For a different method to run Python code during parsing,
see the see the
@ -2082,102 +2082,130 @@
</section> </section>
</section> </section>
<section id='accessing-datastore-variables-using-python'> <section id='functions-you-can-call-from-within-python'>
<title>Accessing Datastore Variables Using Python</title> <title>Functions You Can Call From Within Python</title>
<para> <para>
It is often necessary to access variables in the BitBake provides many functions you can call from
BitBake datastore using Python functions. within Python functions.
The Bitbake datastore has an API that allows you this This section lists the most commonly used functions,
access. and mentions where to find others.
Here is a list of available operations:
</para> </para>
<para> <section id='functions-for-accessing-datastore-variables'>
<informaltable frame='none'> <title>Functions for Accessing Datastore Variables</title>
<tgroup cols='2' align='left' colsep='1' rowsep='1'>
<colspec colname='c1' colwidth='1*'/> <para>
<colspec colname='c2' colwidth='1*'/> It is often necessary to access variables in the
<thead> BitBake datastore using Python functions.
<row> The Bitbake datastore has an API that allows you this
<entry align="left"><emphasis>Operation</emphasis></entry> access.
<entry align="left"><emphasis>Description</emphasis></entry> Here is a list of available operations:
</row> </para>
</thead>
<tbody> <para>
<row> <informaltable frame='none'>
<entry align="left"><filename>d.getVar("X", expand)</filename></entry> <tgroup cols='2' align='left' colsep='1' rowsep='1'>
<entry align="left">Returns the value of variable "X". <colspec colname='c1' colwidth='1*'/>
Using "expand=True" expands the value.</entry> <colspec colname='c2' colwidth='1*'/>
</row> <thead>
<row> <row>
<entry align="left"><filename>d.setVar("X", "value")</filename></entry> <entry align="left"><emphasis>Operation</emphasis></entry>
<entry align="left">Sets the variable "X" to "value".</entry> <entry align="left"><emphasis>Description</emphasis></entry>
</row> </row>
<row> </thead>
<entry align="left"><filename>d.appendVar("X", "value")</filename></entry> <tbody>
<entry align="left">Adds "value" to the end of the variable "X".</entry> <row>
</row> <entry align="left"><filename>d.getVar("X", expand)</filename></entry>
<row> <entry align="left">Returns the value of variable "X".
<entry align="left"><filename>d.prependVar("X", "value")</filename></entry>
<entry align="left">Adds "value" to the start of the variable "X".</entry>
</row>
<row>
<entry align="left"><filename>d.delVar("X")</filename></entry>
<entry align="left">Deletes the variable "X" from the datastore.</entry>
</row>
<row>
<entry align="left"><filename>d.renameVar("X", "Y")</filename></entry>
<entry align="left">Renames the variable "X" to "Y".</entry>
</row>
<row>
<entry align="left"><filename>d.getVarFlag("X", flag, expand)</filename></entry>
<entry align="left">Returns the value of variable "X".
Using "expand=True" expands the value.</entry> Using "expand=True" expands the value.</entry>
</row> </row>
<row> <row>
<entry align="left"><filename>d.setVarFlag("X", flag, "value")</filename></entry> <entry align="left"><filename>d.setVar("X", "value")</filename></entry>
<entry align="left">Sets the named flag for variable "X" to "value".</entry> <entry align="left">Sets the variable "X" to "value".</entry>
</row> </row>
<row> <row>
<entry align="left"><filename>d.appendVarFlag("X", flag, "value")</filename></entry> <entry align="left"><filename>d.appendVar("X", "value")</filename></entry>
<entry align="left">Appends "value" to the named flag on the <entry align="left">Adds "value" to the end of the variable "X".</entry>
variable "X".</entry> </row>
</row> <row>
<row> <entry align="left"><filename>d.prependVar("X", "value")</filename></entry>
<entry align="left"><filename>d.prependVarFlag("X", flag, "value")</filename></entry> <entry align="left">Adds "value" to the start of the variable "X".</entry>
<entry align="left">Prepends "value" to the named flag on </row>
the variable "X".</entry> <row>
</row> <entry align="left"><filename>d.delVar("X")</filename></entry>
<row> <entry align="left">Deletes the variable "X" from the datastore.</entry>
<entry align="left"><filename>d.delVarFlag("X", flag)</filename></entry> </row>
<entry align="left">Deletes the named flag on the variable <row>
"X" from the datastore.</entry> <entry align="left"><filename>d.renameVar("X", "Y")</filename></entry>
</row> <entry align="left">Renames the variable "X" to "Y".</entry>
<row> </row>
<entry align="left"><filename>d.setVarFlags("X", flagsdict)</filename></entry> <row>
<entry align="left">Sets the flags specified in <entry align="left"><filename>d.getVarFlag("X", flag, expand)</filename></entry>
the <filename>flagsdict()</filename> parameter. <entry align="left">Returns the value of variable "X".
<filename>setVarFlags</filename> does not clear previous flags. Using "expand=True" expands the value.</entry>
Think of this operation as <filename>addVarFlags</filename>.</entry> </row>
</row> <row>
<row> <entry align="left"><filename>d.setVarFlag("X", flag, "value")</filename></entry>
<entry align="left"><filename>d.getVarFlags("X")</filename></entry> <entry align="left">Sets the named flag for variable "X" to "value".</entry>
<entry align="left">Returns a <filename>flagsdict</filename> of the flags for </row>
the variable "X".</entry> <row>
</row> <entry align="left"><filename>d.appendVarFlag("X", flag, "value")</filename></entry>
<row> <entry align="left">Appends "value" to the named flag on the
<entry align="left"><filename>d.delVarFlags("X")</filename></entry> variable "X".</entry>
<entry align="left">Deletes all the flags for the variable "X".</entry> </row>
</row> <row>
<row> <entry align="left"><filename>d.prependVarFlag("X", flag, "value")</filename></entry>
<entry align="left"><filename>d.expand(expression)</filename></entry> <entry align="left">Prepends "value" to the named flag on
<entry align="left">Expands variable references in the specified string expression.</entry> the variable "X".</entry>
</row> </row>
</tbody> <row>
</tgroup> <entry align="left"><filename>d.delVarFlag("X", flag)</filename></entry>
</informaltable> <entry align="left">Deletes the named flag on the variable
</para> "X" from the datastore.</entry>
</row>
<row>
<entry align="left"><filename>d.setVarFlags("X", flagsdict)</filename></entry>
<entry align="left">Sets the flags specified in
the <filename>flagsdict()</filename> parameter.
<filename>setVarFlags</filename> does not clear previous flags.
Think of this operation as <filename>addVarFlags</filename>.</entry>
</row>
<row>
<entry align="left"><filename>d.getVarFlags("X")</filename></entry>
<entry align="left">Returns a <filename>flagsdict</filename> of the flags for
the variable "X".</entry>
</row>
<row>
<entry align="left"><filename>d.delVarFlags("X")</filename></entry>
<entry align="left">Deletes all the flags for the variable "X".</entry>
</row>
<row>
<entry align="left"><filename>d.expand(expression)</filename></entry>
<entry align="left">Expands variable references in the specified string expression.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section>
<section id='other-functions'>
<title>Other Functions</title>
<para>
You can find many other functions that can be called
from Python by looking at the source code of the
<filename>bb</filename> module, which is in
<filename>bitbake/lib/bb</filename>.
For example,
<filename>bitbake/lib/bb/utils.py</filename> includes
the commonly used functions
<filename>bb.utils.contains()</filename> and
<filename>bb.utils.mkdirhier()</filename>, which come
with docstrings.
</para>
</section>
</section> </section>
<section id='task-checksums-and-setscene'> <section id='task-checksums-and-setscene'>