summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-10-10 11:48:03 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-10-13 23:29:25 +0100
commiteedb264387e87e43a51117fbc539993f3aea5bf3 (patch)
treec79acfd52d23645f18a92048ac24864373157a4a /bitbake/doc/bitbake-user-manual
parentb2f1d21ff3d0e2f1f152a208394741dad789a623 (diff)
downloadpoky-eedb264387e87e43a51117fbc539993f3aea5bf3.tar.gz
bitbake: bitbake-user-manual: Updated the datastore functions
Fixes [YOCTO #10400] No information existed for cases when a variable did not exist. I added this information to each of the variables in the table. (Bitbake rev: 466b2c30f31754a7b6a2478e359f687ec6888e0d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc/bitbake-user-manual')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml44
1 files changed, 32 insertions, 12 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
index 53e182ba61..40f4829e6a 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
@@ -2317,7 +2317,8 @@
2317 <row> 2317 <row>
2318 <entry align="left"><filename>d.getVar("X", expand)</filename></entry> 2318 <entry align="left"><filename>d.getVar("X", expand)</filename></entry>
2319 <entry align="left">Returns the value of variable "X". 2319 <entry align="left">Returns the value of variable "X".
2320 Using "expand=True" expands the value.</entry> 2320 Using "expand=True" expands the value.
2321 Returns "None" if the variable "X" does not exist.</entry>
2321 </row> 2322 </row>
2322 <row> 2323 <row>
2323 <entry align="left"><filename>d.setVar("X", "value")</filename></entry> 2324 <entry align="left"><filename>d.setVar("X", "value")</filename></entry>
@@ -2325,24 +2326,32 @@
2325 </row> 2326 </row>
2326 <row> 2327 <row>
2327 <entry align="left"><filename>d.appendVar("X", "value")</filename></entry> 2328 <entry align="left"><filename>d.appendVar("X", "value")</filename></entry>
2328 <entry align="left">Adds "value" to the end of the variable "X".</entry> 2329 <entry align="left">Adds "value" to the end of the variable "X".
2330 Acts like <filename>d.setVar("X", "value")</filename>
2331 if the variable "X" does not exist.</entry>
2329 </row> 2332 </row>
2330 <row> 2333 <row>
2331 <entry align="left"><filename>d.prependVar("X", "value")</filename></entry> 2334 <entry align="left"><filename>d.prependVar("X", "value")</filename></entry>
2332 <entry align="left">Adds "value" to the start of the variable "X".</entry> 2335 <entry align="left">Adds "value" to the start of the variable "X".
2336 Acts like <filename>d.setVar("X", "value")</filename>
2337 if the variable "X" does not exist.</entry>
2333 </row> 2338 </row>
2334 <row> 2339 <row>
2335 <entry align="left"><filename>d.delVar("X")</filename></entry> 2340 <entry align="left"><filename>d.delVar("X")</filename></entry>
2336 <entry align="left">Deletes the variable "X" from the datastore.</entry> 2341 <entry align="left">Deletes the variable "X" from the datastore.
2342 Does nothing if the variable "X" does not exist.</entry>
2337 </row> 2343 </row>
2338 <row> 2344 <row>
2339 <entry align="left"><filename>d.renameVar("X", "Y")</filename></entry> 2345 <entry align="left"><filename>d.renameVar("X", "Y")</filename></entry>
2340 <entry align="left">Renames the variable "X" to "Y".</entry> 2346 <entry align="left">Renames the variable "X" to "Y".
2347 Does nothing if the variable "X" does not exist.</entry>
2341 </row> 2348 </row>
2342 <row> 2349 <row>
2343 <entry align="left"><filename>d.getVarFlag("X", flag, expand)</filename></entry> 2350 <entry align="left"><filename>d.getVarFlag("X", flag, expand)</filename></entry>
2344 <entry align="left">Returns the value of variable "X". 2351 <entry align="left">Returns the value of variable "X".
2345 Using "expand=True" expands the value.</entry> 2352 Using "expand=True" expands the value.
2353 Returns "None" if either the variable "X" or the named flag
2354 does not exist.</entry>
2346 </row> 2355 </row>
2347 <row> 2356 <row>
2348 <entry align="left"><filename>d.setVarFlag("X", flag, "value")</filename></entry> 2357 <entry align="left"><filename>d.setVarFlag("X", flag, "value")</filename></entry>
@@ -2351,12 +2360,16 @@
2351 <row> 2360 <row>
2352 <entry align="left"><filename>d.appendVarFlag("X", flag, "value")</filename></entry> 2361 <entry align="left"><filename>d.appendVarFlag("X", flag, "value")</filename></entry>
2353 <entry align="left">Appends "value" to the named flag on the 2362 <entry align="left">Appends "value" to the named flag on the
2354 variable "X".</entry> 2363 variable "X".
2364 Acts like <filename>d.setVarFlag("X", flag, "value")</filename>
2365 if the named flag does not exist.</entry>
2355 </row> 2366 </row>
2356 <row> 2367 <row>
2357 <entry align="left"><filename>d.prependVarFlag("X", flag, "value")</filename></entry> 2368 <entry align="left"><filename>d.prependVarFlag("X", flag, "value")</filename></entry>
2358 <entry align="left">Prepends "value" to the named flag on 2369 <entry align="left">Prepends "value" to the named flag on
2359 the variable "X".</entry> 2370 the variable "X".
2371 Acts like <filename>d.setVarFlag("X", flag, "value")</filename>
2372 if the named flag does not exist.</entry>
2360 </row> 2373 </row>
2361 <row> 2374 <row>
2362 <entry align="left"><filename>d.delVarFlag("X", flag)</filename></entry> 2375 <entry align="left"><filename>d.delVarFlag("X", flag)</filename></entry>
@@ -2372,16 +2385,23 @@
2372 </row> 2385 </row>
2373 <row> 2386 <row>
2374 <entry align="left"><filename>d.getVarFlags("X")</filename></entry> 2387 <entry align="left"><filename>d.getVarFlags("X")</filename></entry>
2375 <entry align="left">Returns a <filename>flagsdict</filename> of the flags for 2388 <entry align="left">Returns a <filename>flagsdict</filename>
2376 the variable "X".</entry> 2389 of the flags for the variable "X".
2390 Returns "None" if the variable "X" does not exist.</entry>
2377 </row> 2391 </row>
2378 <row> 2392 <row>
2379 <entry align="left"><filename>d.delVarFlags("X")</filename></entry> 2393 <entry align="left"><filename>d.delVarFlags("X")</filename></entry>
2380 <entry align="left">Deletes all the flags for the variable "X".</entry> 2394 <entry align="left">Deletes all the flags for the variable "X".
2395 Does nothing if the variable "X" does not exist.</entry>
2381 </row> 2396 </row>
2382 <row> 2397 <row>
2383 <entry align="left"><filename>d.expand(expression)</filename></entry> 2398 <entry align="left"><filename>d.expand(expression)</filename></entry>
2384 <entry align="left">Expands variable references in the specified string expression.</entry> 2399 <entry align="left">Expands variable references in the specified
2400 string expression.
2401 References to variables that do not exist are left as is.
2402 For example, <filename>d.expand("foo ${X}")</filename>
2403 expands to the literal string "foo ${X}" if the
2404 variable "X" does not exist.</entry>
2385 </row> 2405 </row>
2386 </tbody> 2406 </tbody>
2387 </tgroup> 2407 </tgroup>