From 72a01a54c4786a7a82ae8b86b8e2beedd07f7f21 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 22 Jan 2014 08:25:28 -0600 Subject: [PATCH] user-manual-ref-variables.xml: Added 10 new variables to the glossary. Fixes [YOCTO #5472] 1. ASSUME_PROVIDED 2. BB_CURRENTTASK 3. BB_FETCH_PREMIRRORONLY 4. BB_FILENAME 5. BB_NICE_LEVEL 6. BB_HASHCONFIG_WHITELIST 7. BB_TASK_NICE_LEVEL 8. BB_NO_NETWORK 9. BB_NUMBER_PARSE_THREADS 10. STAMPCLEAN Signed-off-by: Scott Rifenbark --- doc/user-manual/user-manual-ref-variables.xml | 163 +++++++++++++++++- 1 file changed, 158 insertions(+), 5 deletions(-) diff --git a/doc/user-manual/user-manual-ref-variables.xml b/doc/user-manual/user-manual-ref-variables.xml index dc1fb9b197a..baee024ccac 100644 --- a/doc/user-manual/user-manual-ref-variables.xml +++ b/doc/user-manual/user-manual-ref-variables.xml @@ -14,9 +14,8 @@ - - + A B D @@ -44,11 +43,30 @@ - - + B @@ -61,6 +79,16 @@ + BB_CURRENTTASK + + + Contains the name of the currently running task. + The name does not include the + do_ prefix. + + + + BB_DANGLINGAPPENDS_WARNONLY @@ -239,6 +267,34 @@ + BB_FETCH_PREMIRRORONLY + + + When set to "1", causes BitBake's fetcher module to only + search + PREMIRRORS + for files. + BitBake will not search the main + SRC_URI + or + MIRRORS. + + + + + BB_FILENAME + + + Contains the filename of the recipe that owns the currently + running task. + For example, if the do_fetch task that + resides in the my-recipe.bb is + executing, the BB_FILENAME variable + contains "/foo/path/my-recipe.bb". + + + + BB_GENERATE_MIRROR_TARBALLS @@ -258,6 +314,69 @@ + BB_HASHCONFIG_WHITELIST + + + A list of variables that BitBake excludes from checksum + comparisons. + + + + One of the ways BitBake determines whether to re-parse the + main metadata is by using a checksum of the variables in + the datastore of the base configuration data. + There are variables that you typically want to exclude from + these checksum comparisons. + As an example, you would usually exclude + TIME and DATE + because these variables are always changing. + If you did not exclude them, BitBake would never use the + cache. + + + + + BB_NICE_LEVEL + + + Allows BitBake to run at a specific priority + (i.e. nice level). + System permissions usually mean that BitBake can reduce its + priority but not raise it again. + See + BB_TASK_NICE_LEVEL + for additional information. + + + + + BB_NO_NETWORK + + + Disables network access in the BitBake fetcher modules. + With this access disabled, any command that attempts to + access the network becomes an error. + + + + Disabling network access is useful for testing source + mirrors, running builds when not connected to the Internet, + and when operating in certain kinds of firewall + environments. + + + + + BB_NUMBER_PARSE_THREADS + + + Sets the number of threads BitBake uses when parsing. + By default, the number of threads is equal to the number + of cores on the system. + + + + BB_NUMBER_THREADS The maximum number of tasks BitBake should run in parallel at any one time. @@ -266,6 +385,25 @@ + BB_TASK_NICE_LEVEL + + + Allows specific tasks to change their priority + (i.e. nice level). + + + + You can use this variable in combination with task + overrides to raise or lower priorities of specific tasks. + For example, on the + Yocto Project + autobuilder, QEMU emulation in images is given a higher + priority as compared to build tasks to ensure that images + do not suffer timeouts on loaded systems. + + + + BBCLASSEXTEND @@ -1261,6 +1399,21 @@ + STAMPCLEAN + + + Specifies the base path used to create recipe stamp files. + Unlike the + STAMP + variable, STAMPCLEAN can contain + wildcards to match the range of files a clean operation + should remove. + BitBake uses a clean operation to remove any other stamps + it should be removing when creating a new stamp. + + + + SUMMARY -- 2.47.3