diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-01-22 08:25:28 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-01-27 21:03:26 +0000 |
commit | 52801925554191efce8c20a98cd5cf5e8488977b (patch) | |
tree | a98d09baa9994019eb4c2d637d36c71859eaa4a4 /bitbake/doc | |
parent | 6201d18b79cc8e024d5d551818cfe81b23b6bca9 (diff) | |
download | ast2050-yocto-poky-52801925554191efce8c20a98cd5cf5e8488977b.zip ast2050-yocto-poky-52801925554191efce8c20a98cd5cf5e8488977b.tar.gz |
bitbake: 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
(Bitbake rev: 72a01a54c4786a7a82ae8b86b8e2beedd07f7f21)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc')
-rw-r--r-- | bitbake/doc/user-manual/user-manual-ref-variables.xml | 163 |
1 files changed, 158 insertions, 5 deletions
diff --git a/bitbake/doc/user-manual/user-manual-ref-variables.xml b/bitbake/doc/user-manual/user-manual-ref-variables.xml index dc1fb9b..baee024 100644 --- a/bitbake/doc/user-manual/user-manual-ref-variables.xml +++ b/bitbake/doc/user-manual/user-manual-ref-variables.xml @@ -14,9 +14,8 @@ <glossary id='ref-variables-glossary'> - <para> -<!-- <link linkend='var-ALLOW_EMPTY'>A</link> --> + <link linkend='var-ASSUME_PROVIDED'>A</link> <link linkend='var-B'>B</link> <!-- <link linkend='var-CFLAGS'>C</link> --> <link linkend='var-DEFAULT_PREFERENCE'>D</link> @@ -44,11 +43,30 @@ <!-- <link linkend='var-glossary-z'>Z</link>--> </para> - -<!-- <glossdiv id='var-glossary-a'><title>A</title> + + <glossentry id='var-ASSUME_PROVIDED'><glossterm>ASSUME_PROVIDED</glossterm> + <glossdef> + <para> + Recipe names + (<link linkend='var-PN'><filename>PN</filename></link> + values) BitBake does not attempt to build. + Instead, BitBake assumes these recipes have already been + built. + </para> + + <para> + <filename>ASSUMED_PROVIDED</filename> often specifies + native tools. + A good example is <filename>git-native</filename>, which + allows for the the Git binary from the host to be used + rather than building <filename>git-native</filename>. + </para> + </glossdef> + </glossentry> + </glossdiv> ---> + <glossdiv id='var-glossary-b'><title>B</title> @@ -61,6 +79,16 @@ </glossdef> </glossentry> + <glossentry id='var-BB_CURRENTTASK'><glossterm>BB_CURRENTTASK</glossterm> + <glossdef> + <para> + Contains the name of the currently running task. + The name does not include the + <filename>do_</filename> prefix. + </para> + </glossdef> + </glossentry> + <glossentry id='var-BB_DANGLINGAPPENDS_WARNONLY'><glossterm>BB_DANGLINGAPPENDS_WARNONLY</glossterm> <glossdef> <para> @@ -239,6 +267,34 @@ </glossdef> </glossentry> + <glossentry id='var-BB_FETCH_PREMIRRORONLY'><glossterm>BB_FETCH_PREMIRRORONLY</glossterm> + <glossdef> + <para> + When set to "1", causes BitBake's fetcher module to only + search + <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> + for files. + BitBake will not search the main + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + or + <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BB_FILENAME'><glossterm>BB_FILENAME</glossterm> + <glossdef> + <para> + Contains the filename of the recipe that owns the currently + running task. + For example, if the <filename>do_fetch</filename> task that + resides in the <filename>my-recipe.bb</filename> is + executing, the <filename>BB_FILENAME</filename> variable + contains "/foo/path/my-recipe.bb". + </para> + </glossdef> + </glossentry> + <glossentry id='var-BB_GENERATE_MIRROR_TARBALLS'><glossterm>BB_GENERATE_MIRROR_TARBALLS</glossterm> <glossdef> <para> @@ -258,6 +314,69 @@ </glossdef> </glossentry> + <glossentry id='var-BB_HASHCONFIG_WHITELIST'><glossterm>BB_HASHCONFIG_WHITELIST</glossterm> + <glossdef> + <para> + A list of variables that BitBake excludes from checksum + comparisons. + </para> + + <para> + 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 + <filename>TIME</filename> and <filename>DATE</filename> + because these variables are always changing. + If you did not exclude them, BitBake would never use the + cache. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BB_NICE_LEVEL'><glossterm>BB_NICE_LEVEL</glossterm> + <glossdef> + <para> + 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 + <link linkend='var-BB_TASK_NICE_LEVEL'><filename>BB_TASK_NICE_LEVEL</filename></link> + for additional information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BB_NO_NETWORK'><glossterm>BB_NO_NETWORK</glossterm> + <glossdef> + <para> + Disables network access in the BitBake fetcher modules. + With this access disabled, any command that attempts to + access the network becomes an error. + </para> + + <para> + 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. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BB_NUMBER_PARSE_THREADS'><glossterm>BB_NUMBER_PARSE_THREADS</glossterm> + <glossdef> + <para> + 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. + </para> + </glossdef> + </glossentry> + <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm> <glossdef> <para>The maximum number of tasks BitBake should run in parallel at any one time. @@ -266,6 +385,25 @@ </glossdef> </glossentry> + <glossentry id='var-BB_TASK_NICE_LEVEL'><glossterm>BB_TASK_NICE_LEVEL</glossterm> + <glossdef> + <para> + Allows specific tasks to change their priority + (i.e. nice level). + </para> + + <para> + You can use this variable in combination with task + overrides to raise or lower priorities of specific tasks. + For example, on the + <ulink url='http://www.yoctoproject.org'>Yocto Project</ulink> + 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. + </para> + </glossdef> + </glossentry> + <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm> <glossdef> <para> @@ -1261,6 +1399,21 @@ </glossdef> </glossentry> + <glossentry id='var-STAMPCLEAN'><glossterm>STAMPCLEAN</glossterm> + <glossdef> + <para> + Specifies the base path used to create recipe stamp files. + Unlike the + <link linkend='var-STAMP'><filename>STAMP</filename></link> + variable, <filename>STAMPCLEAN</filename> 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. + </para> + </glossdef> + </glossentry> + <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm> <glossdef> <para> |