From 1d9c02e878937b1bb35cf44c5f0291400ef485ba Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 10 Feb 2014 20:25:53 -0600 Subject: bitbake: user-manual-metadata.xml: Rewrite "Accessing Datastore Variables Using Python" Rewrote this section. Used a table instead of the funky list that was there. I still need to format it some. Also fixed up the term "datastore". It should not be "data store" (Bitbake rev: ee23839596102ccd58e028c10471438f2eb37feb) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- bitbake/doc/user-manual/user-manual-metadata.xml | 152 +++++++++++++---------- 1 file changed, 87 insertions(+), 65 deletions(-) (limited to 'bitbake/doc/user-manual/user-manual-metadata.xml') diff --git a/bitbake/doc/user-manual/user-manual-metadata.xml b/bitbake/doc/user-manual/user-manual-metadata.xml index 80e5b648db..a7d9209560 100644 --- a/bitbake/doc/user-manual/user-manual-metadata.xml +++ b/bitbake/doc/user-manual/user-manual-metadata.xml @@ -369,7 +369,7 @@ Key Expansion - Key expansion happens when the BitBake data store is finalized + Key expansion happens when the BitBake datastore is finalized just before BitBake expands overrides. To better understand this, consider the following example: @@ -1640,72 +1640,94 @@ -
- Accessing Variables and the Data Store from Python +
+ Accessing Datastore Variables Using Python - It is often necessary to manipulate variables within python functions - and the Bitbake data store has an API which allows this. - The operations available are: - - d.getVar("X", expand=False) - - returns the value of variable "X", expanding the value - if specified. - - d.setVar("X", value) - - sets the value of "X" to "value". - - d.appendVar("X", value) - - adds "value" to the end of variable X. - - d.prependVar("X", value) - - adds "value" to the start of variable X. - - d.delVar("X") - - deletes the variable X from the data store. - - d.renameVar("X", "Y") - - renames variable X to Y. - - d.getVarFlag("X", flag, expand=False) - - gets given flag from variable X but does not expand it. - - d.setVarFlag("X", flag, value) - - sets given flag for variable X to value. - setVarFlags will not clear previous flags. - Think of this method as addVarFlags. - - d.appendVarFlag("X", flag, value) - - Need description. - - d.prependVarFlag("X", flag, value) - - Need description. - - d.delVarFlag("X", flag) - - Need description. - - d.setVarFlags("X", flagsdict) - - sets the flags specified in the dict() parameter. - - d.getVarFlags("X") - - returns a dict of the flags for X. - - d.delVarFlags - - deletes all the flags for a variable. + It is often necessary to access variables in the + BitBake datastore using Python functions. + The Bitbake datastore has an API that allows you this + access. + Here is a list of available operations: + + + + + + + + + + Operation + Description + + + + + d.getVar("X", expand=False) + Returns the value of variable "X". + Using "expand=True" expands the value. + + + d.setVar("X", value) + Sets the variable "X" to "value". + + + d.appendVar("X", value) + Adds "value" to the end of the variable "X". + + + d.prependVar("X", value) + Adds "value" to the start of the variable "X". + + + d.delVar("X") + Deletes the variable "X" from the datastore. + + + d.renameVar("X", "Y") + Renames the variable "X" to "Y". + + + d.getVarFlag("X", flag, expand=False) + Gets "flag" from the variable "X". + Using "expand=True" expands the flag. + + + d.setVarFlag("X", flag, value) + Sets "flag" for variable "X" to "value". + setVarFlags does not clear previous flags. + Think of this operation as addVarFlags. + + + d.appendVarFlag("X", flag, value) + Need description. + + + d.prependVarFlag("X", flag, value) + Need description. + + + d.delVarFlag("X", flag) + Need description. + + + d.setVarFlags("X", flagsdict) + Sets the flags specified in + the dict() parameter. + + + d.getVarFlags("X") + Returns a dict of the flags for + the variable "X". + + + d.delVarFlags + Deletes all the flags for a variable. + + + +
-- cgit v1.2.3-54-g00ecf