mirror of
https://git.yoctoproject.org/poky
synced 2026-05-05 20:27:58 +02:00
bitbake: user-manual-ref-variables.xml: Added 11 new variables to glossary.
SRCREV_FORMAT BUILDNAME BB_ENV_WHITELIST BB_PRESERVE_ENV BB_ENV_EXTRAWHITE BB_ORIGENV BB_TASKHASH BITBAKE_UI BBDUBUG BB_DEFAULT_TASK BBINCLUDED (Bitbake rev: 0e3106bfdebfa255b2db08a8a4585516d8bebe20) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
committed by
Richard Purdie
Richard Purdie
parent
081d31c6bc
commit
ddcd91c6d6
@@ -112,6 +112,17 @@
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BB_DEFAULT_TASK'><glossterm>BB_DEFAULT_TASK</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
The default task to use when none is specified (e.g.
|
||||
with the <filename>-c</filename> command line option).
|
||||
The task name specified should not include the
|
||||
<filename>do_</filename> prefix.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BB_DISKMON_DIRS'><glossterm>BB_DISKMON_DIRS</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
@@ -267,6 +278,44 @@
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BB_ENV_WHITELIST'><glossterm>BB_ENV_WHITELIST</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
Specifies the internal whitelist of variables to allow
|
||||
through from the external environment into BitBake's
|
||||
datastore.
|
||||
If the value of this variable is not specified
|
||||
(which is the default), the following list is used:
|
||||
<link linkend='var-BBPATH'><filename>BBPATH</filename></link>,
|
||||
<link linkend='var-BB_PRESERVE_ENV'><filename>BB_PRESERVE_ENV</filename></link>,
|
||||
<link linkend='var-BB_ENV_WHITELIST'><filename>BB_ENV_WHITELIST</filename></link>,
|
||||
and
|
||||
<link linkend='var-BB_ENV_EXTRAWHITE'><filename>BB_ENV_EXTRAWHITE</filename></link>.
|
||||
<note>
|
||||
You must set this variable in the external environment
|
||||
in order for it to work.
|
||||
</note>
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BB_ENV_EXTRAWHITE'><glossterm>BB_ENV_EXTRAWHITE</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
Specifies an additional set of variables to allow through
|
||||
(whitelist) from the external environment into BitBake's
|
||||
datastore.
|
||||
This list of variables are on top of the internal list
|
||||
set in
|
||||
<link linkend='var-BB_ENV_WHITELIST'><filename>BB_ENV_WHITELIST</filename></link>.
|
||||
<note>
|
||||
You must set this variable in the external
|
||||
environment in order for it to work.
|
||||
</note>
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BB_FETCH_PREMIRRORONLY'><glossterm>BB_FETCH_PREMIRRORONLY</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
@@ -451,6 +500,36 @@
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BB_ORIGENV'><glossterm>BB_ORIGENV</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
Contains a copy of the original external environment in
|
||||
which BitBake was run.
|
||||
The copy is taken before any whitelisted variable values
|
||||
are filtered into BitBake's datastore.
|
||||
<note>
|
||||
The contents of this variable is a datastore object
|
||||
that can be queried using the normal datastore
|
||||
operations.
|
||||
</note>
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BB_PRESERVE_ENV'><glossterm>BB_PRESERVE_ENV</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
Disables whitelisting and instead allows all variables
|
||||
through from the external environment into BitBake's
|
||||
datastore.
|
||||
<note>
|
||||
You must set this variable in the external
|
||||
environment in order for it to work.
|
||||
</note>
|
||||
</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.
|
||||
@@ -703,6 +782,16 @@
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BB_TASKHASH'><glossterm>BB_TASKHASH</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
Within an executing task, this variable holds the hash
|
||||
of the task as returned by the currently enabled
|
||||
signature generator.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BB_VERBOSE_LOGS'><glossterm>BB_VERBOSE_LOGS</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
@@ -750,6 +839,20 @@
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BBDEBUG'><glossterm>BBDEBUG</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
Sets the BitBake debug output level to a specific value
|
||||
as incremented by the <filename>-d</filename> command line
|
||||
option.
|
||||
<note>
|
||||
You must set this variable in the external environment
|
||||
in order for it to work.
|
||||
</note>
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm>
|
||||
<glossdef>
|
||||
<para>Lists the names of configured layers.
|
||||
@@ -809,6 +912,16 @@
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BBINCLUDED'><glossterm>BBINCLUDED</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
Contains a space-separated list of all of all files that
|
||||
BitBake's parser included during parsing of the current
|
||||
file.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm>
|
||||
<glossdef>
|
||||
<para>Variable that controls how BitBake displays logs on build failure.</para>
|
||||
@@ -928,6 +1041,30 @@
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BITBAKE_UI'><glossterm>BITBAKE_UI</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
Used to specify the UI module to use when running BitBake.
|
||||
Using this variable is equivalent to using the
|
||||
<filename>-u</filename> command-line option.
|
||||
<note>
|
||||
You must set this variable in the external environment
|
||||
in order for it to work.
|
||||
</note>
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-BUILDNAME'><glossterm>BUILDNAME</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
A name assigned to the build.
|
||||
The name defaults to a datetime stamp of when the build was
|
||||
started but can be defined by the metadata.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id='var-glossary-c'><title>C</title>
|
||||
@@ -1894,6 +2031,33 @@
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-SRCREV_FORMAT'><glossterm>SRCREV_FORMAT</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
Helps construct valid
|
||||
<link linkend='var-SRCREV'><filename>SRCREV</filename></link>
|
||||
values when multiple source controlled URLs are used in
|
||||
<link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The system needs help constructing these values under these
|
||||
circumstances.
|
||||
Each component in the <filename>SRC_URI</filename>
|
||||
is assigned a name and these are referenced
|
||||
in the <filename>SRCREV_FORMAT</filename> variable.
|
||||
Consider an example with URLs named "machine" and "meta".
|
||||
In this case, <filename>SRCREV_FORMAT</filename> could look
|
||||
like "machine_meta" and those names would have the SCM
|
||||
versions substituted into each position.
|
||||
Only one <filename>AUTOINC</filename> placeholder is added
|
||||
and if needed.
|
||||
And, this placeholder is placed at the start of the
|
||||
returned string.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id='var-STAMP'><glossterm>STAMP</glossterm>
|
||||
<glossdef>
|
||||
<para>
|
||||
|
||||
Reference in New Issue
Block a user