aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-31 10:00:02 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-16 18:13:44 +0100
commitd99760cc687cc9c24d6d9a1c49fa094574476e0c (patch)
tree380e26a848ac75354e6631fe3d66013c9404e65f
parent4f94633a68fd44223d6be458fc0d3616dfdfd1a7 (diff)
downloadbitbake-contrib-d99760cc687cc9c24d6d9a1c49fa094574476e0c.tar.gz
sphinx: last manual round of fixes/improvements
Review all pages, and fix up for formatting which was not covered by pandoc, such as some links and code block sections. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-execution.rst237
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-fetching.rst243
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-hello.rst417
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-intro.rst316
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-metadata.rst1233
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst457
6 files changed, 1733 insertions, 1170 deletions
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-execution.rst b/doc/bitbake-user-manual/bitbake-user-manual-execution.rst
index ab61b05a8..019afd22f 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-execution.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-execution.rst
@@ -16,9 +16,13 @@ data, or simply return information about the execution environment.
This chapter describes BitBake's execution process from start to finish
when you use it to create an image. The execution process is launched
-using the following command form: $ bitbake target For information on
-the BitBake command and its options, see "`The BitBake
-Command <#bitbake-user-manual-command>`__" section.
+using the following command form: ::
+
+ $ bitbake target
+
+For information on
+the BitBake command and its options, see ":ref:`The BitBake Command
+<bitbake-user-manual-command>`" section.
.. note::
@@ -28,7 +32,11 @@ Command <#bitbake-user-manual-command>`__" section.
your project's ``local.conf`` configuration file.
A common method to determine this value for your build host is to run
- the following: $ grep processor /proc/cpuinfo This command returns
+ the following: ::
+
+ $ grep processor /proc/cpuinfo
+
+ This command returns
the number of processors, which takes into account hyper-threading.
Thus, a quad-core build host with hyper-threading most likely shows
eight processors, which is the value you would then assign to
@@ -46,12 +54,12 @@ to determine what layers BitBake needs to recognize, all necessary
``layer.conf`` files (one from each layer), and ``bitbake.conf``. The
data itself is of various types:
-- *Recipes:* Details about particular pieces of software.
+- **Recipes:** Details about particular pieces of software.
-- *Class Data:* An abstraction of common build information (e.g. how to
+- **Class Data:** An abstraction of common build information (e.g. how to
build a Linux kernel).
-- *Configuration Data:* Machine-specific settings, policy decisions,
+- **Configuration Data:** Machine-specific settings, policy decisions,
and so forth. Configuration data acts as the glue to bind everything
together.
@@ -72,13 +80,9 @@ Prior to parsing configuration files, BitBake looks at certain
variables, including:
- :term:`BB_ENV_WHITELIST`
-
- :term:`BB_ENV_EXTRAWHITE`
-
- :term:`BB_PRESERVE_ENV`
-
- :term:`BB_ORIGENV`
-
- :term:`BITBAKE_UI`
The first four variables in this list relate to how BitBake treats shell
@@ -87,8 +91,8 @@ the environment variables and provides tight control over the shell
execution environment. However, through the use of these first four
variables, you can apply your control regarding the environment
variables allowed to be used by BitBake in the shell during execution of
-tasks. See the "`Passing Information Into the Build Task
-Environment <#passing-information-into-the-build-task-environment>`__"
+tasks. See the
+":ref:`bitbake-user-manual/bitbake-user-manual-metadata:Passing Information Into the Build Task Environment`"
section and the information about these variables in the variable
glossary for more information on how they work and on how to use them.
@@ -118,8 +122,8 @@ Only variable definitions and include directives are allowed in BitBake
``.conf`` files. Some variables directly influence BitBake's behavior.
These variables might have been set from the environment depending on
the environment variables previously mentioned or set in the
-configuration files. The "`Variables
-Glossary <#ref-bb-variables-glos>`__" chapter presents a full list of
+configuration files. The ":ref:`bitbake-user-manual/bitbake-user-manual-ref-variables:Variables Glossary`"
+chapter presents a full list of
variables.
After parsing configuration files, BitBake uses its rudimentary
@@ -135,7 +139,11 @@ in ``BBPATH`` in the same way as configuration files.
A good way to get an idea of the configuration files and the class files
used in your execution environment is to run the following BitBake
-command: $ bitbake -e > mybb.log Examining the top of the ``mybb.log``
+command: ::
+
+ $ bitbake -e > mybb.log
+
+Examining the top of the ``mybb.log``
shows you the many configuration files and class files used in your
execution environment.
@@ -147,15 +155,28 @@ execution environment.
pair of curly braces in a shell function, the closing curly brace
must not be located at the start of the line without leading spaces.
- Here is an example that causes BitBake to produce a parsing error:
- fakeroot create_shar() { cat << "EOF" >
- ${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.sh usage() { echo "test" ######
- The following "}" at the start of the line causes a parsing error
- ###### } EOF } Writing the recipe this way avoids the error: fakeroot
- create_shar() { cat << "EOF" >
- ${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.sh usage() { echo "test"
- ######The following "}" with a leading space at the start of the line
- avoids the error ###### } EOF }
+ Here is an example that causes BitBake to produce a parsing error: ::
+
+ fakeroot create_shar() {
+ cat << "EOF" > ${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.sh
+ usage()
+ {
+ echo "test"
+ ###### The following "}" at the start of the line causes a parsing error ######
+ }
+ EOF
+ }
+
+ Writing the recipe this way avoids the error:
+ fakeroot create_shar() {
+ cat << "EOF" > ${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.sh
+ usage()
+ {
+ echo "test"
+ ###### The following "}" with a leading space at the start of the line avoids the error ######
+ }
+ EOF
+ }
Locating and Parsing Recipes
============================
@@ -164,16 +185,17 @@ During the configuration phase, BitBake will have set
:term:`BBFILES`. BitBake now uses it to construct a
list of recipes to parse, along with any append files (``.bbappend``) to
apply. ``BBFILES`` is a space-separated list of available files and
-supports wildcards. An example would be: BBFILES =
-"/path/to/bbfiles/*.bb /path/to/appends/*.bbappend" BitBake parses each
+supports wildcards. An example would be: ::
+
+ BBFILES = "/path/to/bbfiles/*.bb /path/to/appends/*.bbappend"
+
+BitBake parses each
recipe and append file located with ``BBFILES`` and stores the values of
various variables into the datastore.
.. note::
- Append files are applied in the order they are encountered in
- BBFILES
- .
+ Append files are applied in the order they are encountered in BBFILES.
For each file, a fresh copy of the base configuration is made, then the
recipe is parsed line by line. Any inherit statements cause BitBake to
@@ -184,11 +206,12 @@ parses in order any append files found in ``BBFILES``.
One common convention is to use the recipe filename to define pieces of
metadata. For example, in ``bitbake.conf`` the recipe name and version
are used to set the variables :term:`PN` and
-:term:`PV`: PN =
-"${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] or
-'defaultpkgname'}" PV =
-"${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[1] or
-'1.0'}" In this example, a recipe called "something_1.2.3.bb" would set
+:term:`PV`: ::
+
+ PN = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] or 'defaultpkgname'}"
+ PV = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[1] or '1.0'}"
+
+In this example, a recipe called "something_1.2.3.bb" would set
``PN`` to "something" and ``PV`` to "1.2.3".
By the time parsing is complete for a recipe, BitBake has a list of
@@ -215,11 +238,13 @@ Recipe file collections exist to allow the user to have multiple
repositories of ``.bb`` files that contain the same exact package. For
example, one could easily use them to make one's own local copy of an
upstream repository, but with custom modifications that one does not
-want upstream. Here is an example: BBFILES = "/stuff/openembedded/*/*.bb
-/stuff/openembedded.modified/*/*.bb" BBFILE_COLLECTIONS = "upstream
-local" BBFILE_PATTERN_upstream = "^/stuff/openembedded/"
-BBFILE_PATTERN_local = "^/stuff/openembedded.modified/"
-BBFILE_PRIORITY_upstream = "5" BBFILE_PRIORITY_local = "10"
+want upstream. Here is an example: ::
+
+ BBFILES = "/stuff/openembedded/*/*.bb /stuff/openembedded.modified/*/*.bb"
+ BBFILE_COLLECTIONS = "upstream local"
+ BBFILE_PATTERN_upstream = "^/stuff/openembedded/"
+ BBFILE_PATTERN_local = "^/stuff/openembedded.modified/"
+ BBFILE_PRIORITY_upstream = "5" BBFILE_PRIORITY_local = "10"
.. note::
@@ -244,7 +269,11 @@ variable, which is optional.
When a recipe uses ``PROVIDES``, that recipe's functionality can be
found under an alternative name or names other than the implicit ``PN``
name. As an example, suppose a recipe named ``keyboard_1.0.bb``
-contained the following: PROVIDES += "fullkeyboard" The ``PROVIDES``
+contained the following: ::
+
+ PROVIDES += "fullkeyboard"
+
+The ``PROVIDES``
list for this recipe becomes "keyboard", which is implicit, and
"fullkeyboard", which is explicit. Consequently, the functionality found
in ``keyboard_1.0.bb`` can be found under two different names.
@@ -261,9 +290,11 @@ needs to prioritize providers by determining provider preferences.
A common example in which a target has multiple providers is
"virtual/kernel", which is on the ``PROVIDES`` list for each kernel
recipe. Each machine often selects the best kernel provider by using a
-line similar to the following in the machine configuration file:
-PREFERRED_PROVIDER_virtual/kernel = "linux-yocto" The default
-:term:`PREFERRED_PROVIDER` is the provider
+line similar to the following in the machine configuration file: ::
+
+ PREFERRED_PROVIDER_virtual/kernel = "linux-yocto"
+
+The default :term:`PREFERRED_PROVIDER` is the provider
with the same name as the target. BitBake iterates through each target
it needs to build and resolves them and their dependencies using this
process.
@@ -299,8 +330,9 @@ If the first recipe is named ``a_1.1.bb``, then the
Thus, if a recipe named ``a_1.2.bb`` exists, BitBake will choose 1.2 by
default. However, if you define the following variable in a ``.conf``
-file that BitBake parses, you can change that preference:
-PREFERRED_VERSION_a = "1.1"
+file that BitBake parses, you can change that preference: ::
+
+ PREFERRED_VERSION_a = "1.1"
.. note::
@@ -312,7 +344,11 @@ PREFERRED_VERSION_a = "1.1"
For example, in the OpenEmbedded codebase, there is a standard,
versioned recipe file for BusyBox, ``busybox_1.22.1.bb``, but there
is also a Git-based version, ``busybox_git.bb``, which explicitly
- contains the line DEFAULT_PREFERENCE = "-1" to ensure that the
+ contains the line ::
+
+ DEFAULT_PREFERENCE = "-1"
+
+ to ensure that the
numbered, stable version is always preferred unless the developer
selects otherwise.
@@ -327,15 +363,16 @@ performance on multi-core systems, BitBake considers each task as an
independent entity with its own set of dependencies.
Dependencies are defined through several variables. You can find
-information about variables BitBake uses in the `Variables
-Glossary <#ref-bb-variables-glos>`__ near the end of this manual. At a
+information about variables BitBake uses in the
+:doc:`bitbake-user-manual-ref-variables` near the end of this manual. At a
basic level, it is sufficient to know that BitBake uses the
:term:`DEPENDS` and
:term:`RDEPENDS` variables when calculating
dependencies.
For more information on how BitBake handles dependencies, see the
-"`Dependencies <#dependencies>`__" section.
+:ref:`bitbake-user-manual/bitbake-user-manual-metadata:Dependencies`
+section.
.. _ref-bitbake-tasklist:
@@ -344,7 +381,8 @@ The Task List
Based on the generated list of providers and the dependency information,
BitBake can now calculate exactly what tasks it needs to run and in what
-order it needs to run them. The "`Executing Tasks <#executing-tasks>`__"
+order it needs to run them. The
+:ref:`bitbake-user-manual/bitbake-user-manual-execution:executing tasks`
section has more information on how BitBake chooses which task to
execute next.
@@ -371,8 +409,9 @@ The exact format of the stamps is partly configurable. In modern
versions of BitBake, a hash is appended to the stamp so that if the
configuration changes, the stamp becomes invalid and the task is
automatically rerun. This hash, or signature used, is governed by the
-signature policy that is configured (see the "`Checksums
-(Signatures) <#checksums>`__" section for information). It is also
+signature policy that is configured (see the
+:ref:`bitbake-user-manual/bitbake-user-manual-execution:checksums (signatures)`
+section for information). It is also
possible to append extra metadata to the stamp using the
``[stamp-extra-info]`` task flag. For example, OpenEmbedded uses this
flag to make some tasks machine-specific.
@@ -383,7 +422,8 @@ flag to make some tasks machine-specific.
created when these tasks are run. Consequently, "nostamp" tasks are
always rerun.
-For more information on tasks, see the "`Tasks <#tasks>`__" section.
+For more information on tasks, see the
+:ref:`bitbake-user-manual/bitbake-user-manual-metadata:tasks` section.
Executing Tasks
===============
@@ -457,14 +497,21 @@ to the task.
Like the working directory case, situations exist where dependencies
should be ignored. For these cases, you can instruct the build process
-to ignore a dependency by using a line like the following:
-PACKAGE_ARCHS[vardepsexclude] = "MACHINE" This example ensures that the
+to ignore a dependency by using a line like the following: ::
+
+ PACKAGE_ARCHS[vardepsexclude] = "MACHINE"
+
+This example ensures that the
``PACKAGE_ARCHS`` variable does not depend on the value of ``MACHINE``,
even if it does reference it.
Equally, there are cases where we need to add dependencies BitBake is
not able to find. You can accomplish this by using a line like the
-following: PACKAGE_ARCHS[vardeps] = "MACHINE" This example explicitly
+following: ::
+
+ PACKAGE_ARCHS[vardeps] = "MACHINE"
+
+This example explicitly
adds the ``MACHINE`` variable as a dependency for ``PACKAGE_ARCHS``.
Consider a case with in-line Python, for example, where BitBake is not
@@ -488,13 +535,15 @@ configuration file, we can give BitBake some extra information to help
it construct the basehash. The following statement effectively results
in a list of global variable dependency excludes - variables never
included in any checksum. This example uses variables from OpenEmbedded
-to help illustrate the concept: BB_HASHBASE_WHITELIST ?= "TMPDIR FILE
-PATH PWD BB_TASKHASH BBPATH DL_DIR \\ SSTATE_DIR THISDIR FILESEXTRAPATHS
-FILE_DIRNAME HOME LOGNAME SHELL \\ USER FILESPATH STAGING_DIR_HOST
-STAGING_DIR_TARGET COREBASE PRSERV_HOST \\ PRSERV_DUMPDIR
-PRSERV_DUMPFILE PRSERV_LOCKDOWN PARALLEL_MAKE \\ CCACHE_DIR
-EXTERNAL_TOOLCHAIN CCACHE CCACHE_DISABLE LICENSE_PATH SDKPKGSUFFIX" The
-previous example excludes the work directory, which is part of
+to help illustrate the concept: ::
+
+ BB_HASHBASE_WHITELIST ?= "TMPDIR FILE PATH PWD BB_TASKHASH BBPATH DL_DIR \
+ SSTATE_DIR THISDIR FILESEXTRAPATHS FILE_DIRNAME HOME LOGNAME SHELL \
+ USER FILESPATH STAGING_DIR_HOST STAGING_DIR_TARGET COREBASE PRSERV_HOST \
+ PRSERV_DUMPDIR PRSERV_DUMPFILE PRSERV_LOCKDOWN PARALLEL_MAKE \
+ CCACHE_DIR EXTERNAL_TOOLCHAIN CCACHE CCACHE_DISABLE LICENSE_PATH SDKPKGSUFFIX"
+
+The previous example excludes the work directory, which is part of
``TMPDIR``.
The rules for deciding which hashes of dependent tasks to include
@@ -507,8 +556,11 @@ OpenEmbedded-Core uses: "OEBasic" and "OEBasicHash". By default, there
is a dummy "noop" signature handler enabled in BitBake. This means that
behavior is unchanged from previous versions. ``OE-Core`` uses the
"OEBasicHash" signature handler by default through this setting in the
-``bitbake.conf`` file: BB_SIGNATURE_HANDLER ?= "OEBasicHash" The
-"OEBasicHash" ``BB_SIGNATURE_HANDLER`` is the same as the "OEBasic"
+``bitbake.conf`` file: ::
+
+ BB_SIGNATURE_HANDLER ?= "OEBasicHash"
+
+The "OEBasicHash" ``BB_SIGNATURE_HANDLER`` is the same as the "OEBasic"
version but adds the task hash to the stamp files. This results in any
metadata change that changes the task hash, automatically causing the
task to be run again. This removes the need to bump
@@ -519,13 +571,13 @@ It is also worth noting that the end result of these signature
generators is to make some dependency and hash information available to
the build. This information includes:
-- ``BB_BASEHASH_task-``\ taskname: The base hashes for each task in the
+- ``BB_BASEHASH_task-``\ *taskname*: The base hashes for each task in the
recipe.
-- ``BB_BASEHASH_``\ filename\ ``:``\ taskname: The base hashes for each
+- ``BB_BASEHASH_``\ *filename:taskname*: The base hashes for each
dependent task.
-- ``BBHASHDEPS_``\ filename\ ``:``\ taskname: The task dependencies for
+- ``BBHASHDEPS_``\ *filename:taskname*: The task dependencies for
each task.
- ``BB_TASKHASH``: The hash of the currently running task.
@@ -547,8 +599,9 @@ where these two stamp trees diverge.
It is likely that future versions of BitBake will provide other
signature handlers triggered through additional "-S" parameters.
-You can find more information on checksum metadata in the "`Task
-Checksums and Setscene <#task-checksums-and-setscene>`__" section.
+You can find more information on checksum metadata in the
+:ref:`bitbake-user-manual/bitbake-user-manual-metadata:task checksums and setscene`
+section.
Setscene
========
@@ -601,8 +654,9 @@ with the list of tasks BitBake thinks has been "covered". The metadata
can then ensure that this list is correct and can inform BitBake that it
wants specific tasks to be run regardless of the setscene result.
-You can find more information on setscene metadata in the "`Task
-Checksums and Setscene <#task-checksums-and-setscene>`__" section.
+You can find more information on setscene metadata in the
+:ref:`bitbake-user-manual/bitbake-user-manual-metadata:task checksums and setscene`
+section.
Logging
=======
@@ -648,11 +702,32 @@ logging configuration is merged using the following rules:
As an example, consider the following user logging configuration file
which logs all Hash Equivalence related messages of VERBOSE or higher to
-a file called ``hashequiv.log`` { "version": 1, "handlers": {
-"autobuilderlog": { "class": "logging.FileHandler", "formatter":
-"logfileFormatter", "level": "DEBUG", "filename": "hashequiv.log",
-"mode": "w" } }, "formatters": { "logfileFormatter": { "format":
-"%(name)s: %(levelname)s: %(message)s" } }, "loggers": {
-"BitBake.SigGen.HashEquiv": { "level": "VERBOSE", "handlers":
-["autobuilderlog"] }, "BitBake.RunQueue.HashEquiv": { "level":
-"VERBOSE", "handlers": ["autobuilderlog"] } } }
+a file called ``hashequiv.log`` ::
+
+ {
+ "version": 1,
+ "handlers": {
+ "autobuilderlog": {
+ "class": "logging.FileHandler",
+ "formatter": "logfileFormatter",
+ "level": "DEBUG",
+ "filename": "hashequiv.log",
+ "mode": "w"
+ }
+ },
+ "formatters": {
+ "logfileFormatter": {
+ "format": "%(name)s: %(levelname)s: %(message)s"
+ }
+ },
+ "loggers": {
+ "BitBake.SigGen.HashEquiv": {
+ "level": "VERBOSE",
+ "handlers": ["autobuilderlog"]
+ },
+ "BitBake.RunQueue.HashEquiv": {
+ "level": "VERBOSE",
+ "handlers": ["autobuilderlog"]
+ }
+ }
+ }
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
index a8815f3e2..f62ddffe8 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -27,22 +27,28 @@ and unpacking the files is often optionally followed by patching.
Patching, however, is not covered by this module.
The code to execute the first part of this process, a fetch, looks
-something like the following: src_uri = (d.getVar('SRC_URI') or
-"").split() fetcher = bb.fetch2.Fetch(src_uri, d) fetcher.download()
+something like the following: ::
+
+ src_uri = (d.getVar('SRC_URI') or "").split()
+ fetcher = bb.fetch2.Fetch(src_uri, d)
+ fetcher.download()
+
This code sets up an instance of the fetch class. The instance uses a
space-separated list of URLs from the :term:`SRC_URI`
variable and then calls the ``download`` method to download the files.
-The instantiation of the fetch class is usually followed by: rootdir =
-l.getVar('WORKDIR') fetcher.unpack(rootdir) This code unpacks the
-downloaded files to the specified by ``WORKDIR``.
+The instantiation of the fetch class is usually followed by: ::
+
+ rootdir = l.getVar('WORKDIR')
+ fetcher.unpack(rootdir)
+
+This code unpacks the downloaded files to the specified by ``WORKDIR``.
.. note::
For convenience, the naming in these examples matches the variables
used by OpenEmbedded. If you want to see the above code in action,
- examine the OpenEmbedded class file
- base.bbclass
+ examine the OpenEmbedded class file ``base.bbclass``
.
The ``SRC_URI`` and ``WORKDIR`` variables are not hardcoded into the
@@ -61,30 +67,37 @@ URLs by looking for source files in a specific search order:
from ``SRC_URI``).
- *Mirror Sites:* If fetch failures occur, BitBake next uses mirror
- locations as defined by the :term:`MIRRORS`
- variable.
+ locations as defined by the :term:`MIRRORS` variable.
For each URL passed to the fetcher, the fetcher calls the submodule that
handles that particular URL type. This behavior can be the source of
some confusion when you are providing URLs for the ``SRC_URI`` variable.
-Consider the following two URLs:
-http://git.yoctoproject.org/git/poky;protocol=git
-git://git.yoctoproject.org/git/poky;protocol=http In the former case,
-the URL is passed to the ``wget`` fetcher, which does not understand
-"git". Therefore, the latter case is the correct form since the Git
+Consider the following two URLs: ::
+
+ http://git.yoctoproject.org/git/poky;protocol=git
+ git://git.yoctoproject.org/git/poky;protocol=http
+
+In the former case, the URL is passed to the ``wget`` fetcher, which does not
+understand "git". Therefore, the latter case is the correct form since the Git
fetcher does know how to use HTTP as a transport.
-Here are some examples that show commonly used mirror definitions:
-PREMIRRORS ?= "\\ bzr://.*/.\* http://somemirror.org/sources/ \\n \\
-cvs://.*/.\* http://somemirror.org/sources/ \\n \\ git://.*/.\*
-http://somemirror.org/sources/ \\n \\ hg://.*/.\*
-http://somemirror.org/sources/ \\n \\ osc://.*/.\*
-http://somemirror.org/sources/ \\n \\ p4://.*/.\*
-http://somemirror.org/sources/ \\n \\ svn://.*/.\*
-http://somemirror.org/sources/ \\n" MIRRORS =+ "\\ ftp://.*/.\*
-http://somemirror.org/sources/ \\n \\ http://.*/.\*
-http://somemirror.org/sources/ \\n \\ https://.*/.\*
-http://somemirror.org/sources/ \\n" It is useful to note that BitBake
+Here are some examples that show commonly used mirror definitions: ::
+
+ PREMIRRORS ?= "\
+ bzr://.*/.\* http://somemirror.org/sources/ \\n \
+ cvs://.*/.\* http://somemirror.org/sources/ \\n \
+ git://.*/.\* http://somemirror.org/sources/ \\n \
+ hg://.*/.\* http://somemirror.org/sources/ \\n \
+ osc://.*/.\* http://somemirror.org/sources/ \\n \
+ p4://.*/.\* http://somemirror.org/sources/ \\n \
+ svn://.*/.\* http://somemirror.org/sources/ \\n"
+
+ MIRRORS =+ "\
+ ftp://.*/.\* http://somemirror.org/sources/ \\n \
+ http://.*/.\* http://somemirror.org/sources/ \\n \
+ https://.*/.\* http://somemirror.org/sources/ \\n"
+
+It is useful to note that BitBake
supports cross-URLs. It is possible to mirror a Git repository on an
HTTP server as a tarball. This is what the ``git://`` mapping in the
previous example does.
@@ -98,15 +111,24 @@ File integrity is of key importance for reproducing builds. For
non-local archive downloads, the fetcher code can verify SHA-256 and MD5
checksums to ensure the archives have been downloaded correctly. You can
specify these checksums by using the ``SRC_URI`` variable with the
-appropriate varflags as follows: SRC_URI[md5sum] = "value"
-SRC_URI[sha256sum] = "value" You can also specify the checksums as
-parameters on the ``SRC_URI`` as shown below: SRC_URI =
-"http://example.com/foobar.tar.bz2;md5sum=4a8e0f237e961fd7785d19d07fdb994d"
+appropriate varflags as follows: ::
+
+ SRC_URI[md5sum] = "value"
+ SRC_URI[sha256sum] = "value"
+
+You can also specify the checksums as
+parameters on the ``SRC_URI`` as shown below: ::
+
+ SRC_URI = "http://example.com/foobar.tar.bz2;md5sum=4a8e0f237e961fd7785d19d07fdb994d"
+
If multiple URIs exist, you can specify the checksums either directly as
in the previous example, or you can name the URLs. The following syntax
-shows how you name the URIs: SRC_URI =
-"http://example.com/foobar.tar.bz2;name=foo" SRC_URI[foo.md5sum] =
-4a8e0f237e961fd7785d19d07fdb994d After a file has been downloaded and
+shows how you name the URIs: ::
+
+ SRC_URI = "http://example.com/foobar.tar.bz2;name=foo"
+ SRC_URI[foo.md5sum] = 4a8e0f237e961fd7785d19d07fdb994d
+
+After a file has been downloaded and
has had its checksum checked, a ".done" stamp is placed in ``DL_DIR``.
BitBake uses this stamp during subsequent builds to avoid downloading or
comparing a checksum for the file again.
@@ -182,8 +204,10 @@ time the ``download()`` method is called.
If you specify a directory, the entire directory is unpacked.
Here are a couple of example URLs, the first relative and the second
-absolute: SRC_URI = "file://relativefile.patch" SRC_URI =
-"file:///Users/ich/very_important_software"
+absolute: ::
+
+ SRC_URI = "file://relativefile.patch"
+ SRC_URI = "file:///Users/ich/very_important_software"
.. _http-ftp-fetcher:
@@ -201,10 +225,11 @@ downloaded file is useful for avoiding collisions in
:term:`DL_DIR` when dealing with multiple files that
have the same name.
-Some example URLs are as follows: SRC_URI =
-"http://oe.handhelds.org/not_there.aac" SRC_URI =
-"ftp://oe.handhelds.org/not_there_as_well.aac" SRC_URI =
-"ftp://you@oe.handhelds.org/home/you/secret.plan"
+Some example URLs are as follows: ::
+
+ SRC_URI = "http://oe.handhelds.org/not_there.aac"
+ SRC_URI = "ftp://oe.handhelds.org/not_there_as_well.aac"
+ SRC_URI = "ftp://you@oe.handhelds.org/home/you/secret.plan"
.. note::
@@ -214,14 +239,14 @@ Some example URLs are as follows: SRC_URI =
::
SRC_URI = "http://abc123.org/git/?p=gcc/gcc.git;a=snapshot;h=a5dd47"
-
+
Such URLs should should be modified by replacing semi-colons with '&'
characters:
::
SRC_URI = "http://abc123.org/git/?p=gcc/gcc.git&a=snapshot&h=a5dd47"
-
+
In most cases this should work. Treating semi-colons and '&' in
queries identically is recommended by the World Wide Web Consortium
@@ -230,7 +255,7 @@ Some example URLs are as follows: SRC_URI =
::
SRC_URI = "http://abc123.org/git/?p=gcc/gcc.git&a=snapshot&h=a5dd47;downloadfilename=myfile.bz2"
-
+
.. _cvs-fetcher:
@@ -240,20 +265,20 @@ CVS fetcher (``(cvs://``)
This submodule handles checking out files from the CVS version control
system. You can configure it using a number of different variables:
-- *``FETCHCMD_cvs``:* The name of the executable to use when running
+- :term:`FETCHCMD_cvs <FETCHCMD>`: The name of the executable to use when running
the ``cvs`` command. This name is usually "cvs".
-- *``SRCDATE``:* The date to use when fetching the CVS source code. A
+- :term:`SRCDATE`: The date to use when fetching the CVS source code. A
special value of "now" causes the checkout to be updated on every
build.
-- :term:`CVSDIR`\ *:* Specifies where a temporary
+- :term:`CVSDIR`: Specifies where a temporary
checkout is saved. The location is often ``DL_DIR/cvs``.
-- *``CVS_PROXY_HOST``:* The name to use as a "proxy=" parameter to the
+- CVS_PROXY_HOST: The name to use as a "proxy=" parameter to the
``cvs`` command.
-- *``CVS_PROXY_PORT``:* The port number to use as a "proxyport="
+- CVS_PROXY_PORT: The port number to use as a "proxyport="
parameter to the ``cvs`` command.
As well as the standard username and password URL syntax, you can also
@@ -282,7 +307,7 @@ The supported parameters are as follows:
are forcing the module into a special directory relative to
:term:`CVSDIR`.
-- *"rsh"* Used in conjunction with the "method" parameter.
+- *"rsh":* Used in conjunction with the "method" parameter.
- *"scmdata":* Causes the CVS metadata to be maintained in the tarball
the fetcher creates when set to "keep". The tarball is expanded into
@@ -296,9 +321,10 @@ The supported parameters are as follows:
- *"port":* The port to which the CVS server connects.
-Some example URLs are as follows: SRC_URI =
-"cvs://CVSROOT;module=mymodule;tag=some-version;method=ext" SRC_URI =
-"cvs://CVSROOT;module=mymodule;date=20060126;localdir=usethat"
+Some example URLs are as follows: ::
+
+ SRC_URI = "cvs://CVSROOT;module=mymodule;tag=some-version;method=ext"
+ SRC_URI = "cvs://CVSROOT;module=mymodule;date=20060126;localdir=usethat"
.. _svn-fetcher:
@@ -337,10 +363,11 @@ The supported parameters are as follows:
username is different than the username used in the main URL, which
is passed to the subversion command.
-Following are three examples using svn: SRC_URI =
-"svn://myrepos/proj1;module=vip;protocol=http;rev=667" SRC_URI =
-"svn://myrepos/proj1;module=opie;protocol=svn+ssh" SRC_URI =
-"svn://myrepos/proj1;module=trunk;protocol=http;path_spec=${MY_DIR}/proj1"
+Following are three examples using svn: ::
+
+ SRC_URI = "svn://myrepos/proj1;module=vip;protocol=http;rev=667"
+ SRC_URI = "svn://myrepos/proj1;module=opie;protocol=svn+ssh"
+ SRC_URI = "svn://myrepos/proj1;module=trunk;protocol=http;path_spec=${MY_DIR}/proj1"
.. _git-fetcher:
@@ -409,20 +436,22 @@ This fetcher supports the following parameters:
parameter implies no branch and only works when the transfer protocol
is ``file://``.
-Here are some example URLs: SRC_URI =
-"git://git.oe.handhelds.org/git/vip.git;tag=version-1" SRC_URI =
-"git://git.oe.handhelds.org/git/vip.git;protocol=http"
+Here are some example URLs: ::
+
+ SRC_URI = "git://git.oe.handhelds.org/git/vip.git;tag=version-1"
+ SRC_URI = "git://git.oe.handhelds.org/git/vip.git;protocol=http"
.. _gitsm-fetcher:
Git Submodule Fetcher (``gitsm://``)
------------------------------------
-This fetcher submodule inherits from the `Git fetcher <#git-fetcher>`__
-and extends that fetcher's behavior by fetching a repository's
-submodules. :term:`SRC_URI` is passed to the Git
-fetcher as described in the "`Git Fetcher
-(``git://``) <#git-fetcher>`__" section.
+This fetcher submodule inherits from the :ref:`Git
+fetcher<bitbake-user-manual/bitbake-user-manual-fetching:git fetcher
+(\`\`git://\`\`)>` and extends that fetcher's behavior by fetching a
+repository's submodules. :term:`SRC_URI` is passed to the Git fetcher as
+described in the :ref:`bitbake-user-manual/bitbake-user-manual-fetching:git
+fetcher (\`\`git://\`\`)` section.
.. note::
@@ -446,42 +475,33 @@ repository.
To use this fetcher, make sure your recipe has proper
:term:`SRC_URI`, :term:`SRCREV`, and
-:term:`PV` settings. Here is an example: SRC_URI =
-"ccrc://cc.example.org/ccrc;vob=/example_vob;module=/example_module"
-SRCREV = "EXAMPLE_CLEARCASE_TAG" PV = "${@d.getVar("SRCREV",
-False).replace("/", "+")}" The fetcher uses the ``rcleartool`` or
+:term:`PV` settings. Here is an example: ::
+
+ SRC_URI = "ccrc://cc.example.org/ccrc;vob=/example_vob;module=/example_module"
+ SRCREV = "EXAMPLE_CLEARCASE_TAG"
+ PV = "${@d.getVar("SRCREV", False).replace("/", "+")}"
+
+The fetcher uses the ``rcleartool`` or
``cleartool`` remote client, depending on which one is available.
Following are options for the ``SRC_URI`` statement:
-- *``vob``*: The name, which must include the prepending "/" character,
+- *vob*: The name, which must include the prepending "/" character,
of the ClearCase VOB. This option is required.
-- *``module``*: The module, which must include the prepending "/"
+- *module*: The module, which must include the prepending "/"
character, in the selected VOB.
.. note::
- The
- module
- and
- vob
- options are combined to create the
- load
- rule in the view config spec. As an example, consider the
- vob
- and
- module
- values from the
- SRC_URI
- statement at the start of this section. Combining those values
- results in the following:
- ::
-
- load /example_vob/example_module
-
-
-- *``proto``*: The protocol, which can be either ``http`` or ``https``.
+ The module and vob options are combined to create the load rule in the
+ view config spec. As an example, consider the vob and module values from
+ the SRC_URI statement at the start of this section. Combining those values
+ results in the following: ::
+
+ load /example_vob/example_module
+
+- *proto*: The protocol, which can be either ``http`` or ``https``.
By default, the fetcher creates a configuration specification. If you
want this specification written to an area other than the default, use
@@ -490,11 +510,8 @@ the specification is written.
.. note::
- the
- SRCREV
- loses its functionality if you specify this variable. However,
- SRCREV
- is still used to label the archive after a fetch even though it does
+ the SRCREV loses its functionality if you specify this variable. However,
+ SRCREV is still used to label the archive after a fetch even though it does
not define what is fetched.
Here are a couple of other behaviors worth mentioning:
@@ -532,34 +549,36 @@ the server's URL and port number, and you can specify a username and
password directly in your recipe within ``SRC_URI``.
Here is an example that relies on ``P4CONFIG`` to specify the server URL
-and port, username, and password, and fetches the Head Revision: SRC_URI
-= "p4://example-depot/main/source/..." SRCREV = "${AUTOREV}" PV =
-"p4-${SRCPV}" S = "${WORKDIR}/p4"
+and port, username, and password, and fetches the Head Revision: ::
+
+ SRC_URI = "p4://example-depot/main/source/..."
+ SRCREV = "${AUTOREV}"
+ PV = "p4-${SRCPV}"
+ S = "${WORKDIR}/p4"
Here is an example that specifies the server URL and port, username, and
-password, and fetches a Revision based on a Label: P4PORT =
-"tcp:p4server.example.net:1666" SRC_URI =
-"p4://user:passwd@example-depot/main/source/..." SRCREV = "release-1.0"
-PV = "p4-${SRCPV}" S = "${WORKDIR}/p4"
+password, and fetches a Revision based on a Label: ::
+
+ P4PORT = "tcp:p4server.example.net:1666"
+ SRC_URI = "p4://user:passwd@example-depot/main/source/..."
+ SRCREV = "release-1.0"
+ PV = "p4-${SRCPV}"
+ S = "${WORKDIR}/p4"
.. note::
- You should always set
- S
- to
- "${WORKDIR}/p4"
- in your recipe.
+ You should always set S to "${WORKDIR}/p4" in your recipe.
By default, the fetcher strips the depot location from the local file paths. In
the above example, the content of ``example-depot/main/source/`` will be placed
in ``${WORKDIR}/p4``. For situations where preserving parts of the remote depot
paths locally is desirable, the fetcher supports two parameters:
-- **"module":**
+- *"module":*
The top-level depot location or directory to fetch. The value of this
parameter can also point to a single file within the depot, in which case
the local file path will include the module path.
-- **"remotepath":**
+- *"remotepath":*
When used with the value "``keep``", the fetcher will mirror the full depot
paths locally for the specified location, even in combination with the
``module`` parameter.
@@ -589,7 +608,7 @@ Repo Fetcher (``repo://``)
This fetcher submodule fetches code from ``google-repo`` source control
system. The fetcher works by initiating and syncing sources of the
repository into :term:`REPODIR`, which is usually
-:term:`DL_DIR`\ ``/repo``.
+``${DL_DIR}/repo``.
This fetcher supports the following parameters:
@@ -600,10 +619,10 @@ This fetcher supports the following parameters:
- *"manifest":* Name of the manifest file (default: ``default.xml``).
-Here are some example URLs: SRC_URI =
-"repo://REPOROOT;protocol=git;branch=some_branch;manifest=my_manifest.xml"
-SRC_URI =
-"repo://REPOROOT;protocol=file;branch=some_branch;manifest=my_manifest.xml"
+Here are some example URLs: ::
+
+ SRC_URI = "repo://REPOROOT;protocol=git;branch=some_branch;manifest=my_manifest.xml"
+ SRC_URI = "repo://REPOROOT;protocol=file;branch=some_branch;manifest=my_manifest.xml"
Other Fetchers
--------------
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-hello.rst b/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
index d64f6e00c..e3fd32158 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
@@ -18,21 +18,28 @@ it.
Obtaining BitBake
=================
-See the "`Obtaining BitBake <#obtaining-bitbake>`__" section for
+See the :ref:`bitbake-user-manual/bitbake-user-manual-hello:obtaining bitbake` section for
information on how to obtain BitBake. Once you have the source code on
-your machine, the BitBake directory appears as follows: $ ls -al total
-100 drwxrwxr-x. 9 wmat wmat 4096 Jan 31 13:44 . drwxrwxr-x. 3 wmat wmat
-4096 Feb 4 10:45 .. -rw-rw-r--. 1 wmat wmat 365 Nov 26 04:55 AUTHORS
-drwxrwxr-x. 2 wmat wmat 4096 Nov 26 04:55 bin drwxrwxr-x. 4 wmat wmat
-4096 Jan 31 13:44 build -rw-rw-r--. 1 wmat wmat 16501 Nov 26 04:55
-ChangeLog drwxrwxr-x. 2 wmat wmat 4096 Nov 26 04:55 classes drwxrwxr-x.
-2 wmat wmat 4096 Nov 26 04:55 conf drwxrwxr-x. 3 wmat wmat 4096 Nov 26
-04:55 contrib -rw-rw-r--. 1 wmat wmat 17987 Nov 26 04:55 COPYING
-drwxrwxr-x. 3 wmat wmat 4096 Nov 26 04:55 doc -rw-rw-r--. 1 wmat wmat 69
-Nov 26 04:55 .gitignore -rw-rw-r--. 1 wmat wmat 849 Nov 26 04:55 HEADER
-drwxrwxr-x. 5 wmat wmat 4096 Jan 31 13:44 lib -rw-rw-r--. 1 wmat wmat
-195 Nov 26 04:55 MANIFEST.in -rw-rw-r--. 1 wmat wmat 2887 Nov 26 04:55
-TODO
+your machine, the BitBake directory appears as follows: ::
+
+ $ ls -al
+ total 100
+ drwxrwxr-x. 9 wmat wmat 4096 Jan 31 13:44 .
+ drwxrwxr-x. 3 wmat wmat 4096 Feb 4 10:45 ..
+ -rw-rw-r--. 1 wmat wmat 365 Nov 26 04:55 AUTHORS
+ drwxrwxr-x. 2 wmat wmat 4096 Nov 26 04:55 bin
+ drwxrwxr-x. 4 wmat wmat 4096 Jan 31 13:44 build
+ -rw-rw-r--. 1 wmat wmat 16501 Nov 26 04:55 ChangeLog
+ drwxrwxr-x. 2 wmat wmat 4096 Nov 26 04:55 classes
+ drwxrwxr-x. 2 wmat wmat 4096 Nov 26 04:55 conf
+ drwxrwxr-x. 3 wmat wmat 4096 Nov 26 04:55 contrib
+ -rw-rw-r--. 1 wmat wmat 17987 Nov 26 04:55 COPYING
+ drwxrwxr-x. 3 wmat wmat 4096 Nov 26 04:55 doc
+ -rw-rw-r--. 1 wmat wmat 69 Nov 26 04:55 .gitignore
+ -rw-rw-r--. 1 wmat wmat 849 Nov 26 04:55 HEADER
+ drwxrwxr-x. 5 wmat wmat 4096 Jan 31 13:44 lib
+ -rw-rw-r--. 1 wmat wmat 195 Nov 26 04:55 MANIFEST.in
+ -rw-rw-r--. 1 wmat wmat 2887 Nov 26 04:55 TODO
At this point, you should have BitBake cloned to a directory that
matches the previous listing except for dates and user names.
@@ -42,18 +49,29 @@ Setting Up the BitBake Environment
First, you need to be sure that you can run BitBake. Set your working
directory to where your local BitBake files are and run the following
-command: $ ./bin/bitbake --version BitBake Build Tool Core version
-1.23.0, bitbake version 1.23.0 The console output tells you what version
+command: ::
+
+ $ ./bin/bitbake --version
+ BitBake Build Tool Core version 1.23.0, bitbake version 1.23.0
+
+The console output tells you what version
you are running.
The recommended method to run BitBake is from a directory of your
choice. To be able to run BitBake from any directory, you need to add
the executable binary to your binary to your shell's environment
``PATH`` variable. First, look at your current ``PATH`` variable by
-entering the following: $ echo $PATH Next, add the directory location
+entering the following: ::
+
+ $ echo $PATH
+
+Next, add the directory location
for the BitBake binary to the ``PATH``. Here is an example that adds the
``/home/scott-lenovo/bitbake/bin`` directory to the front of the
-``PATH`` variable: $ export PATH=/home/scott-lenovo/bitbake/bin:$PATH
+``PATH`` variable: ::
+
+ $ export PATH=/home/scott-lenovo/bitbake/bin:$PATH
+
You should now be able to enter the ``bitbake`` command from the command
line while working from any directory.
@@ -74,8 +92,7 @@ example.
While every attempt is made to explain what is happening during the
example, the descriptions cannot cover everything. You can find further
information throughout this manual. Also, you can actively participate
-in the
-http://lists.openembedded.org/mailman/listinfo/bitbake-devel
+in the :oe_lists:`/g/bitbake-devel`
discussion mailing list about the BitBake build tool.
.. note::
@@ -87,36 +104,46 @@ discussion mailing list about the BitBake build tool.
As stated earlier, the goal of this example is to eventually compile
"Hello World". However, it is unknown what BitBake needs and what you
have to provide in order to achieve that goal. Recall that BitBake
-utilizes three types of metadata files: `Configuration
-Files <#configuration-files>`__, `Classes <#classes>`__, and
-`Recipes <#recipes>`__. But where do they go? How does BitBake find
+utilizes three types of metadata files:
+:ref:`bitbake-user-manual/bitbake-user-manual-intro:configuration files`,
+:ref:`bitbake-user-manual/bitbake-user-manual-intro:classes`, and
+:ref:`bitbake-user-manual/bitbake-user-manual-intro:recipes`.
+But where do they go? How does BitBake find
them? BitBake's error messaging helps you answer these types of
questions and helps you better understand exactly what is going on.
Following is the complete "Hello World" example.
-1. *Create a Project Directory:* First, set up a directory for the
+#. **Create a Project Directory:** First, set up a directory for the
"Hello World" project. Here is how you can do so in your home
- directory: $ mkdir ~/hello $ cd ~/hello This is the directory that
+ directory: ::
+
+ $ mkdir ~/hello
+ $ cd ~/hello
+
+ This is the directory that
BitBake will use to do all of its work. You can use this directory
to keep all the metafiles needed by BitBake. Having a project
directory is a good way to isolate your project.
-2. *Run BitBake:* At this point, you have nothing but a project
- directory. Run the ``bitbake`` command and see what it does: $
- bitbake The BBPATH variable is not set and bitbake did not find a
- conf/bblayers.conf file in the expected location. Maybe you
- accidentally invoked bitbake from the wrong directory? DEBUG:
- Removed the following variables from the environment:
- GNOME_DESKTOP_SESSION_ID, XDG_CURRENT_DESKTOP,
- GNOME_KEYRING_CONTROL, DISPLAY, SSH_AGENT_PID, LANG, no_proxy,
- XDG_SESSION_PATH, XAUTHORITY, SESSION_MANAGER, SHLVL,
- MANDATORY_PATH, COMPIZ_CONFIG_PROFILE, WINDOWID, EDITOR,
- GPG_AGENT_INFO, SSH_AUTH_SOCK, GDMSESSION, GNOME_KEYRING_PID,
- XDG_SEAT_PATH, XDG_CONFIG_DIRS, LESSOPEN, DBUS_SESSION_BUS_ADDRESS,
- \_, XDG_SESSION_COOKIE, DESKTOP_SESSION, LESSCLOSE, DEFAULTS_PATH,
- UBUNTU_MENUPROXY, OLDPWD, XDG_DATA_DIRS, COLORTERM, LS_COLORS The
- majority of this output is specific to environment variables that
+#. **Run BitBake:** At this point, you have nothing but a project
+ directory. Run the ``bitbake`` command and see what it does: ::
+
+ $ bitbake
+ The BBPATH variable is not set and bitbake did not
+ find a conf/bblayers.conf file in the expected location.
+ Maybe you accidentally invoked bitbake from the wrong directory?
+ DEBUG: Removed the following variables from the environment:
+ GNOME_DESKTOP_SESSION_ID, XDG_CURRENT_DESKTOP,
+ GNOME_KEYRING_CONTROL, DISPLAY, SSH_AGENT_PID, LANG, no_proxy,
+ XDG_SESSION_PATH, XAUTHORITY, SESSION_MANAGER, SHLVL,
+ MANDATORY_PATH, COMPIZ_CONFIG_PROFILE, WINDOWID, EDITOR,
+ GPG_AGENT_INFO, SSH_AUTH_SOCK, GDMSESSION, GNOME_KEYRING_PID,
+ XDG_SEAT_PATH, XDG_CONFIG_DIRS, LESSOPEN, DBUS_SESSION_BUS_ADDRESS,
+ _, XDG_SESSION_COOKIE, DESKTOP_SESSION, LESSCLOSE, DEFAULTS_PATH,
+ UBUNTU_MENUPROXY, OLDPWD, XDG_DATA_DIRS, COLORTERM, LS_COLORS
+
+ The majority of this output is specific to environment variables that
are not directly relevant to BitBake. However, the very first
message regarding the ``BBPATH`` variable and the
``conf/bblayers.conf`` file is relevant.
@@ -128,14 +155,18 @@ Following is the complete "Hello World" example.
(``.conf``) or recipe files (``.bb``) at all. BitBake also cannot
find the ``bitbake.conf`` file.
-3. *Setting ``BBPATH``:* For this example, you can set ``BBPATH`` in
+#. **Setting BBPATH:** For this example, you can set ``BBPATH`` in
the same manner that you set ``PATH`` earlier in the appendix. You
should realize, though, that it is much more flexible to set the
``BBPATH`` variable up in a configuration file for each project.
From your shell, enter the following commands to set and export the
- ``BBPATH`` variable: $ BBPATH="projectdirectory" $ export BBPATH Use
- your actual project directory in the command. BitBake uses that
+ ``BBPATH`` variable: ::
+
+ $ BBPATH="projectdirectory"
+ $ export BBPATH
+
+ Use your actual project directory in the command. BitBake uses that
directory to find the metadata it needs for your project.
.. note::
@@ -144,28 +175,32 @@ Following is the complete "Hello World" example.
("~") character as BitBake does not expand that character as the
shell would.
-4. *Run BitBake:* Now that you have ``BBPATH`` defined, run the
- ``bitbake`` command again: $ bitbake ERROR: Traceback (most recent
- call last): File "/home/scott-lenovo/bitbake/lib/bb/cookerdata.py",
- line 163, in wrapped return func(fn, \*args) File
- "/home/scott-lenovo/bitbake/lib/bb/cookerdata.py", line 173, in
- parse_config_file return bb.parse.handle(fn, data, include) File
- "/home/scott-lenovo/bitbake/lib/bb/parse/__init__.py", line 99, in
- handle return h['handle'](fn, data, include) File
- "/home/scott-lenovo/bitbake/lib/bb/parse/parse_py/ConfHandler.py",
- line 120, in handle abs_fn = resolve_file(fn, data) File
- "/home/scott-lenovo/bitbake/lib/bb/parse/__init__.py", line 117, in
- resolve_file raise IOError("file %s not found in %s" % (fn, bbpath))
- IOError: file conf/bitbake.conf not found in
- /home/scott-lenovo/hello ERROR: Unable to parse conf/bitbake.conf:
- file conf/bitbake.conf not found in /home/scott-lenovo/hello This
- sample output shows that BitBake could not find the
+#. **Run BitBake:** Now that you have ``BBPATH`` defined, run the
+ ``bitbake`` command again: ::
+
+ $ bitbake
+ ERROR: Traceback (most recent call last):
+ File "/home/scott-lenovo/bitbake/lib/bb/cookerdata.py", line 163, in wrapped
+ return func(fn, *args)
+ File "/home/scott-lenovo/bitbake/lib/bb/cookerdata.py", line 173, in parse_config_file
+ return bb.parse.handle(fn, data, include)
+ File "/home/scott-lenovo/bitbake/lib/bb/parse/__init__.py", line 99, in handle
+ return h['handle'](fn, data, include)
+ File "/home/scott-lenovo/bitbake/lib/bb/parse/parse_py/ConfHandler.py", line 120, in handle
+ abs_fn = resolve_file(fn, data)
+ File "/home/scott-lenovo/bitbake/lib/bb/parse/__init__.py", line 117, in resolve_file
+ raise IOError("file %s not found in %s" % (fn, bbpath))
+ IOError: file conf/bitbake.conf not found in /home/scott-lenovo/hello
+
+ ERROR: Unable to parse conf/bitbake.conf: file conf/bitbake.conf not found in /home/scott-lenovo/hello
+
+ This sample output shows that BitBake could not find the
``conf/bitbake.conf`` file in the project directory. This file is
the first thing BitBake must find in order to build a target. And,
since the project directory for this example is empty, you need to
provide a ``conf/bitbake.conf`` file.
-5. *Creating ``conf/bitbake.conf``:* The ``conf/bitbake.conf`` includes
+#. **Creating conf/bitbake.conf:** The ``conf/bitbake.conf`` includes
a number of configuration variables BitBake uses for metadata and
recipe files. For this example, you need to create the file in your
project directory and define some key BitBake variables. For more
@@ -173,106 +208,100 @@ Following is the complete "Hello World" example.
http://git.openembedded.org/bitbake/tree/conf/bitbake.conf.
Use the following commands to create the ``conf`` directory in the
- project directory: $ mkdir conf From within the ``conf`` directory,
+ project directory: ::
+
+ $ mkdir conf
+
+ From within the ``conf`` directory,
use some editor to create the ``bitbake.conf`` so that it contains
- the following: :term:`PN` =
- "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0]
- or 'defaultpkgname'}" TMPDIR = "${:term:`TOPDIR`}/tmp"
- :term:`CACHE` = "${TMPDIR}/cache"
- :term:`STAMP` = "${TMPDIR}/${PN}/stamps"
- :term:`T` = "${TMPDIR}/${PN}/work" :term:`B` =
- "${TMPDIR}/${PN}"
+ the following: ::
+
+ PN = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] or 'defaultpkgname'}"
+
+ TMPDIR = "${TOPDIR}/tmp"
+ CACHE = "${TMPDIR}/cache"
+ STAMP = "${TMPDIR}/${PN}/stamps"
+ T = "${TMPDIR}/${PN}/work"
+ B = "${TMPDIR}/${PN}"
.. note::
- Without a value for
- PN
- , the variables
- STAMP
- ,
- T
- , and
- B
- , prevent more than one recipe from working. You can fix this by
- either setting
- PN
- to have a value similar to what OpenEmbedded and BitBake use in
- the default
- bitbake.conf
- file (see previous example). Or, by manually updating each recipe
- to set
- PN
- . You will also need to include
- PN
- as part of the
- STAMP
- ,
- T
- , and
- B
- variable definitions in the
- local.conf
- file.
+ Without a value for PN , the variables STAMP , T , and B , prevent more
+ than one recipe from working. You can fix this by either setting PN to
+ have a value similar to what OpenEmbedded and BitBake use in the default
+ bitbake.conf file (see previous example). Or, by manually updating each
+ recipe to set PN . You will also need to include PN as part of the STAMP
+ , T , and B variable definitions in the local.conf file.
The ``TMPDIR`` variable establishes a directory that BitBake uses
for build output and intermediate files other than the cached
- information used by the `Setscene <#setscene>`__ process. Here, the
- ``TMPDIR`` directory is set to ``hello/tmp``.
+ information used by the
+ :ref:`bitbake-user-manual/bitbake-user-manual-execution:setscene`
+ process. Here, the ``TMPDIR`` directory is set to ``hello/tmp``.
- .. note::
+ .. tip::
- You can always safely delete the
- tmp
- directory in order to rebuild a BitBake target. The build process
- creates the directory for you when you run BitBake.
+ You can always safely delete the tmp directory in order to rebuild a
+ BitBake target. The build process creates the directory for you when you
+ run BitBake.
For information about each of the other variables defined in this
- example, click on the links to take you to the definitions in the
+ example, check :term:`PN`, :term:`TOPDIR`, :term:`CACHE`, :term:`STAMP`,
+ :term:`T` or :term:`B` to take you to the definitions in the
glossary.
-6. *Run BitBake:* After making sure that the ``conf/bitbake.conf`` file
- exists, you can run the ``bitbake`` command again: $ bitbake ERROR:
- Traceback (most recent call last): File
- "/home/scott-lenovo/bitbake/lib/bb/cookerdata.py", line 163, in
- wrapped return func(fn, \*args) File
- "/home/scott-lenovo/bitbake/lib/bb/cookerdata.py", line 177, in
- \_inherit bb.parse.BBHandler.inherit(bbclass, "configuration
- INHERITs", 0, data) File
- "/home/scott-lenovo/bitbake/lib/bb/parse/parse_py/BBHandler.py",
- line 92, in inherit include(fn, file, lineno, d, "inherit") File
- "/home/scott-lenovo/bitbake/lib/bb/parse/parse_py/ConfHandler.py",
- line 100, in include raise ParseError("Could not %(error_out)s file
- %(fn)s" % vars(), oldfn, lineno) ParseError: ParseError in
- configuration INHERITs: Could not inherit file classes/base.bbclass
- ERROR: Unable to parse base: ParseError in configuration INHERITs:
- Could not inherit file classes/base.bbclass In the sample output,
+#. **Run BitBake:** After making sure that the ``conf/bitbake.conf`` file
+ exists, you can run the ``bitbake`` command again: ::
+
+ $ bitbake
+ ERROR: Traceback (most recent call last):
+ File "/home/scott-lenovo/bitbake/lib/bb/cookerdata.py", line 163, in wrapped
+ return func(fn, *args)
+ File "/home/scott-lenovo/bitbake/lib/bb/cookerdata.py", line 177, in _inherit
+ bb.parse.BBHandler.inherit(bbclass, "configuration INHERITs", 0, data)
+ File "/home/scott-lenovo/bitbake/lib/bb/parse/parse_py/BBHandler.py", line 92, in inherit
+ include(fn, file, lineno, d, "inherit")
+ File "/home/scott-lenovo/bitbake/lib/bb/parse/parse_py/ConfHandler.py", line 100, in include
+ raise ParseError("Could not %(error_out)s file %(fn)s" % vars(), oldfn, lineno)
+ ParseError: ParseError in configuration INHERITs: Could not inherit file classes/base.bbclass
+
+ ERROR: Unable to parse base: ParseError in configuration INHERITs: Could not inherit file classes/base.bbclass
+
+ In the sample output,
BitBake could not find the ``classes/base.bbclass`` file. You need
to create that file next.
-7. *Creating ``classes/base.bbclass``:* BitBake uses class files to
+#. **Creating classes/base.bbclass:** BitBake uses class files to
provide common code and functionality. The minimally required class
for BitBake is the ``classes/base.bbclass`` file. The ``base`` class
is implicitly inherited by every recipe. BitBake looks for the class
in the ``classes`` directory of the project (i.e ``hello/classes``
in this example).
- Create the ``classes`` directory as follows: $ cd $HOME/hello $
- mkdir classes Move to the ``classes`` directory and then create the
+ Create the ``classes`` directory as follows: ::
+
+ $ cd $HOME/hello
+ $ mkdir classes
+
+ Move to the ``classes`` directory and then create the
``base.bbclass`` file by inserting this single line: addtask build
The minimal task that BitBake runs is the ``do_build`` task. This is
all the example needs in order to build the project. Of course, the
``base.bbclass`` can have much more depending on which build
environments BitBake is supporting.
-8. *Run BitBake:* After making sure that the ``classes/base.bbclass``
- file exists, you can run the ``bitbake`` command again: $ bitbake
- Nothing to do. Use 'bitbake world' to build everything, or run
- 'bitbake --help' for usage information. BitBake is finally reporting
+#. **Run BitBake:** After making sure that the ``classes/base.bbclass``
+ file exists, you can run the ``bitbake`` command again: ::
+
+ $ bitbake
+ Nothing to do. Use 'bitbake world' to build everything, or run 'bitbake --help' for usage information.
+
+ BitBake is finally reporting
no errors. However, you can see that it really does not have
anything to do. You need to create a recipe that gives BitBake
something to do.
-9. *Creating a Layer:* While it is not really necessary for such a
+#. **Creating a Layer:** While it is not really necessary for such a
small example, it is good practice to create a layer in which to
keep your code separate from the general metadata used by BitBake.
Thus, this example creates and uses a layer called "mylayer".
@@ -285,78 +314,102 @@ Following is the complete "Hello World" example.
Minimally, you need a recipe file and a layer configuration file in
your layer. The configuration file needs to be in the ``conf``
directory inside the layer. Use these commands to set up the layer
- and the ``conf`` directory: $ cd $HOME $ mkdir mylayer $ cd mylayer
- $ mkdir conf Move to the ``conf`` directory and create a
- ``layer.conf`` file that has the following: BBPATH .=
- ":${:term:`LAYERDIR`}" :term:`BBFILES`
- += "${LAYERDIR}/\*.bb"
- :term:`BBFILE_COLLECTIONS` += "mylayer"
- `BBFILE_PATTERN_mylayer <#var-bb-BBFILE_PATTERN>`__ :=
- "^${LAYERDIR_RE}/" For information on these variables, click the
- links to go to the definitions in the glossary.
+ and the ``conf`` directory: ::
+
+ $ cd $HOME
+ $ mkdir mylayer
+ $ cd mylayer
+ $ mkdir conf
+
+ Move to the ``conf`` directory and create a ``layer.conf`` file that has the
+ following: ::
+
+ BBPATH .= ":${LAYERDIR}"
+ BBFILES += "${LAYERDIR}/\*.bb"
+ BBFILE_COLLECTIONS += "mylayer"
+ `BBFILE_PATTERN_mylayer := "^${LAYERDIR_RE}/"
+
+ For information on these variables, click on :term:`BBFILES`,
+ :term:`LAYERDIR`, :term:`BBFILE_COLLECTIONS` or :term:`BBFILE_PATTERN_mylayer <BBFILE_PATTERN>`
+ to go to the definitions in the glossary.
You need to create the recipe file next. Inside your layer at the
top-level, use an editor and create a recipe file named
- ``printhello.bb`` that has the following:
- :term:`DESCRIPTION` = "Prints Hello World"
- :term:`PN` = 'printhello' :term:`PV` = '1' python
- do_build() { bb.plain("********************"); bb.plain("\* \*");
- bb.plain("\* Hello, World! \*"); bb.plain("\* \*");
- bb.plain("********************"); } The recipe file simply provides
+ ``printhello.bb`` that has the following: ::
+
+ DESCRIPTION = "Prints Hello World"
+ PN = 'printhello'
+ PV = '1'
+
+ python do_build() {
+ bb.plain("********************");
+ bb.plain("* *");
+ bb.plain("* Hello, World! *");
+ bb.plain("* *");
+ bb.plain("********************");
+ }
+
+ The recipe file simply provides
a description of the recipe, the name, version, and the ``do_build``
task, which prints out "Hello World" to the console. For more
- information on these variables, follow the links to the glossary.
+ information on :term:`DESCRIPTION`, :term:`PN` or :term:`PV`
+ follow the links to the glossary.
+
+#. **Run BitBake With a Target:** Now that a BitBake target exists, run
+ the command and provide that target: ::
-10. *Run BitBake With a Target:* Now that a BitBake target exists, run
- the command and provide that target: $ cd $HOME/hello $ bitbake
- printhello ERROR: no recipe files to build, check your BBPATH and
- BBFILES? Summary: There was 1 ERROR message shown, returning a
- non-zero exit code. We have created the layer with the recipe and
+ $ cd $HOME/hello
+ $ bitbake printhello
+ ERROR: no recipe files to build, check your BBPATH and BBFILES?
+
+ Summary: There was 1 ERROR message shown, returning a non-zero exit code.
+
+ We have created the layer with the recipe and
the layer configuration file but it still seems that BitBake cannot
find the recipe. BitBake needs a ``conf/bblayers.conf`` that lists
the layers for the project. Without this file, BitBake cannot find
the recipe.
-11. *Creating ``conf/bblayers.conf``:* BitBake uses the
+#. **Creating conf/bblayers.conf:** BitBake uses the
``conf/bblayers.conf`` file to locate layers needed for the project.
This file must reside in the ``conf`` directory of the project (i.e.
``hello/conf`` for this example).
Set your working directory to the ``hello/conf`` directory and then
- create the ``bblayers.conf`` file so that it contains the following:
- BBLAYERS ?= " \\ /home/<you>/mylayer \\ " You need to provide your
- own information for ``you`` in the file.
+ create the ``bblayers.conf`` file so that it contains the following: ::
+
+ BBLAYERS ?= " \
+ /home/<you>/mylayer \
+ "
+
+ You need to provide your own information for ``you`` in the file.
-12. *Run BitBake With a Target:* Now that you have supplied the
+#. **Run BitBake With a Target:** Now that you have supplied the
``bblayers.conf`` file, run the ``bitbake`` command and provide the
- target: $ bitbake printhello Parsing recipes: 100%
- \|##################################################################################\|
- Time: 00:00:00 Parsing of 1 .bb files complete (0 cached, 1 parsed).
- 1 targets, 0 skipped, 0 masked, 0 errors. NOTE: Resolving any
- missing task queue dependencies NOTE: Preparing RunQueue NOTE:
- Executing RunQueue Tasks \*******************\* \* \* \* Hello,
- World! \* \* \* \*******************\* NOTE: Tasks Summary:
- Attempted 1 tasks of which 0 didn't need to be rerun and all
- succeeded. BitBake finds the ``printhello`` recipe and successfully
- runs the task.
+ target: ::
+
+ $ bitbake printhello
+ Parsing recipes: 100% |##################################################################################|
+ Time: 00:00:00
+ Parsing of 1 .bb files complete (0 cached, 1 parsed). 1 targets, 0 skipped, 0 masked, 0 errors.
+ NOTE: Resolving any missing task queue dependencies
+ NOTE: Preparing RunQueue
+ NOTE: Executing RunQueue Tasks
+ ********************
+ * *
+ * Hello, World! *
+ * *
+ ********************
+ NOTE: Tasks Summary: Attempted 1 tasks of which 0 didn't need to be rerun and all succeeded.
.. note::
- After the first execution, re-running
- bitbake printhello
- again will not result in a BitBake run that prints the same
- console output. The reason for this is that the first time the
- printhello.bb
- recipe's
- do_build
- task executes successfully, BitBake writes a stamp file for the
- task. Thus, the next time you attempt to run the task using that
- same
- bitbake
- command, BitBake notices the stamp and therefore determines that
- the task does not need to be re-run. If you delete the
- tmp
- directory or run
- bitbake -c clean printhello
- and then re-run the build, the "Hello, World!" message will be
- printed again.
+ After the first execution, re-running bitbake printhello again will not
+ result in a BitBake run that prints the same console output. The reason
+ for this is that the first time the printhello.bb recipe's do_build task
+ executes successfully, BitBake writes a stamp file for the task. Thus,
+ the next time you attempt to run the task using that same bitbake
+ command, BitBake notices the stamp and therefore determines that the task
+ does not need to be re-run. If you delete the tmp directory or run
+ bitbake -c clean printhello and then re-run the build, the "Hello,
+ World!" message will be printed again.
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
index 34abda2db..77dc9668a 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
@@ -248,19 +248,23 @@ underlying, similarly-named recipe files.
When you name an append file, you can use the "``%``" wildcard character
to allow for matching recipe names. For example, suppose you have an
-append file named as follows: busybox_1.21.%.bbappend That append file
+append file named as follows: ::
+
+ busybox_1.21.%.bbappend
+
+That append file
would match any ``busybox_1.21.``\ x\ ``.bb`` version of the recipe. So,
-the append file would match the following recipe names:
-busybox_1.21.1.bb busybox_1.21.2.bb busybox_1.21.3.bb
+the append file would match the following recipe names: ::
+
+ busybox_1.21.1.bb
+ busybox_1.21.2.bb
+ busybox_1.21.3.bb
.. note::
- The use of the "
- %
- " character is limited in that it only works directly in front of the
- .bbappend
- portion of the append file's name. You cannot use the wildcard
- character in any other location of the name.
+ The use of the " % " character is limited in that it only works directly in
+ front of the .bbappend portion of the append file's name. You cannot use the
+ wildcard character in any other location of the name.
If the ``busybox`` recipe was updated to ``busybox_1.3.0.bb``, the
append name would not match. However, if you named the append file
@@ -274,7 +278,7 @@ Obtaining BitBake
You can obtain BitBake several different ways:
-- *Cloning BitBake:* Using Git to clone the BitBake source code
+- **Cloning BitBake:** Using Git to clone the BitBake source code
repository is the recommended method for obtaining BitBake. Cloning
the repository makes it easy to get bug fixes and have access to
stable branches and the master branch. Once you have cloned BitBake,
@@ -286,36 +290,42 @@ You can obtain BitBake several different ways:
are using. The metadata is generally backwards compatible but not
forward compatible.
- Here is an example that clones the BitBake repository: $ git clone
- git://git.openembedded.org/bitbake This command clones the BitBake
+ Here is an example that clones the BitBake repository: ::
+
+ $ git clone git://git.openembedded.org/bitbake
+
+ This command clones the BitBake
Git repository into a directory called ``bitbake``. Alternatively,
you can designate a directory after the ``git clone`` command if you
want to call the new directory something other than ``bitbake``. Here
- is an example that names the directory ``bbdev``: $ git clone
- git://git.openembedded.org/bitbake bbdev
+ is an example that names the directory ``bbdev``: ::
+
+ $ git clone git://git.openembedded.org/bitbake bbdev
-- *Installation using your Distribution Package Management System:*
+- **Installation using your Distribution Package Management System:**
This method is not recommended because the BitBake version that is
provided by your distribution, in most cases, is several releases
behind a snapshot of the BitBake repository.
-- *Taking a snapshot of BitBake:* Downloading a snapshot of BitBake
+- **Taking a snapshot of BitBake:** Downloading a snapshot of BitBake
from the source code repository gives you access to a known branch or
release of BitBake.
- .. note::
+ .. note::
+
+ Cloning the Git repository, as described earlier, is the preferred
+ method for getting BitBake. Cloning the repository makes it easier
+ to update as patches are added to the stable branches.
+
+ The following example downloads a snapshot of BitBake version 1.17.0: ::
- Cloning the Git repository, as described earlier, is the preferred
- method for getting BitBake. Cloning the repository makes it easier
- to update as patches are added to the stable branches.
+ $ wget http://git.openembedded.org/bitbake/snapshot/bitbake-1.17.0.tar.gz
+ $ tar zxpvf bitbake-1.17.0.tar.gz
- The following example downloads a snapshot of BitBake version 1.17.0:
- $ wget
- http://git.openembedded.org/bitbake/snapshot/bitbake-1.17.0.tar.gz $
- tar zxpvf bitbake-1.17.0.tar.gz After extraction of the tarball using
+ After extraction of the tarball using
the tar utility, you have a directory entitled ``bitbake-1.17.0``.
-- *Using the BitBake that Comes With Your Build Checkout:* A final
+- **Using the BitBake that Comes With Your Build Checkout:** A final
possibility for getting a copy of BitBake is that it already comes
with your checkout of a larger BitBake-based build system, such as
Poky. Rather than manually checking out individual layers and gluing
@@ -337,75 +347,108 @@ execution examples.
Usage and syntax
----------------
-Following is the usage and syntax for BitBake: $ bitbake -h Usage:
-bitbake [options] [recipename/target recipe:do_task ...] Executes the
-specified task (default is 'build') for a given set of target recipes
-(.bb files). It is assumed there is a conf/bblayers.conf available in
-cwd or in BBPATH which will provide the layer, BBFILES and other
-configuration information. Options: --version show program's version
-number and exit -h, --help show this help message and exit -b BUILDFILE,
---buildfile=BUILDFILE Execute tasks from a specific .bb recipe directly.
-WARNING: Does not handle any dependencies from other recipes. -k,
---continue Continue as much as possible after an error. While the target
-that failed and anything depending on it cannot be built, as much as
-possible will be built before stopping. -f, --force Force the specified
-targets/task to run (invalidating any existing stamp file). -c CMD,
---cmd=CMD Specify the task to execute. The exact options available
-depend on the metadata. Some examples might be 'compile' or
-'populate_sysroot' or 'listtasks' may give a list of the tasks
-available. -C INVALIDATE_STAMP, --clear-stamp=INVALIDATE_STAMP
-Invalidate the stamp for the specified task such as 'compile' and then
-run the default task for the specified target(s). -r PREFILE,
---read=PREFILE Read the specified file before bitbake.conf. -R POSTFILE,
---postread=POSTFILE Read the specified file after bitbake.conf. -v,
---verbose Enable tracing of shell tasks (with 'set -x'). Also print
-bb.note(...) messages to stdout (in addition to writing them to
-${T}/log.do_<task>). -D, --debug Increase the debug level. You can
-specify this more than once. -D sets the debug level to 1, where only
-bb.debug(1, ...) messages are printed to stdout; -DD sets the debug
-level to 2, where both bb.debug(1, ...) and bb.debug(2, ...) messages
-are printed; etc. Without -D, no debug messages are printed. Note that
--D only affects output to stdout. All debug messages are written to
-${T}/log.do_taskname, regardless of the debug level. -q, --quiet Output
-less log message data to the terminal. You can specify this more than
-once. -n, --dry-run Don't execute, just go through the motions. -S
-SIGNATURE_HANDLER, --dump-signatures=SIGNATURE_HANDLER Dump out the
-signature construction information, with no task execution. The
-SIGNATURE_HANDLER parameter is passed to the handler. Two common values
-are none and printdiff but the handler may define more/less. none means
-only dump the signature, printdiff means compare the dumped signature
-with the cached one. -p, --parse-only Quit after parsing the BB recipes.
--s, --show-versions Show current and preferred versions of all recipes.
--e, --environment Show the global or per-recipe environment complete
-with information about where variables were set/changed. -g, --graphviz
-Save dependency tree information for the specified targets in the dot
-syntax. -I EXTRA_ASSUME_PROVIDED, --ignore-deps=EXTRA_ASSUME_PROVIDED
-Assume these dependencies don't exist and are already provided
-(equivalent to ASSUME_PROVIDED). Useful to make dependency graphs more
-appealing -l DEBUG_DOMAINS, --log-domains=DEBUG_DOMAINS Show debug
-logging for the specified logging domains -P, --profile Profile the
-command and save reports. -u UI, --ui=UI The user interface to use
-(knotty, ncurses or taskexp - default knotty). --token=XMLRPCTOKEN
-Specify the connection token to be used when connecting to a remote
-server. --revisions-changed Set the exit code depending on whether
-upstream floating revisions have changed or not. --server-only Run
-bitbake without a UI, only starting a server (cooker) process. -B BIND,
---bind=BIND The name/address for the bitbake xmlrpc server to bind to.
--T SERVER_TIMEOUT, --idle-timeout=SERVER_TIMEOUT Set timeout to unload
-bitbake server due to inactivity, set to -1 means no unload, default:
-Environment variable BB_SERVER_TIMEOUT. --no-setscene Do not run any
-setscene tasks. sstate will be ignored and everything needed, built.
---setscene-only Only run setscene tasks, don't run any real tasks.
---remote-server=REMOTE_SERVER Connect to the specified server. -m,
---kill-server Terminate any running bitbake server. --observe-only
-Connect to a server as an observing-only client. --status-only Check the
-status of the remote bitbake server. -w WRITEEVENTLOG,
---write-log=WRITEEVENTLOG Writes the event log of the build to a bitbake
-event json file. Use '' (empty string) to assign the name automatically.
---runall=RUNALL Run the specified task for any recipe in the taskgraph
-of the specified target (even if it wouldn't otherwise have run).
---runonly=RUNONLY Run only the specified task within the taskgraph of
-the specified targets (and any task dependencies those tasks may have).
+Following is the usage and syntax for BitBake: ::
+
+ $ bitbake -h
+ Usage: bitbake [options] [recipename/target recipe:do_task ...]
+
+ Executes the specified task (default is 'build') for a given set of target recipes (.bb files).
+ It is assumed there is a conf/bblayers.conf available in cwd or in BBPATH which
+ will provide the layer, BBFILES and other configuration information.
+
+ Options:
+ --version show program's version number and exit
+ -h, --help show this help message and exit
+ -b BUILDFILE, --buildfile=BUILDFILE
+ Execute tasks from a specific .bb recipe directly.
+ WARNING: Does not handle any dependencies from other
+ recipes.
+ -k, --continue Continue as much as possible after an error. While the
+ target that failed and anything depending on it cannot
+ be built, as much as possible will be built before
+ stopping.
+ -f, --force Force the specified targets/task to run (invalidating
+ any existing stamp file).
+ -c CMD, --cmd=CMD Specify the task to execute. The exact options
+ available depend on the metadata. Some examples might
+ be 'compile' or 'populate_sysroot' or 'listtasks' may
+ give a list of the tasks available.
+ -C INVALIDATE_STAMP, --clear-stamp=INVALIDATE_STAMP
+ Invalidate the stamp for the specified task such as
+ 'compile' and then run the default task for the
+ specified target(s).
+ -r PREFILE, --read=PREFILE
+ Read the specified file before bitbake.conf.
+ -R POSTFILE, --postread=POSTFILE
+ Read the specified file after bitbake.conf.
+ -v, --verbose Enable tracing of shell tasks (with 'set -x'). Also
+ print bb.note(...) messages to stdout (in addition to
+ writing them to ${T}/log.do_&lt;task&gt;).
+ -D, --debug Increase the debug level. You can specify this more
+ than once. -D sets the debug level to 1, where only
+ bb.debug(1, ...) messages are printed to stdout; -DD
+ sets the debug level to 2, where both bb.debug(1, ...)
+ and bb.debug(2, ...) messages are printed; etc.
+ Without -D, no debug messages are printed. Note that
+ -D only affects output to stdout. All debug messages
+ are written to ${T}/log.do_taskname, regardless of the
+ debug level.
+ -q, --quiet Output less log message data to the terminal. You can
+ specify this more than once.
+ -n, --dry-run Don't execute, just go through the motions.
+ -S SIGNATURE_HANDLER, --dump-signatures=SIGNATURE_HANDLER
+ Dump out the signature construction information, with
+ no task execution. The SIGNATURE_HANDLER parameter is
+ passed to the handler. Two common values are none and
+ printdiff but the handler may define more/less. none
+ means only dump the signature, printdiff means compare
+ the dumped signature with the cached one.
+ -p, --parse-only Quit after parsing the BB recipes.
+ -s, --show-versions Show current and preferred versions of all recipes.
+ -e, --environment Show the global or per-recipe environment complete
+ with information about where variables were
+ set/changed.
+ -g, --graphviz Save dependency tree information for the specified
+ targets in the dot syntax.
+ -I EXTRA_ASSUME_PROVIDED, --ignore-deps=EXTRA_ASSUME_PROVIDED
+ Assume these dependencies don't exist and are already
+ provided (equivalent to ASSUME_PROVIDED). Useful to
+ make dependency graphs more appealing
+ -l DEBUG_DOMAINS, --log-domains=DEBUG_DOMAINS
+ Show debug logging for the specified logging domains
+ -P, --profile Profile the command and save reports.
+ -u UI, --ui=UI The user interface to use (knotty, ncurses or taskexp
+ - default knotty).
+ --token=XMLRPCTOKEN Specify the connection token to be used when
+ connecting to a remote server.
+ --revisions-changed Set the exit code depending on whether upstream
+ floating revisions have changed or not.
+ --server-only Run bitbake without a UI, only starting a server
+ (cooker) process.
+ -B BIND, --bind=BIND The name/address for the bitbake xmlrpc server to bind
+ to.
+ -T SERVER_TIMEOUT, --idle-timeout=SERVER_TIMEOUT
+ Set timeout to unload bitbake server due to
+ inactivity, set to -1 means no unload, default:
+ Environment variable BB_SERVER_TIMEOUT.
+ --no-setscene Do not run any setscene tasks. sstate will be ignored
+ and everything needed, built.
+ --setscene-only Only run setscene tasks, don't run any real tasks.
+ --remote-server=REMOTE_SERVER
+ Connect to the specified server.
+ -m, --kill-server Terminate any running bitbake server.
+ --observe-only Connect to a server as an observing-only client.
+ --status-only Check the status of the remote bitbake server.
+ -w WRITEEVENTLOG, --write-log=WRITEEVENTLOG
+ Writes the event log of the build to a bitbake event
+ json file. Use '' (empty string) to assign the name
+ automatically.
+ --runall=RUNALL Run the specified task for any recipe in the taskgraph
+ of the specified target (even if it wouldn't otherwise
+ have run).
+ --runonly=RUNONLY Run only the specified task within the taskgraph of
+ the specified targets (and any task dependencies those
+ tasks may have).
.. _bitbake-examples:
@@ -426,9 +469,13 @@ default task, which is "build”. BitBake obeys inter-task dependencies
when doing so.
The following command runs the build task, which is the default task, on
-the ``foo_1.0.bb`` recipe file: $ bitbake -b foo_1.0.bb The following
-command runs the clean task on the ``foo.bb`` recipe file: $ bitbake -b
-foo.bb -c clean
+the ``foo_1.0.bb`` recipe file: ::
+
+ $ bitbake -b foo_1.0.bb
+
+The following command runs the clean task on the ``foo.bb`` recipe file: ::
+
+ $ bitbake -b foo.bb -c clean
.. note::
@@ -450,9 +497,15 @@ functionality, or when there are multiple versions of a recipe.
The ``bitbake`` command, when not using "--buildfile" or "-b" only
accepts a "PROVIDES". You cannot provide anything else. By default, a
recipe file generally "PROVIDES" its "packagename" as shown in the
-following example: $ bitbake foo This next example "PROVIDES" the
+following example: ::
+
+ $ bitbake foo
+
+This next example "PROVIDES" the
package name and also uses the "-c" option to tell BitBake to just
-execute the ``do_clean`` task: $ bitbake -c clean foo
+execute the ``do_clean`` task: ::
+
+ $ bitbake -c clean foo
Executing a List of Task and Recipe Combinations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -461,8 +514,9 @@ The BitBake command line supports specifying different tasks for
individual targets when you specify multiple targets. For example,
suppose you had two targets (or recipes) ``myfirstrecipe`` and
``mysecondrecipe`` and you needed BitBake to run ``taskA`` for the first
-recipe and ``taskB`` for the second recipe: $ bitbake
-myfirstrecipe:do_taskA mysecondrecipe:do_taskB
+recipe and ``taskB`` for the second recipe: ::
+
+ $ bitbake myfirstrecipe:do_taskA mysecondrecipe:do_taskB
Generating Dependency Graphs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -474,10 +528,10 @@ You can convert these graphs into images using the ``dot`` tool from
When you generate a dependency graph, BitBake writes two files to the
current working directory:
-- *``task-depends.dot``:* Shows dependencies between tasks. These
+- ``task-depends.dot``: Shows dependencies between tasks. These
dependencies match BitBake's internal task execution list.
-- *``pn-buildlist``:* Shows a simple list of targets that are to be
+- ``pn-buildlist``: Shows a simple list of targets that are to be
built.
To stop depending on common depends, use the "-I" depend option and
@@ -486,8 +540,11 @@ produce more readable graphs. This way, you can remove from the graph
``DEPENDS`` from inherited classes such as ``base.bbclass``.
Here are two examples that create dependency graphs. The second example
-omits depends common in OpenEmbedded from the graph: $ bitbake -g foo $
-bitbake -g -I virtual/kernel -I eglibc foo
+omits depends common in OpenEmbedded from the graph: ::
+
+ $ bitbake -g foo
+
+ $ bitbake -g -I virtual/kernel -I eglibc foo
Executing a Multiple Configuration Build
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -504,6 +561,9 @@ files is specific. They must reside in the current build directory in a
sub-directory of ``conf`` named ``multiconfig``. Following is an example
for two separate targets:
+.. image:: figures/bb_multiconfig_files.png
+ :align: center
+
The reason for this required file hierarchy is because the ``BBPATH``
variable is not constructed until the layers are parsed. Consequently,
using the configuration file as a pre-configuration file is not possible
@@ -522,14 +582,19 @@ accomplished by setting the
configuration files for ``target1`` and ``target2`` defined in the build
directory. The following statement in the ``local.conf`` file both
enables BitBake to perform multiple configuration builds and specifies
-the two extra multiconfigs: BBMULTICONFIG = "target1 target2"
+the two extra multiconfigs: ::
+
+ BBMULTICONFIG = "target1 target2"
Once the target configuration files are in place and BitBake has been
enabled to perform multiple configuration builds, use the following
-command form to start the builds: $ bitbake [mc:multiconfigname:]target
-[[[mc:multiconfigname:]target] ... ] Here is an example for two extra
-multiconfigs: ``target1`` and ``target2``: $ bitbake mc::target
-mc:target1:target mc:target2:target
+command form to start the builds: ::
+
+ $ bitbake [mc:multiconfigname:]target [[[mc:multiconfigname:]target] ... ]
+
+Here is an example for two extra multiconfigs: ``target1`` and ``target2``: ::
+
+ $ bitbake mc::target mc:target1:target mc:target2:target
.. _bb-enabling-multiple-configuration-build-dependencies:
@@ -548,26 +613,37 @@ multiconfig.
To enable dependencies in a multiple configuration build, you must
declare the dependencies in the recipe using the following statement
-form: task_or_package[mcdepends] =
-"mc:from_multiconfig:to_multiconfig:recipe_name:task_on_which_to_depend"
+form: ::
+
+ task_or_package[mcdepends] = "mc:from_multiconfig:to_multiconfig:recipe_name:task_on_which_to_depend"
+
To better show how to use this statement, consider an example with two
-multiconfigs: ``target1`` and ``target2``: image_task[mcdepends] =
-"mc:target1:target2:image2:rootfs_task" In this example, the
-from_multiconfig is "target1" and the to_multiconfig is "target2". The
+multiconfigs: ``target1`` and ``target2``: ::
+
+ image_task[mcdepends] = "mc:target1:target2:image2:rootfs_task"
+
+In this example, the
+``from_multiconfig`` is "target1" and the ``to_multiconfig`` is "target2". The
task on which the image whose recipe contains image_task depends on the
completion of the rootfs_task used to build out image2, which is
associated with the "target2" multiconfig.
Once you set up this dependency, you can build the "target1" multiconfig
-using a BitBake command as follows: $ bitbake mc:target1:image1 This
-command executes all the tasks needed to create image1 for the "target1"
+using a BitBake command as follows: ::
+
+ $ bitbake mc:target1:image1
+
+This command executes all the tasks needed to create ``image1`` for the "target1"
multiconfig. Because of the dependency, BitBake also executes through
-the rootfs_task for the "target2" multiconfig build.
+the ``rootfs_task`` for the "target2" multiconfig build.
Having a recipe depend on the root filesystem of another build might not
seem that useful. Consider this change to the statement in the image1
-recipe: image_task[mcdepends] = "mc:target1:target2:image2:image_task"
-In this case, BitBake must create image2 for the "target2" build since
+recipe: ::
+
+ image_task[mcdepends] = "mc:target1:target2:image2:image_task"
+
+In this case, BitBake must create ``image2`` for the "target2" build since
the "target1" build depends on it.
Because "target1" and "target2" are enabled for multiple configuration
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
index 4de70e8e1..12491c594 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -21,16 +21,28 @@ Basic Variable Setting
The following example sets ``VARIABLE`` to "value". This assignment
occurs immediately as the statement is parsed. It is a "hard"
-assignment. VARIABLE = "value" As expected, if you include leading or
-trailing spaces as part of an assignment, the spaces are retained:
-VARIABLE = " value" VARIABLE = "value " Setting ``VARIABLE`` to "" sets
+assignment. ::
+
+ VARIABLE = "value"
+
+As expected, if you include leading or
+trailing spaces as part of an assignment, the spaces are retained: ::
+
+ VARIABLE = " value"
+ VARIABLE = "value "
+
+Setting ``VARIABLE`` to "" sets
it to an empty string, while setting the variable to " " sets it to a
-blank space (i.e. these are not the same values). VARIABLE = "" VARIABLE
-= " "
+blank space (i.e. these are not the same values). ::
+
+ VARIABLE = ""
+ VARIABLE = " "
You can use single quotes instead of double quotes when setting a
variable's value. Doing so allows you to use values that contain the
-double quote character: VARIABLE = 'I have a " in my value'
+double quote character: ::
+
+ VARIABLE = 'I have a " in my value'
.. note::
@@ -65,7 +77,11 @@ occurs, you can use BitBake to check the actual value of the suspect
variable. You can make these checks for both configuration and recipe
level changes:
-- For configuration changes, use the following: $ bitbake -e This
+- For configuration changes, use the following: ::
+
+ $ bitbake -e
+
+ This
command displays variable values after the configuration files (i.e.
``local.conf``, ``bblayers.conf``, ``bitbake.conf`` and so forth)
have been parsed.
@@ -75,33 +91,43 @@ level changes:
Variables that are exported to the environment are preceded by the
string "export" in the command's output.
-- For recipe changes, use the following: $ bitbake recipe -e \| grep
- VARIABLE=" This command checks to see if the variable actually makes
+- For recipe changes, use the following: ::
+
+ $ bitbake recipe -e \| grep VARIABLE="
+
+ This command checks to see if the variable actually makes
it into a specific recipe.
Line Joining
------------
-Outside of `functions <#functions>`__, BitBake joins any line ending in
+Outside of :ref:`functions <bitbake-user-manual/bitbake-user-manual-metadata:functions>`,
+BitBake joins any line ending in
a backslash character ("\") with the following line before parsing
statements. The most common use for the "\" character is to split
-variable assignments over multiple lines, as in the following example:
-FOO = "bar \\ baz \\ qaz" Both the "\" character and the newline
+variable assignments over multiple lines, as in the following example: ::
+
+ FOO = "bar \
+ baz \
+ qaz"
+
+Both the "\" character and the newline
character that follow it are removed when joining lines. Thus, no
newline characters end up in the value of ``FOO``.
Consider this additional example where the two assignments both assign
-"barbaz" to ``FOO``: FOO = "barbaz" FOO = "bar\\ baz"
+"barbaz" to ``FOO``: ::
+
+ FOO = "barbaz"
+ FOO = "bar\
+ baz"
.. note::
BitBake does not interpret escape sequences like "\n" in variable
values. For these to have an effect, the value must be passed to some
utility that interprets escape sequences, such as
- printf
- or
- echo -n
- .
+ ``printf`` or ``echo -n``.
Variable Expansion
------------------
@@ -109,32 +135,41 @@ Variable Expansion
Variables can reference the contents of other variables using a syntax
that is similar to variable expansion in Bourne shells. The following
assignments result in A containing "aval" and B evaluating to
-"preavalpost". A = "aval" B = "pre${A}post"
+"preavalpost". ::
+
+ A = "aval"
+ B = "pre${A}post"
.. note::
- Unlike in Bourne shells, the curly braces are mandatory: Only
- ${FOO}
- and not
- $FOO
- is recognized as an expansion of
- FOO
- .
+ Unlike in Bourne shells, the curly braces are mandatory: Only ``${FOO}`` and not
+ ``$FOO`` is recognized as an expansion of ``FOO``.
The "=" operator does not immediately expand variable references in the
right-hand side. Instead, expansion is deferred until the variable
assigned to is actually used. The result depends on the current values
of the referenced variables. The following example should clarify this
-behavior: A = "${B} baz" B = "${C} bar" C = "foo" \*At this point, ${A}
-equals "foo bar baz"\* C = "qux" \*At this point, ${A} equals "qux bar
-baz"\* B = "norf" \*At this point, ${A} equals "norf baz"\* Contrast
-this behavior with the `immediate variable
-expansion <#immediate-variable-expansion>`__ operator (i.e. ":=").
+behavior: ::
+
+ A = "${B} baz"
+ B = "${C} bar"
+ C = "foo"
+ *At this point, ${A} equals "foo bar baz"*
+ C = "qux"
+ *At this point, ${A} equals "qux bar baz"*
+ B = "norf"
+ *At this point, ${A} equals "norf baz"\*
+
+Contrast this behavior with the
+:ref:`bitbake-user-manual/bitbake-user-manual-metadata:immediate variable
+expansion (:=)` operator.
If the variable expansion syntax is used on a variable that does not
exist, the string is kept as is. For example, given the following
assignment, ``BAR`` expands to the literal string "${FOO}" as long as
-``FOO`` does not exist. BAR = "${FOO}"
+``FOO`` does not exist. ::
+
+ BAR = "${FOO}"
Setting a default value (?=)
----------------------------
@@ -142,7 +177,11 @@ Setting a default value (?=)
You can use the "?=" operator to achieve a "softer" assignment for a
variable. This type of assignment allows you to define a variable if it
is undefined when the statement is parsed, but to leave the value alone
-if the variable has a value. Here is an example: A ?= "aval" If ``A`` is
+if the variable has a value. Here is an example: ::
+
+ A ?= "aval"
+
+If ``A`` is
set at the time this statement is parsed, the variable retains its
value. However, if ``A`` is not set, the variable is set to "aval".
@@ -160,8 +199,12 @@ by using the "??=" operator. This assignment behaves identical to "?="
except that the assignment is made at the end of the parsing process
rather than immediately. Consequently, when multiple "??=" assignments
exist, the last one is used. Also, any "=" or "?=" assignment will
-override the value set with "??=". Here is an example: A ??= "somevalue"
-A ??= "someothervalue" If ``A`` is set before the above statements are
+override the value set with "??=". Here is an example: ::
+
+ A ??= "somevalue"
+ A ??= "someothervalue"
+
+If ``A`` is set before the above statements are
parsed, the variable retains its value. If ``A`` is not set, the
variable is set to "someothervalue".
@@ -172,8 +215,15 @@ Immediate variable expansion (:=)
---------------------------------
The ":=" operator results in a variable's contents being expanded
-immediately, rather than when the variable is actually used: T = "123" A
-:= "test ${T}" T = "456" B := "${T} ${C}" C = "cval" C := "${C}append"
+immediately, rather than when the variable is actually used: ::
+
+ T = "123"
+ A := "test ${T}"
+ T = "456"
+ B := "${T} ${C}"
+ C = "cval"
+ C := "${C}append"
+
In this example, ``A`` contains "test 123", even though the final value
of ``T`` is "456". The variable ``B`` will end up containing "456
cvalappend". This is because references to undefined variables are
@@ -191,8 +241,14 @@ the "+=" and "=+" operators. These operators insert a space between the
current value and prepended or appended value.
These operators take immediate effect during parsing. Here are some
-examples: B = "bval" B += "additionaldata" C = "cval" C =+ "test" The
-variable ``B`` contains "bval additionaldata" and ``C`` contains "test
+examples: ::
+
+ B = "bval"
+ B += "additionaldata"
+ C = "cval"
+ C =+ "test"
+
+The variable ``B`` contains "bval additionaldata" and ``C`` contains "test
cval".
.. _appending-and-prepending-without-spaces:
@@ -204,8 +260,14 @@ If you want to append or prepend values without an inserted space, use
the ".=" and "=." operators.
These operators take immediate effect during parsing. Here are some
-examples: B = "bval" B .= "additionaldata" C = "cval" C =. "test" The
-variable ``B`` contains "bvaladditionaldata" and ``C`` contains
+examples: ::
+
+ B = "bval"
+ B .= "additionaldata"
+ C = "cval"
+ C =. "test"
+
+The variable ``B`` contains "bvaladditionaldata" and ``C`` contains
"testcval".
Appending and Prepending (Override Style Syntax)
@@ -216,9 +278,16 @@ style syntax. When you use this syntax, no spaces are inserted.
These operators differ from the ":=", ".=", "=.", "+=", and "=+"
operators in that their effects are applied at variable expansion time
-rather than being immediately applied. Here are some examples: B =
-"bval" B_append = " additional data" C = "cval" C_prepend = "additional
-data " D = "dval" D_append = "additional data" The variable ``B``
+rather than being immediately applied. Here are some examples: ::
+
+ B = "bval"
+ B_append = " additional data"
+ C = "cval"
+ C_prepend = "additional data "
+ D = "dval"
+ D_append = "additional data"
+
+The variable ``B``
becomes "bval additional data" and ``C`` becomes "additional data cval".
The variable ``D`` becomes "dvaladditional data".
@@ -227,9 +296,8 @@ The variable ``D`` becomes "dvaladditional data".
You must control all spacing when you use the override syntax.
It is also possible to append and prepend to shell functions and
-BitBake-style Python functions. See the "`Shell
-Functions <#shell-functions>`__" and "`BitBake-Style Python
-Functions <#bitbake-style-python-functions>`__ sections for examples.
+BitBake-style Python functions. See the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:shell functions`" and ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:bitbake-style python functions`"
+sections for examples.
.. _removing-override-style-syntax:
@@ -241,11 +309,20 @@ syntax. Specifying a value for removal causes all occurrences of that
value to be removed from the variable.
When you use this syntax, BitBake expects one or more strings.
-Surrounding spaces and spacing are preserved. Here is an example: FOO =
-"123 456 789 123456 123 456 123 456" FOO_remove = "123" FOO_remove =
-"456" FOO2 = " abc def ghi abcdef abc def abc def def" FOO2_remove = "
-\\ def \\ abc \\ ghi \\ " The variable ``FOO`` becomes
-"  789 123456    " and ``FOO2`` becomes "     abcdef      ".
+Surrounding spaces and spacing are preserved. Here is an example: ::
+
+ FOO = "123 456 789 123456 123 456 123 456"
+ FOO_remove = "123"
+ FOO_remove = "456"
+ FOO2 = " abc def ghi abcdef abc def abc def def"
+ FOO2_remove = "\
+ def \
+ abc \
+ ghi \
+ "
+
+The variable ``FOO`` becomes
+" 789 123456 " and ``FOO2`` becomes " abcdef ".
Like "_append" and "_prepend", "_remove" is applied at variable
expansion time.
@@ -257,105 +334,115 @@ An advantage of the override style operations "_append", "_prepend", and
"_remove" as compared to the "+=" and "=+" operators is that the
override style operators provide guaranteed operations. For example,
consider a class ``foo.bbclass`` that needs to add the value "val" to
-the variable ``FOO``, and a recipe that uses ``foo.bbclass`` as follows:
-inherit foo FOO = "initial" If ``foo.bbclass`` uses the "+=" operator,
+the variable ``FOO``, and a recipe that uses ``foo.bbclass`` as follows: ::
+
+ inherit foo
+ FOO = "initial"
+
+If ``foo.bbclass`` uses the "+=" operator,
as follows, then the final value of ``FOO`` will be "initial", which is
-not what is desired: FOO += "val" If, on the other hand, ``foo.bbclass``
+not what is desired: ::
+
+ FOO += "val"
+
+If, on the other hand, ``foo.bbclass``
uses the "_append" operator, then the final value of ``FOO`` will be
-"initial val", as intended: FOO_append = " val"
+"initial val", as intended: ::
+
+ FOO_append = " val"
.. note::
- It is never necessary to use "+=" together with "_append". The
- following sequence of assignments appends "barbaz" to
- FOO
- :
- ::
+ It is never necessary to use "+=" together with "_append". The following
+ sequence of assignments appends "barbaz" to FOO: ::
+
+ FOO_append = "bar"
+ FOO_append = "baz"
- FOO_append = "bar"
- FOO_append = "baz"
-
The only effect of changing the second assignment in the previous
example to use "+=" would be to add a space before "baz" in the
appended value (due to how the "+=" operator works).
Another advantage of the override style operations is that you can
-combine them with other overrides as described in the "`Conditional
-Syntax (Overrides) <#conditional-syntax-overrides>`__" section.
+combine them with other overrides as described in the
+":ref:`bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" section.
Variable Flag Syntax
--------------------
Variable flags are BitBake's implementation of variable properties or
attributes. It is a way of tagging extra information onto a variable.
-You can find more out about variable flags in general in the "`Variable
-Flags <#variable-flags>`__" section.
+You can find more out about variable flags in general in the
+":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" section.
You can define, append, and prepend values to variable flags. All the
standard syntax operations previously mentioned work for variable flags
except for override style syntax (i.e. "_prepend", "_append", and
"_remove").
-Here are some examples showing how to set variable flags: FOO[a] = "abc"
-FOO[b] = "123" FOO[a] += "456" The variable ``FOO`` has two flags:
+Here are some examples showing how to set variable flags: ::
+
+ FOO[a] = "abc"
+ FOO[b] = "123"
+ FOO[a] += "456"
+
+The variable ``FOO`` has two flags:
``[a]`` and ``[b]``. The flags are immediately set to "abc" and "123",
respectively. The ``[a]`` flag becomes "abc 456".
No need exists to pre-define variable flags. You can simply start using
them. One extremely common application is to attach some brief
-documentation to a BitBake variable as follows: CACHE[doc] = "The
-directory holding the cache of the metadata."
+documentation to a BitBake variable as follows: ::
+
+ CACHE[doc] = "The directory holding the cache of the metadata."
Inline Python Variable Expansion
--------------------------------
You can use inline Python variable expansion to set variables. Here is
-an example: DATE = "${@time.strftime('%Y%m%d',time.gmtime())}" This
-example results in the ``DATE`` variable being set to the current date.
+an example: ::
+
+ DATE = "${@time.strftime('%Y%m%d',time.gmtime())}"
+
+This example results in the ``DATE`` variable being set to the current date.
Probably the most common use of this feature is to extract the value of
variables from BitBake's internal data dictionary, ``d``. The following
lines select the values of a package name and its version number,
-respectively: PN =
-"${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] or
-'defaultpkgname'}" PV =
-"${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[1] or
-'1.0'}"
+respectively: ::
+
+ PN = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] or 'defaultpkgname'}"
+ PV = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[1] or '1.0'}"
.. note::
- Inline Python expressions work just like variable expansions insofar
- as the "=" and ":=" operators are concerned. Given the following
- assignment,
- foo()
- is called each time
- FOO
- is expanded:
- ::
+ Inline Python expressions work just like variable expansions insofar as the
+ "=" and ":=" operators are concerned. Given the following assignment, foo()
+ is called each time FOO is expanded: ::
- FOO = "${@foo()}"
-
+ FOO = "${@foo()}"
- Contrast this with the following immediate assignment, where
- foo()
- is only called once, while the assignment is parsed:
- ::
+ Contrast this with the following immediate assignment, where foo() is only
+ called once, while the assignment is parsed: ::
- FOO := "${@foo()}"
-
+ FOO := "${@foo()}"
For a different way to set variables with Python code during parsing,
-see the "`Anonymous Python Functions <#anonymous-python-functions>`__"
-section.
+see the
+":ref:`bitbake-user-manual/bitbake-user-manual-metadata:anonymous python functions`" section.
Unsetting variables
-------------------
It is possible to completely remove a variable or a variable flag from
BitBake's internal data dictionary by using the "unset" keyword. Here is
-an example: unset DATE unset do_fetch[noexec] These two statements
-remove the ``DATE`` and the ``do_fetch[noexec]`` flag.
+an example: ::
+
+ unset DATE
+ unset do_fetch[noexec]
+
+These two statements remove the ``DATE`` and the ``do_fetch[noexec]`` flag.
Providing Pathnames
-------------------
@@ -365,34 +452,40 @@ When specifying pathnames for use with BitBake, do not use the tilde
cause BitBake to not recognize the path since BitBake does not expand
this character in the same way a shell would.
-Instead, provide a fuller path as the following example illustrates:
-BBLAYERS ?= " \\ /home/scott-lenovo/LayerA \\ "
+Instead, provide a fuller path as the following example illustrates: ::
+
+ BBLAYERS ?= " \
+ /home/scott-lenovo/LayerA \
+ "
Exporting Variables to the Environment
======================================
You can export variables to the environment of running tasks by using
the ``export`` keyword. For example, in the following example, the
-``do_foo`` task prints "value from the environment" when run: export
-ENV_VARIABLE ENV_VARIABLE = "value from the environment" do_foo() {
-bbplain "$ENV_VARIABLE" }
+``do_foo`` task prints "value from the environment" when run: ::
+
+ export ENV_VARIABLE
+ ENV_VARIABLE = "value from the environment"
+
+ do_foo() {
+ bbplain "$ENV_VARIABLE"
+ }
.. note::
- BitBake does not expand
- $ENV_VARIABLE
- in this case because it lacks the obligatory
- {}
- . Rather,
- $ENV_VARIABLE
- is expanded by the shell.
+ BitBake does not expand ``$ENV_VARIABLE`` in this case because it lacks the
+ obligatory ``{}`` . Rather, ``$ENV_VARIABLE`` is expanded by the shell.
It does not matter whether ``export ENV_VARIABLE`` appears before or
after assignments to ``ENV_VARIABLE``.
It is also possible to combine ``export`` with setting a value for the
-variable. Here is an example: export ENV_VARIABLE = "variable-value" In
-the output of ``bitbake -e``, variables that are exported to the
+variable. Here is an example: ::
+
+ export ENV_VARIABLE = "variable-value"
+
+In the output of ``bitbake -e``, variables that are exported to the
environment are preceded by "export".
Among the variables commonly exported to the environment are ``CC`` and
@@ -425,42 +518,58 @@ variable.
to satisfy conditions. Thus, if you have a variable that is
conditional on “arm”, and “arm” is in ``OVERRIDES``, then the
“arm”-specific version of the variable is used rather than the
- non-conditional version. Here is an example: OVERRIDES =
- "architecture:os:machine" TEST = "default" TEST_os = "osspecific"
- TEST_nooverride = "othercondvalue" In this example, the ``OVERRIDES``
+ non-conditional version. Here is an example: ::
+
+ OVERRIDES = "architecture:os:machine"
+ TEST = "default"
+ TEST_os = "osspecific"
+ TEST_nooverride = "othercondvalue"
+
+ In this example, the ``OVERRIDES``
variable lists three overrides: "architecture", "os", and "machine".
The variable ``TEST`` by itself has a default value of "default". You
select the os-specific version of the ``TEST`` variable by appending
- the "os" override to the variable (i.e.\ ``TEST_os``).
+ the "os" override to the variable (i.e. ``TEST_os``).
To better understand this, consider a practical example that assumes
an OpenEmbedded metadata-based Linux kernel recipe file. The
following lines from the recipe file first set the kernel branch
variable ``KBRANCH`` to a default value, then conditionally override
- that value based on the architecture of the build: KBRANCH =
- "standard/base" KBRANCH_qemuarm = "standard/arm-versatile-926ejs"
- KBRANCH_qemumips = "standard/mti-malta32" KBRANCH_qemuppc =
- "standard/qemuppc" KBRANCH_qemux86 = "standard/common-pc/base"
- KBRANCH_qemux86-64 = "standard/common-pc-64/base" KBRANCH_qemumips64
- = "standard/mti-malta64"
+ that value based on the architecture of the build: ::
+
+ KBRANCH = "standard/base"
+ KBRANCH_qemuarm = "standard/arm-versatile-926ejs"
+ KBRANCH_qemumips = "standard/mti-malta32"
+ KBRANCH_qemuppc = "standard/qemuppc"
+ KBRANCH_qemux86 = "standard/common-pc/base"
+ KBRANCH_qemux86-64 = "standard/common-pc-64/base"
+ KBRANCH_qemumips64 = "standard/mti-malta64"
- *Appending and Prepending:* BitBake also supports append and prepend
operations to variable values based on whether a specific item is
- listed in ``OVERRIDES``. Here is an example: DEPENDS = "glibc
- ncurses" OVERRIDES = "machine:local" DEPENDS_append_machine = "
- libmad" In this example, ``DEPENDS`` becomes "glibc ncurses libmad".
+ listed in ``OVERRIDES``. Here is an example: ::
+
+ DEPENDS = "glibc ncurses"
+ OVERRIDES = "machine:local"
+ DEPENDS_append_machine = "libmad"
+
+ In this example, ``DEPENDS`` becomes "glibc ncurses libmad".
Again, using an OpenEmbedded metadata-based kernel recipe file as an
example, the following lines will conditionally append to the
- ``KERNEL_FEATURES`` variable based on the architecture:
- KERNEL_FEATURES_append = " ${KERNEL_EXTRA_FEATURES}"
- KERNEL_FEATURES_append_qemux86=" cfg/sound.scc cfg/paravirt_kvm.scc"
- KERNEL_FEATURES_append_qemux86-64=" cfg/sound.scc
- cfg/paravirt_kvm.scc"
+ ``KERNEL_FEATURES`` variable based on the architecture: ::
+
+ KERNEL_FEATURES_append = " ${KERNEL_EXTRA_FEATURES}"
+ KERNEL_FEATURES_append_qemux86=" cfg/sound.scc cfg/paravirt_kvm.scc"
+ KERNEL_FEATURES_append_qemux86-64=" cfg/sound.scc cfg/paravirt_kvm.scc"
- *Setting a Variable for a Single Task:* BitBake supports setting a
- variable just for the duration of a single task. Here is an example:
- FOO_task-configure = "val 1" FOO_task-compile = "val 2" In the
+ variable just for the duration of a single task. Here is an example: ::
+
+ FOO_task-configure = "val 1"
+ FOO_task-compile = "val 2"
+
+ In the
previous example, ``FOO`` has the value "val 1" while the
``do_configure`` task is executed, and the value "val 2" while the
``do_compile`` task is executed.
@@ -471,15 +580,21 @@ variable.
``do_compile`` task.
You can also use this syntax with other combinations (e.g.
- "``_prepend``") as shown in the following example:
- EXTRA_OEMAKE_prepend_task-compile = "${PARALLEL_MAKE} "
+ "``_prepend``") as shown in the following example: ::
+
+ EXTRA_OEMAKE_prepend_task-compile = "${PARALLEL_MAKE} "
Key Expansion
-------------
Key expansion happens when the BitBake datastore is finalized. To better
-understand this, consider the following example: A${B} = "X" B = "2" A2
-= "Y" In this case, after all the parsing is complete, BitBake expands
+understand this, consider the following example: ::
+
+ A${B} = "X"
+ B = "2"
+ A2 = "Y"
+
+In this case, after all the parsing is complete, BitBake expands
``${B}`` into "2". This expansion causes ``A2``, which was set to "Y"
before the expansion, to become "X".
@@ -499,7 +614,13 @@ There is often confusion concerning the order in which overrides and
various "append" operators take effect. Recall that an append or prepend
operation using "_append" and "_prepend" does not result in an immediate
assignment as would "+=", ".=", "=+", or "=.". Consider the following
-example: OVERRIDES = "foo" A = "Z" A_foo_append = "X" For this case,
+example: ::
+
+ OVERRIDES = "foo"
+ A = "Z"
+ A_foo_append = "X"
+
+For this case,
``A`` is unconditionally set to "Z" and "X" is unconditionally and
immediately appended to the variable ``A_foo``. Because overrides have
not been applied yet, ``A_foo`` is set to "X" due to the append and
@@ -510,24 +631,42 @@ Applying overrides, however, changes things. Since "foo" is listed in
version, which is equal to "X". So effectively, ``A_foo`` replaces
``A``.
-This next example changes the order of the override and the append:
-OVERRIDES = "foo" A = "Z" A_append_foo = "X" For this case, before
+This next example changes the order of the override and the append: ::
+
+ OVERRIDES = "foo"
+ A = "Z"
+ A_append_foo = "X"
+
+For this case, before
overrides are handled, ``A`` is set to "Z" and ``A_append_foo`` is set
to "X". Once the override for "foo" is applied, however, ``A`` gets
appended with "X". Consequently, ``A`` becomes "ZX". Notice that spaces
are not appended.
This next example has the order of the appends and overrides reversed
-back as in the first example: OVERRIDES = "foo" A = "Y" A_foo_append =
-"Z" A_foo_append = "X" For this case, before any overrides are resolved,
+back as in the first example: ::
+
+ OVERRIDES = "foo"
+ A = "Y"
+ A_foo_append = "Z"
+ A_foo_append = "X"
+
+For this case, before any overrides are resolved,
``A`` is set to "Y" using an immediate assignment. After this immediate
assignment, ``A_foo`` is set to "Z", and then further appended with "X"
leaving the variable set to "ZX". Finally, applying the override for
"foo" results in the conditional variable ``A`` becoming "ZX" (i.e.
``A`` is replaced with ``A_foo``).
-This final example mixes in some varying operators: A = "1" A_append =
-"2" A_append = "3" A += "4" A .= "5" For this case, the type of append
+This final example mixes in some varying operators: ::
+
+ A = "1"
+ A_append = "2"
+ A_append = "3"
+ A += "4"
+ A .= "5"
+
+For this case, the type of append
operators are affecting the order of assignments as BitBake passes
through the code multiple times. Initially, ``A`` is set to "1 45"
because of the three statements that use immediate operators. After
@@ -559,11 +698,7 @@ current directory for ``include`` and ``require`` directives.
.. note::
- The
- BBPATH
- variable is analogous to the environment variable
- PATH
- .
+ The BBPATH variable is analogous to the environment variable PATH .
In order for include and class files to be found by BitBake, they need
to be located in a "classes" subdirectory that can be found in
@@ -585,8 +720,11 @@ file and then have your recipe inherit that class file.
As an example, your recipes could use the following directive to inherit
an ``autotools.bbclass`` file. The class file would contain common
-functionality for using Autotools that could be shared across recipes:
-inherit autotools In this case, BitBake would search for the directory
+functionality for using Autotools that could be shared across recipes: ::
+
+ inherit autotools
+
+In this case, BitBake would search for the directory
``classes/autotools.bbclass`` in ``BBPATH``.
.. note::
@@ -596,24 +734,42 @@ inherit autotools In this case, BitBake would search for the directory
If you want to use the directive to inherit multiple classes, separate
them with spaces. The following example shows how to inherit both the
-``buildhistory`` and ``rm_work`` classes: inherit buildhistory rm_work
+``buildhistory`` and ``rm_work`` classes: ::
+
+ inherit buildhistory rm_work
An advantage with the inherit directive as compared to both the
-`include <#include-directive>`__ and `require <#require-inclusion>`__
+:ref:`include <bitbake-user-manual/bitbake-user-manual-metadata:\`\`include\`\` directive>` and :ref:`require <bitbake-user-manual/bitbake-user-manual-metadata:\`\`require\`\` directive>`
directives is that you can inherit class files conditionally. You can
accomplish this by using a variable expression after the ``inherit``
-statement. Here is an example: inherit ${VARNAME} If ``VARNAME`` is
+statement. Here is an example: ::
+
+ inherit ${VARNAME}
+
+If ``VARNAME`` is
going to be set, it needs to be set before the ``inherit`` statement is
parsed. One way to achieve a conditional inherit in this case is to use
-overrides: VARIABLE = "" VARIABLE_someoverride = "myclass"
+overrides: ::
+
+ VARIABLE = ""
+ VARIABLE_someoverride = "myclass"
+
+Another method is by using anonymous Python. Here is an example: ::
-Another method is by using anonymous Python. Here is an example: python
-() { if condition == value: d.setVar('VARIABLE', 'myclass') else:
-d.setVar('VARIABLE', '') }
+ python () {
+ if condition == value:
+ d.setVar('VARIABLE', 'myclass')
+ else:
+ d.setVar('VARIABLE', '')
+ }
Alternatively, you could use an in-line Python expression in the
-following form: inherit ${@'classname' if condition else ''} inherit
-${@functionname(params)} In all cases, if the expression evaluates to an
+following form: ::
+
+ inherit ${@'classname' if condition else ''}
+ inherit ${@functionname(params)}
+
+In all cases, if the expression evaluates to an
empty string, the statement does not trigger a syntax error because it
becomes a no-op.
@@ -627,27 +783,24 @@ that if the path specified on the include line is a relative path,
BitBake locates the first file it can find within ``BBPATH``.
The include directive is a more generic method of including
-functionality as compared to the `inherit <#inherit-directive>`__
+functionality as compared to the :ref:`inherit <bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` directive>`
directive, which is restricted to class (i.e. ``.bbclass``) files. The
include directive is applicable for any other kind of shared or
encapsulated functionality or configuration that does not suit a
``.bbclass`` file.
As an example, suppose you needed a recipe to include some self-test
-definitions: include test_defs.inc
+definitions: ::
+
+ include test_defs.inc
.. note::
- The
- include
- directive does not produce an error when the file cannot be found.
- Consequently, it is recommended that if the file you are including is
- expected to exist, you should use
- :ref:`require <require-inclusion>`
- instead of
- include
- . Doing so makes sure that an error is produced if the file cannot be
- found.
+ The include directive does not produce an error when the file cannot be
+ found. Consequently, it is recommended that if the file you are including is
+ expected to exist, you should use :ref:`require <require-inclusion>` instead
+ of include . Doing so makes sure that an error is produced if the file cannot
+ be found.
.. _require-inclusion:
@@ -662,12 +815,12 @@ the location of the directive.
The require directive, like the include directive previously described,
is a more generic method of including functionality as compared to the
-`inherit <#inherit-directive>`__ directive, which is restricted to class
+:ref:`inherit <bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` directive>` directive, which is restricted to class
(i.e. ``.bbclass``) files. The require directive is applicable for any
other kind of shared or encapsulated functionality or configuration that
does not suit a ``.bbclass`` file.
-Similar to how BitBake handles ```include`` <#include-directive>`__, if
+Similar to how BitBake handles :ref:`include <bitbake-user-manual/bitbake-user-manual-metadata:\`\`include\`\` directive>`, if
the path specified on the require line is a relative path, BitBake
locates the first file it can find within ``BBPATH``.
@@ -678,7 +831,9 @@ include file named ``foo.inc`` that contains the common definitions
needed to build "foo". You need to be sure ``foo.inc`` is located in the
same directory as your two recipe files as well. Once these conditions
are set up, you can share the functionality using a ``require``
-directive from within each recipe: require foo.inc
+directive from within each recipe: ::
+
+ require foo.inc
``INHERIT`` Configuration Directive
-----------------------------------
@@ -689,7 +844,10 @@ class. BitBake only supports this directive when used within a
configuration file.
As an example, suppose you needed to inherit a class file called
-``abc.bbclass`` from a configuration file as follows: INHERIT += "abc"
+``abc.bbclass`` from a configuration file as follows: ::
+
+ INHERIT += "abc"
+
This configuration directive causes the named class to be inherited at
the point of the directive during parsing. As with the ``inherit``
directive, the ``.bbclass`` file must be located in a "classes"
@@ -697,18 +855,16 @@ subdirectory in one of the directories specified in ``BBPATH``.
.. note::
- Because
- .conf
- files are parsed first during BitBake's execution, using
- INHERIT
- to inherit a class effectively inherits the class globally (i.e. for
+ Because .conf files are parsed first during BitBake's execution, using
+ INHERIT to inherit a class effectively inherits the class globally (i.e. for
all recipes).
If you want to use the directive to inherit multiple classes, you can
provide them on the same line in the ``local.conf`` file. Use spaces to
separate the classes. The following example shows how to inherit both
-the ``autotools`` and ``pkgconfig`` classes: INHERIT += "autotools
-pkgconfig"
+the ``autotools`` and ``pkgconfig`` classes: ::
+
+ INHERIT += "autotools pkgconfig"
Functions
=========
@@ -739,8 +895,13 @@ Shell Functions
Functions written in shell script and executed either directly as
functions, tasks, or both. They can also be called by other shell
-functions. Here is an example shell function definition: some_function
-() { echo "Hello World" } When you create these types of functions in
+functions. Here is an example shell function definition: ::
+
+ some_function () {
+ echo "Hello World"
+ }
+
+When you create these types of functions in
your recipe or class files, you need to follow the shell programming
rules. The scripts are executed by ``/bin/sh``, which may not be a bash
shell but might be something such as ``dash``. You should not use
@@ -751,16 +912,36 @@ can also be applied to shell functions. Most commonly, this application
would be used in a ``.bbappend`` file to modify functions in the main
recipe. It can also be used to modify functions inherited from classes.
-As an example, consider the following: do_foo() { bbplain first fn }
-fn_prepend() { bbplain second } fn() { bbplain third } do_foo_append() {
-bbplain fourth } Running ``do_foo`` prints the following: recipename
-do_foo: first recipename do_foo: second recipename do_foo: third
-recipename do_foo: fourth
+As an example, consider the following: ::
+
+ do_foo() {
+ bbplain first
+ fn
+ }
+
+ fn_prepend() {
+ bbplain second
+ }
+
+ fn() {
+ bbplain third
+ }
+
+ do_foo_append() {
+ bbplain fourth
+ }
+
+Running ``do_foo`` prints the following: ::
+
+ recipename do_foo: first
+ recipename do_foo: second
+ recipename do_foo: third
+ recipename do_foo: fourth
.. note::
Overrides and override-style operators can be applied to any shell
- function, not just :ref:`tasks <bitbake-user-manual/bitbake-user-manual-metadata:Tasks>`.
+ function, not just :ref:`tasks <bitbake-user-manual/bitbake-user-manual-metadata:tasks>`.
You can use the ``bitbake -e`` recipename command to view the final
assembled function after all overrides have been applied.
@@ -771,33 +952,50 @@ BitBake-Style Python Functions
These functions are written in Python and executed by BitBake or other
Python functions using ``bb.build.exec_func()``.
-An example BitBake function is: python some_python_function () {
-d.setVar("TEXT", "Hello World") print d.getVar("TEXT") } Because the
+An example BitBake function is: ::
+
+ python some_python_function () {
+ d.setVar("TEXT", "Hello World")
+ print d.getVar("TEXT")
+ }
+
+Because the
Python "bb" and "os" modules are already imported, you do not need to
import these modules. Also in these types of functions, the datastore
("d") is a global variable and is always automatically available.
.. note::
- Variable expressions (e.g.
- ${X}
- ) are no longer expanded within Python functions. This behavior is
- intentional in order to allow you to freely set variable values to
- expandable expressions without having them expanded prematurely. If
- you do wish to expand a variable within a Python function, use
- d.getVar("X")
- . Or, for more complicated expressions, use
- d.expand()
- .
+ Variable expressions (e.g. ``${X}`` ) are no longer expanded within Python
+ functions. This behavior is intentional in order to allow you to freely set
+ variable values to expandable expressions without having them expanded
+ prematurely. If you do wish to expand a variable within a Python function,
+ use ``d.getVar("X")`` . Or, for more complicated expressions, use ``d.expand()``.
Similar to shell functions, you can also apply overrides and
override-style operators to BitBake-style Python functions.
-As an example, consider the following: python do_foo_prepend() {
-bb.plain("first") } python do_foo() { bb.plain("second") } python
-do_foo_append() { bb.plain("third") } Running ``do_foo`` prints the
-following: recipename do_foo: first recipename do_foo: second recipename
-do_foo: third You can use the ``bitbake -e`` recipename command to view
+As an example, consider the following: ::
+
+ python do_foo_prepend() {
+ bb.plain("first")
+ }
+
+ python do_foo() {
+ bb.plain("second")
+ }
+
+ python do_foo_append() {
+ bb.plain("third")
+ }
+
+Running ``do_foo`` prints the following: ::
+
+ recipename do_foo: first
+ recipename do_foo: second
+ recipename do_foo: third
+
+You can use the ``bitbake -e`` recipename command to view
the final assembled function after all overrides have been applied.
Python Functions
@@ -806,10 +1004,18 @@ Python Functions
These functions are written in Python and are executed by other Python
code. Examples of Python functions are utility functions that you intend
to call from in-line Python or from within other Python functions. Here
-is an example: def get_depends(d): if d.getVar('SOMECONDITION'): return
-"dependencywithcond" else: return "dependency" SOMECONDITION = "1"
-DEPENDS = "${@get_depends(d)}" This would result in ``DEPENDS``
-containing ``dependencywithcond``.
+is an example: ::
+
+ def get_depends(d):
+ if d.getVar('SOMECONDITION'):
+ return "dependencywithcond"
+ else:
+ return "dependency"
+
+ SOMECONDITION = "1"
+ DEPENDS = "${@get_depends(d)}"
+
+This would result in ``DEPENDS`` containing ``dependencywithcond``.
Here are some things to know about Python functions:
@@ -827,15 +1033,15 @@ BitBake-Style Python Functions Versus Python Functions
Following are some important differences between BitBake-style Python
functions and regular Python functions defined with "def":
-- Only BitBake-style Python functions can be `tasks <#tasks>`__.
+- Only BitBake-style Python functions can be :ref:`tasks <bitbake-user-manual/bitbake-user-manual-metadata:tasks>`.
- Overrides and override-style operators can only be applied to
BitBake-style Python functions.
- Only regular Python functions can take arguments and return values.
-- `Variable flags <#variable-flags>`__ such as ``[dirs]``,
- ``[cleandirs]``, and ``[lockfiles]`` can be used on BitBake-style
+- :ref:`Variable flags <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>` such as
+ ``[dirs]``, ``[cleandirs]``, and ``[lockfiles]`` can be used on BitBake-style
Python functions, but not on regular Python functions.
- BitBake-style Python functions generate a separate
@@ -850,18 +1056,17 @@ functions and regular Python functions defined with "def":
- Regular Python functions are called with the usual Python syntax.
BitBake-style Python functions are usually tasks and are called
directly by BitBake, but can also be called manually from Python code
- by using the ``bb.build.exec_func()`` function. Here is an example:
- bb.build.exec_func("my_bitbake_style_function", d)
+ by using the ``bb.build.exec_func()`` function. Here is an example: ::
+
+ bb.build.exec_func("my_bitbake_style_function", d)
.. note::
- bb.build.exec_func()
- can also be used to run shell functions from Python code. If you
- want to run a shell function before a Python function within the
- same task, then you can use a parent helper Python function that
- starts by running the shell function with
- bb.build.exec_func()
- and then runs the Python code.
+ ``bb.build.exec_func()`` can also be used to run shell functions from Python
+ code. If you want to run a shell function before a Python function within
+ the same task, then you can use a parent helper Python function that
+ starts by running the shell function with ``bb.build.exec_func()`` and then
+ runs the Python code.
To detect errors from functions executed with
``bb.build.exec_func()``, you can catch the ``bb.build.FuncFailed``
@@ -869,20 +1074,12 @@ functions and regular Python functions defined with "def":
.. note::
- Functions in metadata (recipes and classes) should not themselves
- raise
- bb.build.FuncFailed
- . Rather,
- bb.build.FuncFailed
- should be viewed as a general indicator that the called function
- failed by raising an exception. For example, an exception raised
- by
- bb.fatal()
- will be caught inside
- bb.build.exec_func()
- , and a
- bb.build.FuncFailed
- will be raised in response.
+ Functions in metadata (recipes and classes) should not themselves raise
+ ``bb.build.FuncFailed``. Rather, ``bb.build.FuncFailed`` should be viewed as a
+ general indicator that the called function failed by raising an
+ exception. For example, an exception raised by ``bb.fatal()`` will be caught
+ inside ``bb.build.exec_func()``, and a ``bb.build.FuncFailed`` will be raised in
+ response.
Due to their simplicity, you should prefer regular Python functions over
BitBake-style Python functions unless you need a feature specific to
@@ -897,32 +1094,62 @@ Sometimes it is useful to set variables or perform other operations
programmatically during parsing. To do this, you can define special
Python functions, called anonymous Python functions, that run at the end
of parsing. For example, the following conditionally sets a variable
-based on the value of another variable: python () { if
-d.getVar('SOMEVAR') == 'value': d.setVar('ANOTHERVAR', 'value2') } An
-equivalent way to mark a function as an anonymous function is to give it
+based on the value of another variable: ::
+
+ python () {
+ if d.getVar('SOMEVAR') == 'value':
+ d.setVar('ANOTHERVAR', 'value2')
+ }
+
+An equivalent way to mark a function as an anonymous function is to give it
the name "__anonymous", rather than no name.
Anonymous Python functions always run at the end of parsing, regardless
of where they are defined. If a recipe contains many anonymous
functions, they run in the same order as they are defined within the
-recipe. As an example, consider the following snippet: python () {
-d.setVar('FOO', 'foo 2') } FOO = "foo 1" python () { d.appendVar('BAR',
-' bar 2') } BAR = "bar 1" The previous example is conceptually
-equivalent to the following snippet: FOO = "foo 1" BAR = "bar 1" FOO =
-"foo 2" BAR += "bar 2" ``FOO`` ends up with the value "foo 2", and
+recipe. As an example, consider the following snippet: ::
+
+ python () {
+ d.setVar('FOO', 'foo 2')
+ }
+
+ FOO = "foo 1"
+
+ python () {
+ d.appendVar('BAR',' bar 2')
+ }
+
+ BAR = "bar 1"
+
+The previous example is conceptually
+equivalent to the following snippet: ::
+
+ FOO = "foo 1"
+ BAR = "bar 1"
+ FOO = "foo 2"
+ BAR += "bar 2"
+
+``FOO`` ends up with the value "foo 2", and
``BAR`` with the value "bar 1 bar 2". Just as in the second snippet, the
values set for the variables within the anonymous functions become
available to tasks, which always run after parsing.
Overrides and override-style operators such as "``_append``" are applied
before anonymous functions run. In the following example, ``FOO`` ends
-up with the value "foo from anonymous": FOO = "foo" FOO_append = " from
-outside" python () { d.setVar("FOO", "foo from anonymous") } For methods
-you can use with anonymous Python functions, see the "`Functions You Can
-Call From Within Python <#functions-you-can-call-from-within-python>`__"
+up with the value "foo from anonymous": ::
+
+ FOO = "foo"
+ FOO_append = " from outside"
+
+ python () {
+ d.setVar("FOO", "foo from anonymous")
+ }
+
+For methods
+you can use with anonymous Python functions, see the
+":ref:`bitbake-user-manual/bitbake-user-manual-metadata:functions you can call from within python`"
section. For a different method to run Python code during parsing, see
-the "`Inline Python Variable
-Expansion <#inline-python-variable-expansion>`__" section.
+the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:inline python variable expansion`" section.
Flexible Inheritance for Class Functions
----------------------------------------
@@ -946,24 +1173,43 @@ version of the function.
To make use of this technique, you need the following things in place:
-- The class needs to define the function as follows:
- classname\ ``_``\ functionname For example, if you have a class file
+- The class needs to define the function as follows: ::
+
+ classname_functionname
+
+ For example, if you have a class file
``bar.bbclass`` and a function named ``do_foo``, the class must
- define the function as follows: bar_do_foo
+ define the function as follows: ::
+
+ bar_do_foo
- The class needs to contain the ``EXPORT_FUNCTIONS`` statement as
- follows: EXPORT_FUNCTIONS functionname For example, continuing with
+ follows: ::
+
+ EXPORT_FUNCTIONS functionname
+
+ For example, continuing with
the same example, the statement in the ``bar.bbclass`` would be as
- follows: EXPORT_FUNCTIONS do_foo
+ follows: ::
+
+ EXPORT_FUNCTIONS do_foo
- You need to call the function appropriately from within your recipe.
Continuing with the same example, if your recipe needs to call the
class version of the function, it should call ``bar_do_foo``.
Assuming ``do_foo`` was a shell function and ``EXPORT_FUNCTIONS`` was
used as above, the recipe's function could conditionally call the
- class version of the function as follows: do_foo() { if [
- somecondition ] ; then bar_do_foo else # Do something else fi } To
- call your modified version of the function as defined in your recipe,
+ class version of the function as follows: ::
+
+ do_foo() {
+ if [ somecondition ] ; then
+ bar_do_foo
+ else
+ # Do something else
+ fi
+ }
+
+ To call your modified version of the function as defined in your recipe,
call it as ``do_foo``.
With these conditions met, your single recipe can freely choose between
@@ -982,14 +1228,20 @@ classes (i.e. in ``.bb`` files and files included or inherited from
Promoting a Function to a Task
------------------------------
-Tasks are either `shell functions <#shell-functions>`__ or
-`BitBake-style Python functions <#bitbake-style-python-functions>`__
+Tasks are either :ref:`shell functions <bitbake-user-manual/bitbake-user-manual-metadata:shell functions>` or
+:ref:`BitBake-style Python functions <bitbake-user-manual/bitbake-user-manual-metadata:bitbake-style python functions>`
that have been promoted to tasks by using the ``addtask`` command. The
``addtask`` command can also optionally describe dependencies between
the task and other tasks. Here is an example that shows how to define a
-task and declare some dependencies: python do_printdate () { import time
-print time.strftime('%Y%m%d', time.gmtime()) } addtask printdate after
-do_fetch before do_build The first argument to ``addtask`` is the name
+task and declare some dependencies: ::
+
+ python do_printdate () {
+ import time
+ print time.strftime('%Y%m%d', time.gmtime())
+ }
+ addtask printdate after do_fetch before do_build
+
+The first argument to ``addtask`` is the name
of the function to promote to a task. If the name does not start with
"do\_", "do\_" is implicitly added, which enforces the convention that all
task names start with "do\_".
@@ -1004,49 +1256,44 @@ Additionally, the ``do_printdate`` task becomes dependent upon the
.. note::
If you try out the previous example, you might see that the
- do_printdate
+ ``do_printdate``
task is only run the first time you build the recipe with the
- bitbake
+ ``bitbake``
command. This is because BitBake considers the task "up-to-date"
after that initial run. If you want to force the task to always be
rerun for experimentation purposes, you can make BitBake always
consider the task "out-of-date" by using the
:ref:`[nostamp] <bitbake-user-manual/bitbake-user-manual-metadata:Variable Flags>`
- variable flag, as follows:
- ::
+ variable flag, as follows: ::
- do_printdate[nostamp] = "1"
-
+ do_printdate[nostamp] = "1"
You can also explicitly run the task and provide the
- -f
- option as follows:
- ::
-
- $ bitbake recipe -c printdate -f
-
-
- When manually selecting a task to run with the
- bitbake
- NBSP
- recipe
- NBSP
- -c
- NBSP
- task
- command, you can omit the "do\_" prefix as part of the task name.
+ -f option as follows: ::
+
+ $ bitbake recipe -c printdate -f
+
+ When manually selecting a task to run with the bitbake ``recipe
+ -c task`` command, you can omit the "do\_" prefix as part of the task
+ name.
You might wonder about the practical effects of using ``addtask``
-without specifying any dependencies as is done in the following example:
-addtask printdate In this example, assuming dependencies have not been
+without specifying any dependencies as is done in the following example: ::
+
+ addtask printdate
+
+In this example, assuming dependencies have not been
added through some other means, the only way to run the task is by
explicitly selecting it with ``bitbake`` recipe ``-c printdate``. You
can use the ``do_listtasks`` task to list all tasks defined in a recipe
-as shown in the following example: $ bitbake recipe -c listtasks For
-more information on task dependencies, see the
-"`Dependencies <#dependencies>`__" section.
+as shown in the following example: ::
-See the "`Variable Flags <#variable-flags>`__" section for information
+ $ bitbake recipe -c listtasks
+
+For more information on task dependencies, see the
+":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`" section.
+
+See the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" section for information
on variable flags you can use with tasks.
Deleting a Task
@@ -1054,8 +1301,11 @@ Deleting a Task
As well as being able to add tasks, you can delete them. Simply use the
``deltask`` command to delete a task. For example, to delete the example
-task used in the previous sections, you would use: deltask printdate If
-you delete a task using the ``deltask`` command and the task has
+task used in the previous sections, you would use: ::
+
+ deltask printdate
+
+If you delete a task using the ``deltask`` command and the task has
dependencies, the dependencies are not reconnected. For example, suppose
you have three tasks named ``do_a``, ``do_b``, and ``do_c``.
Furthermore, ``do_c`` is dependent on ``do_b``, which in turn is
@@ -1067,7 +1317,9 @@ to run before ``do_a``.
If you want dependencies such as these to remain intact, use the
``[noexec]`` varflag to disable the task instead of using the
-``deltask`` command to delete it: do_b[noexec] = "1"
+``deltask`` command to delete it: ::
+
+ do_b[noexec] = "1"
Passing Information Into the Build Task Environment
---------------------------------------------------
@@ -1081,30 +1333,31 @@ the build machine cannot influence the build.
By default, BitBake cleans the environment to include only those
things exported or listed in its whitelist to ensure that the build
environment is reproducible and consistent. You can prevent this
- "cleaning" by setting the
- :term:`BB_PRESERVE_ENV`
- variable.
+ "cleaning" by setting the :term:`BB_PRESERVE_ENV` variable.
Consequently, if you do want something to get passed into the build task
environment, you must take these two steps:
-1. Tell BitBake to load what you want from the environment into the
+#. Tell BitBake to load what you want from the environment into the
datastore. You can do so through the
:term:`BB_ENV_WHITELIST` and
:term:`BB_ENV_EXTRAWHITE` variables. For
example, assume you want to prevent the build system from accessing
your ``$HOME/.ccache`` directory. The following command "whitelists"
the environment variable ``CCACHE_DIR`` causing BitBake to allow that
- variable into the datastore: export
- BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE CCACHE_DIR"
+ variable into the datastore: ::
+
+ export BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE CCACHE_DIR"
-2. Tell BitBake to export what you have loaded into the datastore to the
+#. Tell BitBake to export what you have loaded into the datastore to the
task environment of every running task. Loading something from the
environment into the datastore (previous step) only makes it
available in the datastore. To export it to the task environment of
every running task, use a command similar to the following in your
local configuration file ``local.conf`` or your distribution
- configuration file: export CCACHE_DIR
+ configuration file: ::
+
+ export CCACHE_DIR
.. note::
@@ -1116,15 +1369,17 @@ environment, you must take these two steps:
Sometimes, it is useful to be able to obtain information from the
original execution environment. BitBake saves a copy of the original
-environment into a special variable named
-:term:`BB_ORIGENV`.
+environment into a special variable named :term:`BB_ORIGENV`.
The ``BB_ORIGENV`` variable returns a datastore object that can be
queried using the standard datastore operators such as
``getVar(, False)``. The datastore object is useful, for example, to
-find the original ``DISPLAY`` variable. Here is an example: origenv =
-d.getVar("BB_ORIGENV", False) bar = origenv.getVar("BAR", False) The
-previous example returns ``BAR`` from the original execution
+find the original ``DISPLAY`` variable. Here is an example: ::
+
+ origenv = d.getVar("BB_ORIGENV", False)
+ bar = origenv.getVar("BAR", False)
+
+The previous example returns ``BAR`` from the original execution
environment.
Variable Flags
@@ -1132,71 +1387,70 @@ Variable Flags
Variable flags (varflags) help control a task's functionality and
dependencies. BitBake reads and writes varflags to the datastore using
-the following command forms: variable = d.getVarFlags("variable")
-self.d.setVarFlags("FOO", {"func": True})
+the following command forms: ::
+
+ variable = d.getVarFlags("variable")
+ self.d.setVarFlags("FOO", {"func": True})
When working with varflags, the same syntax, with the exception of
overrides, applies. In other words, you can set, append, and prepend
-varflags just like variables. See the "`Variable Flag
-Syntax <#variable-flag-syntax>`__" section for details.
+varflags just like variables. See the
+":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variable flag syntax`" section for details.
BitBake has a defined set of varflags available for recipes and classes.
Tasks support a number of these flags which control various
functionality of the task:
-- *``[cleandirs]``:* Empty directories that should be created before
+- ``[cleandirs]``: Empty directories that should be created before
the task runs. Directories that already exist are removed and
recreated to empty them.
-- *``[depends]``:* Controls inter-task dependencies. See the
- :term:`DEPENDS` variable and the "`Inter-Task
- Dependencies <#inter-task-dependencies>`__" section for more
- information.
+- ``[depends]``: Controls inter-task dependencies. See the
+ :term:`DEPENDS` variable and the
+ ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:inter-task
+ dependencies`" section for more information.
-- *``[deptask]``:* Controls task build-time dependencies. See the
- :term:`DEPENDS` variable and the "`Build
- Dependencies <#build-dependencies>`__" section for more information.
+- ``[deptask]``: Controls task build-time dependencies. See the
+ :term:`DEPENDS` variable and the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:build dependencies`" section for more information.
-- *``[dirs]``:* Directories that should be created before the task
+- ``[dirs]``: Directories that should be created before the task
runs. Directories that already exist are left as is. The last
directory listed is used as the current working directory for the
task.
-- *``[lockfiles]``:* Specifies one or more lockfiles to lock while the
+- ``[lockfiles]``: Specifies one or more lockfiles to lock while the
task executes. Only one task may hold a lockfile, and any task that
attempts to lock an already locked file will block until the lock is
released. You can use this variable flag to accomplish mutual
exclusion.
-- *``[noexec]``:* When set to "1", marks the task as being empty, with
+- ``[noexec]``: When set to "1", marks the task as being empty, with
no execution required. You can use the ``[noexec]`` flag to set up
tasks as dependency placeholders, or to disable tasks defined
elsewhere that are not needed in a particular recipe.
-- *``[nostamp]``:* When set to "1", tells BitBake to not generate a
+- ``[nostamp]``: When set to "1", tells BitBake to not generate a
stamp file for a task, which implies the task should always be
executed.
- .. note::
+ .. caution::
- Any task that depends (possibly indirectly) on a
- [nostamp]
- task will always be executed as well. This can cause unnecessary
- rebuilding if you are not careful.
+ Any task that depends (possibly indirectly) on a ``[nostamp]`` task will
+ always be executed as well. This can cause unnecessary rebuilding if you
+ are not careful.
-- *``[number_threads]``:* Limits tasks to a specific number of
+- ``[number_threads]``: Limits tasks to a specific number of
simultaneous threads during execution. This varflag is useful when
your build host has a large number of cores but certain tasks need to
be rate-limited due to various kinds of resource constraints (e.g. to
avoid network throttling). ``number_threads`` works similarly to the
- :term:`BB_NUMBER_THREADS` variable but is
- task-specific.
+ :term:`BB_NUMBER_THREADS` variable but is task-specific.
Set the value globally. For example, the following makes sure the
``do_fetch`` task uses no more than two simultaneous execution
threads: do_fetch[number_threads] = "2"
- .. note::
+ .. warning::
- Setting the varflag in individual recipes rather than globally
can result in unpredictable behavior.
@@ -1205,59 +1459,59 @@ functionality of the task:
the ``BB_NUMBER_THREADS`` variable causes ``number_threads`` to
have no effect.
-- *``[postfuncs]``:* List of functions to call after the completion of
+- ``[postfuncs]``: List of functions to call after the completion of
the task.
-- *``[prefuncs]``:* List of functions to call before the task executes.
+- ``[prefuncs]``: List of functions to call before the task executes.
-- *``[rdepends]``:* Controls inter-task runtime dependencies. See the
+- ``[rdepends]``: Controls inter-task runtime dependencies. See the
:term:`RDEPENDS` variable, the
:term:`RRECOMMENDS` variable, and the
- "`Inter-Task Dependencies <#inter-task-dependencies>`__" section for
+ ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:inter-task dependencies`" section for
more information.
-- *``[rdeptask]``:* Controls task runtime dependencies. See the
+- ``[rdeptask]``: Controls task runtime dependencies. See the
:term:`RDEPENDS` variable, the
- :term:`RRECOMMENDS` variable, and the "`Runtime
- Dependencies <#runtime-dependencies>`__" section for more
+ :term:`RRECOMMENDS` variable, and the
+ ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:runtime dependencies`" section for more
information.
-- *``[recideptask]``:* When set in conjunction with ``recrdeptask``,
+- ``[recideptask]``: When set in conjunction with ``recrdeptask``,
specifies a task that should be inspected for additional
dependencies.
-- *``[recrdeptask]``:* Controls task recursive runtime dependencies.
+- ``[recrdeptask]``: Controls task recursive runtime dependencies.
See the :term:`RDEPENDS` variable, the
:term:`RRECOMMENDS` variable, and the
- "`Recursive Dependencies <#recursive-dependencies>`__" section for
+ ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:recursive dependencies`" section for
more information.
-- *``[stamp-extra-info]``:* Extra stamp information to append to the
+- ``[stamp-extra-info]``: Extra stamp information to append to the
task's stamp. As an example, OpenEmbedded uses this flag to allow
machine-specific tasks.
-- *``[umask]``:* The umask to run the task under.
+- ``[umask]``: The umask to run the task under.
Several varflags are useful for controlling how signatures are
calculated for variables. For more information on this process, see the
-"`Checksums (Signatures) <#checksums>`__" section.
+":ref:`bitbake-user-manual/bitbake-user-manual-execution:checksums (signatures)`" section.
-- *``[vardeps]``:* Specifies a space-separated list of additional
+- ``[vardeps]``: Specifies a space-separated list of additional
variables to add to a variable's dependencies for the purposes of
calculating its signature. Adding variables to this list is useful,
for example, when a function refers to a variable in a manner that
does not allow BitBake to automatically determine that the variable
is referred to.
-- *``[vardepsexclude]``:* Specifies a space-separated list of variables
+- ``[vardepsexclude]``: Specifies a space-separated list of variables
that should be excluded from a variable's dependencies for the
purposes of calculating its signature.
-- *``[vardepvalue]``:* If set, instructs BitBake to ignore the actual
+- ``[vardepvalue]``: If set, instructs BitBake to ignore the actual
value of the variable and instead use the specified value when
calculating the variable's signature.
-- *``[vardepvalueexclude]``:* Specifies a pipe-separated list of
+- ``[vardepvalueexclude]``: Specifies a pipe-separated list of
strings to exclude from the variable's value when calculating the
variable's signature.
@@ -1272,12 +1526,18 @@ intent is to make it easy to do things like email notification on build
failures.
Following is an example event handler that prints the name of the event
-and the content of the ``FILE`` variable: addhandler
-myclass_eventhandler python myclass_eventhandler() { from bb.event
-import getName print("The name of the Event is %s" % getName(e))
-print("The file we run for is %s" % d.getVar('FILE')) }
-myclass_eventhandler[eventmask] = "bb.event.BuildStarted
-bb.event.BuildCompleted" In the previous example, an eventmask has been
+and the content of the ``FILE`` variable: ::
+
+ addhandler myclass_eventhandler
+ python myclass_eventhandler() {
+ from bb.event import getName
+ print("The name of the Event is %s" % getName(e))
+ print("The file we run for is %s" % d.getVar('FILE'))
+ }
+ myclass_eventhandler[eventmask] = "bb.event.BuildStarted
+ bb.event.BuildCompleted"
+
+In the previous example, an eventmask has been
set so that the handler only sees the "BuildStarted" and
"BuildCompleted" events. This event handler gets called every time an
event matching the eventmask is triggered. A global variable "e" is
@@ -1365,21 +1625,13 @@ information from the BitBake server to other parts of BitBake such as
user interfaces:
- ``bb.event.TreeDataPreparationStarted()``
-
- ``bb.event.TreeDataPreparationProgress()``
-
- ``bb.event.TreeDataPreparationCompleted()``
-
- ``bb.event.DepTreeGenerated()``
-
- ``bb.event.CoreBaseFilesFound()``
-
- ``bb.event.ConfigFilePathFound()``
-
- ``bb.event.FilesMatchingFound()``
-
- ``bb.event.ConfigFilesFound()``
-
- ``bb.event.TargetsTreeGenerated()``
.. _variants-class-extension-mechanism:
@@ -1390,49 +1642,43 @@ Variants - Class Extension Mechanism
BitBake supports two features that facilitate creating from a single
recipe file multiple incarnations of that recipe file where all
incarnations are buildable. These features are enabled through the
-:term:`BBCLASSEXTEND` and
-:term:`BBVERSIONS` variables.
+:term:`BBCLASSEXTEND` and :term:`BBVERSIONS` variables.
.. note::
The mechanism for this class extension is extremely specific to the
- implementation. Usually, the recipe's
- :term:`PROVIDES`
- ,
- :term:`PN`
- , and
- :term:`DEPENDS`
- variables would need to be modified by the extension class. For
- specific examples, see the OE-Core
- native
- ,
- nativesdk
- , and
- multilib
- classes.
-
-- *``BBCLASSEXTEND``:* This variable is a space separated list of
+ implementation. Usually, the recipe's :term:`PROVIDES` , :term:`PN` , and
+ :term:`DEPENDS` variables would need to be modified by the extension
+ class. For specific examples, see the OE-Core native , nativesdk , and
+ multilib classes.
+
+- ``BBCLASSEXTEND``: This variable is a space separated list of
classes used to "extend" the recipe for each variant. Here is an
example that results in a second incarnation of the current recipe
being available. This second incarnation will have the "native" class
- inherited. BBCLASSEXTEND = "native"
+ inherited. ::
+
+ BBCLASSEXTEND = "native"
-- *``BBVERSIONS``:* This variable allows a single recipe to build
+- ``BBVERSIONS``: This variable allows a single recipe to build
multiple versions of a project from a single recipe file. You can
also specify conditional metadata (using the
:term:`OVERRIDES` mechanism) for a single
version, or an optionally named range of versions. Here is an
- example: BBVERSIONS = "1.0 2.0 git" SRC_URI_git =
- "git://someurl/somepath.git" BBVERSIONS = "1.0.[0-6]:1.0.0+ \\
- 1.0.[7-9]:1.0.7+" SRC_URI_append_1.0.7+ =
- "file://some_patch_which_the_new_versions_need.patch;patch=1" The
- name of the range defaults to the original version of the recipe. For
- example, in OpenEmbedded, the recipe file ``foo_1.0.0+.bb`` creates a
- default name range of ``1.0.0+``. This is useful because the range
- name is not only placed into overrides, but it is also made available
- for the metadata to use in the variable that defines the base recipe
- versions for use in ``file://`` search paths
- (:term:`FILESPATH`).
+ example: ::
+
+ BBVERSIONS = "1.0 2.0 git"
+ SRC_URI_git = "git://someurl/somepath.git"
+
+ BBVERSIONS = "1.0.[0-6]:1.0.0+ 1.0.[7-9]:1.0.7+"
+ SRC_URI_append_1.0.7+ = "file://some_patch_which_the_new_versions_need.patch;patch=1"
+
+ The name of the range defaults to the original version of the recipe. For
+ example, in OpenEmbedded, the recipe file ``foo_1.0.0+.bb`` creates a default
+ name range of ``1.0.0+``. This is useful because the range name is not only
+ placed into overrides, but it is also made available for the metadata to use
+ in the variable that defines the base recipe versions for use in ``file://``
+ search paths (:term:`FILESPATH`).
Dependencies
============
@@ -1462,8 +1708,11 @@ Dependencies Internal to the ``.bb`` File
BitBake uses the ``addtask`` directive to manage dependencies that are
internal to a given recipe file. You can use the ``addtask`` directive
to indicate when a task is dependent on other tasks or when other tasks
-depend on that recipe. Here is an example: addtask printdate after
-do_fetch before do_build In this example, the ``do_printdate`` task
+depend on that recipe. Here is an example: ::
+
+ addtask printdate after do_fetch before do_build
+
+In this example, the ``do_printdate`` task
depends on the completion of the ``do_fetch`` task, and the ``do_build``
task depends on the completion of the ``do_printdate`` task.
@@ -1476,16 +1725,19 @@ task depends on the completion of the ``do_printdate`` task.
- The directive ``addtask mytask before do_configure`` causes
``do_mytask`` to run before ``do_configure`` runs. Be aware that
- ``do_mytask`` still only runs if its `input
- checksum <#checksums>`__ has changed since the last time it was
+ ``do_mytask`` still only runs if its :ref:`input
+ checksum <bitbake-user-manual/bitbake-user-manual-execution:checksums (signatures)>` has changed since the last time it was
run. Changes to the input checksum of ``do_mytask`` also
indirectly cause ``do_configure`` to run.
- The directive ``addtask mytask after do_configure`` by itself
never causes ``do_mytask`` to run. ``do_mytask`` can still be run
- manually as follows: $ bitbake recipe -c mytask Declaring
- ``do_mytask`` as a dependency of some other task that is scheduled
- to run also causes it to run. Regardless, the task runs after
+ manually as follows: ::
+
+ $ bitbake recipe -c mytask
+
+ Declaring ``do_mytask`` as a dependency of some other task that is
+ scheduled to run also causes it to run. Regardless, the task runs after
``do_configure``.
Build Dependencies
@@ -1494,24 +1746,29 @@ Build Dependencies
BitBake uses the :term:`DEPENDS` variable to manage
build time dependencies. The ``[deptask]`` varflag for tasks signifies
the task of each item listed in ``DEPENDS`` that must complete before
-that task can be executed. Here is an example: do_configure[deptask] =
-"do_populate_sysroot" In this example, the ``do_populate_sysroot`` task
+that task can be executed. Here is an example: ::
+
+ do_configure[deptask] = "do_populate_sysroot"
+
+In this example, the ``do_populate_sysroot`` task
of each item in ``DEPENDS`` must complete before ``do_configure`` can
execute.
Runtime Dependencies
--------------------
-BitBake uses the :term:`PACKAGES`,
-:term:`RDEPENDS`, and
-:term:`RRECOMMENDS` variables to manage runtime
-dependencies.
+BitBake uses the :term:`PACKAGES`, :term:`RDEPENDS`, and :term:`RRECOMMENDS`
+variables to manage runtime dependencies.
The ``PACKAGES`` variable lists runtime packages. Each of those packages
can have ``RDEPENDS`` and ``RRECOMMENDS`` runtime dependencies. The
``[rdeptask]`` flag for tasks is used to signify the task of each item
runtime dependency which must have completed before that task can be
-executed. do_package_qa[rdeptask] = "do_packagedata" In the previous
+executed. ::
+
+ do_package_qa[rdeptask] = "do_packagedata"
+
+In the previous
example, the ``do_packagedata`` task of each item in ``RDEPENDS`` must
have completed before ``do_package_qa`` can execute.
Although ``RDEPENDS`` contains entries from the
@@ -1531,14 +1788,18 @@ dependencies are discovered and added.
The ``[recrdeptask]`` flag is most commonly used in high-level recipes
that need to wait for some task to finish "globally". For example,
-``image.bbclass`` has the following: do_rootfs[recrdeptask] +=
-"do_packagedata" This statement says that the ``do_packagedata`` task of
+``image.bbclass`` has the following: ::
+
+ do_rootfs[recrdeptask] += "do_packagedata"
+
+This statement says that the ``do_packagedata`` task of
the current recipe and all recipes reachable (by way of dependencies)
from the image recipe must run before the ``do_rootfs`` task can run.
BitBake allows a task to recursively depend on itself by
-referencing itself in the task list:
-do_a[recrdeptask] = "do_a do_b"
+referencing itself in the task list: ::
+
+ do_a[recrdeptask] = "do_a do_b"
In the same way as before, this means that the ``do_a``
and ``do_b`` tasks of the current recipe and all
@@ -1553,10 +1814,12 @@ Inter-Task Dependencies
BitBake uses the ``[depends]`` flag in a more generic form to manage
inter-task dependencies. This more generic form allows for
inter-dependency checks for specific tasks rather than checks for the
-data in ``DEPENDS``. Here is an example: do_patch[depends] =
-"quilt-native:do_populate_sysroot" In this example, the
-``do_populate_sysroot`` task of the target ``quilt-native`` must have
-completed before the ``do_patch`` task can execute.
+data in ``DEPENDS``. Here is an example: ::
+
+ do_patch[depends] = "quilt-native:do_populate_sysroot"
+
+In this example, the ``do_populate_sysroot`` task of the target ``quilt-native``
+must have completed before the ``do_patch`` task can execute.
The ``[rdepends]`` flag works in a similar way but takes targets in the
runtime namespace instead of the build-time dependency namespace.
@@ -1575,83 +1838,58 @@ 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)`` | Returns the value of variable |
-| | "X". Using "expand=True" expands |
-| | the value. Returns "None" if the |
-| | variable "X" does not exist. |
-+-----------------------------------+-----------------------------------+
-| ``d.setVar("X", "value")`` | Sets the variable "X" to "value". |
-+-----------------------------------+-----------------------------------+
-| ``d.appendVar("X", "value")`` | Adds "value" to the end of the |
-| | variable "X". Acts like |
-| | ``d.setVar("X", "value")`` if the |
-| | variable "X" does not exist. |
-+-----------------------------------+-----------------------------------+
-| ``d.prependVar("X", "value")`` | Adds "value" to the start of the |
-| | variable "X". Acts like |
-| | ``d.setVar("X", "value")`` if the |
-| | variable "X" does not exist. |
-+-----------------------------------+-----------------------------------+
-| ``d.delVar("X")`` | Deletes the variable "X" from the |
-| | datastore. Does nothing if the |
-| | variable "X" does not exist. |
-+-----------------------------------+-----------------------------------+
-| ``d.renameVar("X", "Y")`` | Renames the variable "X" to "Y". |
-| | Does nothing if the variable "X" |
-| | does not exist. |
-+-----------------------------------+-----------------------------------+
-| `` | Returns the value of variable |
-| d.getVarFlag("X", flag, expand)`` | "X". Using "expand=True" expands |
-| | the value. Returns "None" if |
-| | either the variable "X" or the |
-| | named flag does not exist. |
-+-----------------------------------+-----------------------------------+
-| ``d | Sets the named flag for variable |
-| .setVarFlag("X", flag, "value")`` | "X" to "value". |
-+-----------------------------------+-----------------------------------+
-| ``d.ap | Appends "value" to the named flag |
-| pendVarFlag("X", flag, "value")`` | on the variable "X". Acts like |
-| | ``d |
-| | .setVarFlag("X", flag, "value")`` |
-| | if the named flag does not exist. |
-+-----------------------------------+-----------------------------------+
-| ``d.pre | Prepends "value" to the named |
-| pendVarFlag("X", flag, "value")`` | flag on the variable "X". Acts |
-| | like |
-| | ``d |
-| | .setVarFlag("X", flag, "value")`` |
-| | if the named flag does not exist. |
-+-----------------------------------+-----------------------------------+
-| ``d.delVarFlag("X", flag)`` | Deletes the named flag on the |
-| | variable "X" from the datastore. |
-+-----------------------------------+-----------------------------------+
-| ``d.setVarFlags("X", flagsdict)`` | Sets the flags specified in the |
-| | ``flagsdict()`` parameter. |
-| | ``setVarFlags`` does not clear |
-| | previous flags. Think of this |
-| | operation as ``addVarFlags``. |
-+-----------------------------------+-----------------------------------+
-| ``d.getVarFlags("X")`` | Returns a ``flagsdict`` of the |
-| | flags for the variable "X". |
-| | Returns "None" if the variable |
-| | "X" does not exist. |
-+-----------------------------------+-----------------------------------+
-| ``d.delVarFlags("X")`` | Deletes all the flags for the |
-| | variable "X". Does nothing if the |
-| | variable "X" does not exist. |
-+-----------------------------------+-----------------------------------+
-| ``d.expand(expression)`` | Expands variable references in |
-| | the specified string expression. |
-| | References to variables that do |
-| | not exist are left as is. For |
-| | example, ``d.expand("foo ${X}")`` |
-| | expands to the literal string |
-| | "foo ${X}" if the variable "X" |
-| | does not exist. |
-+-----------------------------------+-----------------------------------+
+.. list-table::
+ :widths: auto
+ :header-rows: 1
+
+ * - *Operation*
+ - *Description*
+ * - ``d.getVar("X", expand)``
+ - Returns the value of variable "X". Using "expand=True" expands the
+ value. Returns "None" if the variable "X" does not exist.
+ * - ``d.setVar("X", "value")``
+ - Sets the variable "X" to "value"
+ * - ``d.appendVar("X", "value")``
+ - Adds "value" to the end of the variable "X". Acts like ``d.setVar("X",
+ "value")`` if the variable "X" does not exist.
+ * - ``d.prependVar("X", "value")``
+ - Adds "value" to the start of the variable "X". Acts like
+ ``d.setVar("X","value")`` if the variable "X" does not exist.
+ * - ``d.delVar("X")``
+ - Deletes the variable "X" from the datastore. Does nothing if the variable
+ "X" does not exist.
+ * - ``d.renameVar("X", "Y")``
+ - Renames the variable "X" to "Y". Does nothing if the variable "X" does
+ not exist.
+ * - ``d.getVarFlag("X", flag, expand)``
+ - Returns the value of variable "X". Using "expand=True" expands the
+ value. Returns "None" if either the variable "X" or the named flag does
+ not exist.
+ * - ``d.setVarFlag("X", flag, "value")``
+ - Sets the named flag for variable "X" to "value".
+ * - ``d.appendVarFlag("X", flag, "value")``
+ - Appends "value" to the named flag on the variable "X". Acts like
+ ``d.setVarFlag("X", flag, "value")`` if the named flag does not exist.
+ * - ``d.prependVarFlag("X", flag, "value")``
+ - Prepends "value" to the named flag on the variable "X". Acts like
+ ``d.setVarFlag("X", flag, "value")`` if the named flag does not exist.
+ * - ``d.delVarFlag("X", flag)``
+ - Deletes the named flag on the variable "X" from the datastore.
+ * - ``d.setVarFlags("X", flagsdict)``
+ - Sets the flags specified in the ``flagsdict()``
+ parameter. ``setVarFlags`` does not clear previous flags. Think of this
+ operation as ``addVarFlags``.
+ * - ``d.getVarFlags("X")``
+ - Returns a ``flagsdict`` of the flags for the variable "X". Returns "None"
+ if the variable "X" does not exist.
+ * - ``d.delVarFlags("X")``
+ - Deletes all the flags for the variable "X". Does nothing if the variable
+ "X" does not exist.
+ * - ``d.expand(expression)``
+ - Expands variable references in the specified string
+ expression. References to variables that do not exist are left as is. For
+ example, ``d.expand("foo ${X}")`` expands to the literal string "foo
+ ${X}" if the variable "X" does not exist.
Other Functions
---------------
@@ -1671,8 +1909,11 @@ To help understand how BitBake does this, the section assumes an
OpenEmbedded metadata-based example.
These checksums are stored in :term:`STAMP`. You can
-examine the checksums using the following BitBake command: $
-bitbake-dumpsigs This command returns the signature data in a readable
+examine the checksums using the following BitBake command: ::
+
+ $ bitbake-dumpsigs
+
+This command returns the signature data in a readable
format that allows you to examine the inputs used when the OpenEmbedded
build system generates signatures. For example, using
``bitbake-dumpsigs`` allows you to examine the ``do_compile`` task's
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index 61516a011..b82661c69 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -55,9 +55,11 @@ overview of their function and contents.
- Limited support for the "``*``" wildcard character for matching
against the beginning of host names exists. For example, the
following setting matches ``git.gnu.org``, ``ftp.gnu.org``, and
- ``foo.git.gnu.org``. BB_ALLOWED_NETWORKS = "\*.gnu.org"
+ ``foo.git.gnu.org``. ::
- .. note::
+ BB_ALLOWED_NETWORKS = "\*.gnu.org"
+
+ .. important::
The use of the "``*``" character only works at the beginning of
a host name and it must be isolated from the remainder of the
@@ -111,26 +113,48 @@ overview of their function and contents.
you to control the build based on these parameters.
Disk space monitoring is disabled by default. When setting this
- variable, use the following form: BB_DISKMON_DIRS =
- "<action>,<dir>,<threshold> [...]" where: <action> is: ABORT:
- Immediately abort the build when a threshold is broken. STOPTASKS:
- Stop the build after the currently executing tasks have finished when
- a threshold is broken. WARN: Issue a warning but continue the build
- when a threshold is broken. Subsequent warnings are issued as defined
- by the :term:`BB_DISKMON_WARNINTERVAL`
- variable, which must be defined. <dir> is: Any directory you choose.
- You can specify one or more directories to monitor by separating the
- groupings with a space. If two directories are on the same device,
- only the first directory is monitored. <threshold> is: Either the
- minimum available disk space, the minimum number of free inodes, or
- both. You must specify at least one. To omit one or the other, simply
- omit the value. Specify the threshold using G, M, K for Gbytes,
- Mbytes, and Kbytes, respectively. If you do not specify G, M, or K,
- Kbytes is assumed by default. Do not use GB, MB, or KB.
-
- Here are some examples: BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K
- WARN,${SSTATE_DIR},1G,100K" BB_DISKMON_DIRS =
- "STOPTASKS,${TMPDIR},1G" BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K"
+ variable, use the following form: ::
+
+ BB_DISKMON_DIRS = "<action>,<dir>,<threshold> [...]"
+
+ where:
+
+ <action> is:
+ ABORT: Immediately abort the build when
+ a threshold is broken.
+ STOPTASKS: Stop the build after the currently
+ executing tasks have finished when
+ a threshold is broken.
+ WARN: Issue a warning but continue the
+ build when a threshold is broken.
+ Subsequent warnings are issued as
+ defined by the
+ BB_DISKMON_WARNINTERVAL variable,
+ which must be defined.
+
+ <dir> is:
+ Any directory you choose. You can specify one or
+ more directories to monitor by separating the
+ groupings with a space. If two directories are
+ on the same device, only the first directory
+ is monitored.
+
+ <threshold> is:
+ Either the minimum available disk space,
+ the minimum number of free inodes, or
+ both. You must specify at least one. To
+ omit one or the other, simply omit the value.
+ Specify the threshold using G, M, K for Gbytes,
+ Mbytes, and Kbytes, respectively. If you do
+ not specify G, M, or K, Kbytes is assumed by
+ default. Do not use GB, MB, or KB.
+
+ Here are some examples: ::
+
+ BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K"
+ BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G"
+ BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K"
+
The first example works only if you also set the
:term:`BB_DISKMON_WARNINTERVAL`
variable. This example causes the build system to immediately abort
@@ -166,16 +190,28 @@ overview of their function and contents.
BB_DISKMON_WARNINTERVAL = "50M,5K"
When specifying the variable in your configuration file, use the
- following form: BB_DISKMON_WARNINTERVAL =
- "<disk_space_interval>,<disk_inode_interval>" where:
- <disk_space_interval> is: An interval of memory expressed in either
- G, M, or K for Gbytes, Mbytes, or Kbytes, respectively. You cannot
- use GB, MB, or KB. <disk_inode_interval> is: An interval of free
- inodes expressed in either G, M, or K for Gbytes, Mbytes, or Kbytes,
- respectively. You cannot use GB, MB, or KB.
-
- Here is an example: BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K"
- BB_DISKMON_WARNINTERVAL = "50M,5K" These variables cause BitBake to
+ following form: ::
+
+ BB_DISKMON_WARNINTERVAL = "<disk_space_interval>,<disk_inode_interval>"
+
+ where:
+
+ <disk_space_interval> is:
+ An interval of memory expressed in either
+ G, M, or K for Gbytes, Mbytes, or Kbytes,
+ respectively. You cannot use GB, MB, or KB.
+
+ <disk_inode_interval> is:
+ An interval of free inodes expressed in either
+ G, M, or K for Gbytes, Mbytes, or Kbytes,
+ respectively. You cannot use GB, MB, or KB.
+
+ Here is an example: ::
+
+ BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K"
+ BB_DISKMON_WARNINTERVAL = "50M,5K"
+
+ These variables cause BitBake to
issue subsequent warnings each time the available disk space further
reduces by 50 Mbytes or the number of free inodes further reduces by
5 Kbytes in the ``${SSTATE_DIR}`` directory. Subsequent warnings
@@ -186,10 +222,8 @@ overview of their function and contents.
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: :term:`BBPATH`,
- :term:`BB_PRESERVE_ENV`,
- :term:`BB_ENV_WHITELIST`, and
- :term:`BB_ENV_EXTRAWHITE`.
+ list is used: :term:`BBPATH`, :term:`BB_PRESERVE_ENV`,
+ :term:`BB_ENV_WHITELIST`, and :term:`BB_ENV_EXTRAWHITE`.
.. note::
@@ -264,8 +298,9 @@ overview of their function and contents.
wishing to create a source mirror would want to enable this variable.
For performance reasons, creating and placing tarballs of the Git
- repositories is not the default action by BitBake.
- BB_GENERATE_MIRROR_TARBALLS = "1"
+ repositories is not the default action by BitBake. ::
+
+ BB_GENERATE_MIRROR_TARBALLS = "1"
BB_HASHCONFIG_WHITELIST
Lists variables that are excluded from base configuration checksum,
@@ -308,21 +343,25 @@ overview of their function and contents.
BB_LOGCONFIG
Specifies the name of a config file that contains the user logging
- configuration. See `Logging <#logging>`__ for additional information
+ configuration. See
+ :ref:`bitbake-user-manual/bitbake-user-manual-execution:logging`
+ for additional information
BB_LOGFMT
Specifies the name of the log files saved into
``${``\ :term:`T`\ ``}``. By default, the ``BB_LOGFMT``
variable is undefined and the log file names get created using the
- following form: log.{task}.{pid} If you want to force log files to
- take a specific name, you can set this variable in a configuration
- file.
+ following form: ::
+
+ log.{task}.{pid}
+
+ If you want to force log files to take a specific name, you can set this
+ variable in a configuration file.
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
- :term:`BB_TASK_NICE_LEVEL` for
+ but not raise it again. See :term:`BB_TASK_NICE_LEVEL` for
additional information.
BB_NO_NETWORK
@@ -366,9 +405,12 @@ overview of their function and contents.
Specifies the name of the executable script files (i.e. run files)
saved into ``${``\ :term:`T`\ ``}``. By default, the
``BB_RUNFMT`` variable is undefined and the run file names get
- created using the following form: run.{task}.{pid} If you want to
- force run files to take a specific name, you can set this variable in
- a configuration file.
+ created using the following form: ::
+
+ run.{task}.{pid}
+
+ If you want to force run files to take a specific name, you can set this
+ variable in a configuration file.
BB_RUNTASK
Contains the name of the currently executing task. The value includes
@@ -423,8 +465,9 @@ overview of their function and contents.
generating checksum or dependency data for keys in the datastore, the
flags set against that key are normally included in the checksum.
- For more information on varflags, see the "`Variable
- Flags <#variable-flags>`__" section.
+ For more information on varflags, see the
+ ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variable flags`"
+ section.
BB_SIGNATURE_HANDLER
Defines the name of the signature handler BitBake uses. The signature
@@ -487,32 +530,30 @@ overview of their function and contents.
.. note::
- This variable works similarly to the
- :term:`BB_TASK_NICE_LEVEL`
+ This variable works similarly to the :term:`BB_TASK_NICE_LEVEL`
variable except with a task's I/O priorities.
- Set the variable as follows: BB_TASK_IONICE_LEVEL = "class.prio" For
- class, the default value is "2", which is a best effort. You can use
+ Set the variable as follows: ::
+
+ BB_TASK_IONICE_LEVEL = "class.prio"
+
+ For *class*, the default value is "2", which is a best effort. You can use
"1" for realtime and "3" for idle. If you want to use realtime, you
must have superuser privileges.
- For prio, you can use any value from "0", which is the highest
+ For *prio*, you can use any value from "0", which is the highest
priority, to "7", which is the lowest. The default value is "4". You
do not need any special privileges to use this range of priority
values.
.. note::
- In order for your I/O priority settings to take effect, you need
- the Completely Fair Queuing (CFQ) Scheduler selected for the
- backing block device. To select the scheduler, use the following
- command form where
- device
- is the device (e.g. sda, sdb, and so forth):
- ::
-
- $ sudo sh -c “echo cfq > /sys/block/device/queu/scheduler
+ In order for your I/O priority settings to take effect, you need the
+ Completely Fair Queuing (CFQ) Scheduler selected for the backing block
+ device. To select the scheduler, use the following command form where
+ device is the device (e.g. sda, sdb, and so forth): ::
+ $ sudo sh -c “echo cfq > /sys/block/device/queu/scheduler
BB_TASK_NICE_LEVEL
Allows specific tasks to change their priority (i.e. nice level).
@@ -551,8 +592,10 @@ overview of their function and contents.
To build a different variant of the recipe with a minimal amount of
code, it usually is as simple as adding the variable to your recipe.
Here are two examples. The "native" variants are from the
- OpenEmbedded-Core metadata: BBCLASSEXTEND =+ "native nativesdk"
- BBCLASSEXTEND =+ "multilib:multilib_name"
+ OpenEmbedded-Core metadata: ::
+
+ BBCLASSEXTEND =+ "native nativesdk"
+ BBCLASSEXTEND =+ "multilib:multilib_name"
.. note::
@@ -612,9 +655,8 @@ overview of their function and contents.
.. tip::
- You can use the command
- bitbake-layers show-layers
- to list all configured layers along with their priorities.
+ You can use the command bitbake-layers show-layers to list all
+ configured layers along with their priorities.
BBFILES
A space-separated list of recipe files BitBake uses to build
@@ -642,11 +684,17 @@ overview of their function and contents.
BBLAYERS
Lists the layers to enable during the build. This variable is defined
in the ``bblayers.conf`` configuration file in the build directory.
- Here is an example: BBLAYERS = " \\ /home/scottrif/poky/meta \\
- /home/scottrif/poky/meta-yocto \\ /home/scottrif/poky/meta-yocto-bsp
- \\ /home/scottrif/poky/meta-mykernel \\ " This example enables four
- layers, one of which is a custom, user-defined layer named
- ``meta-mykernel``.
+ Here is an example: ::
+
+ BBLAYERS = " \
+ /home/scottrif/poky/meta \
+ /home/scottrif/poky/meta-yocto \
+ /home/scottrif/poky/meta-yocto-bsp \
+ /home/scottrif/poky/meta-mykernel \
+ "
+
+ This example enables four layers, one of which is a custom, user-defined
+ layer named ``meta-mykernel``.
BBLAYERS_FETCH_DIR
Sets the base location where layers are stored. This setting is used
@@ -670,13 +718,19 @@ overview of their function and contents.
The following example uses a complete regular expression to tell
BitBake to ignore all recipe and recipe append files in the
- ``meta-ti/recipes-misc/`` directory: BBMASK = "meta-ti/recipes-misc/"
+ ``meta-ti/recipes-misc/`` directory: ::
+
+ BBMASK = "meta-ti/recipes-misc/"
+
If you want to mask out multiple directories or recipes, you can
specify multiple regular expression fragments. This next example
- masks out multiple directories and individual recipes: BBMASK +=
- "/meta-ti/recipes-misc/ meta-ti/recipes-ti/packagegroup/" BBMASK +=
- "/meta-oe/recipes-support/" BBMASK += "/meta-foo/.*/openldap" BBMASK
- += "opencv.*\.bbappend" BBMASK += "lzma"
+ masks out multiple directories and individual recipes: ::
+
+ BBMASK += "/meta-ti/recipes-misc/ meta-ti/recipes-ti/packagegroup/"
+ BBMASK += "/meta-oe/recipes-support/"
+ BBMASK += "/meta-foo/.*/openldap"
+ BBMASK += "opencv.*\.bbappend"
+ BBMASK += "lzma"
.. note::
@@ -691,15 +745,18 @@ overview of their function and contents.
``conf/local.conf`` configuration file.
As an example, the following line specifies three multiconfigs, each
- having a separate configuration file: BBMULTIFONFIG = "configA
- configB configC" Each configuration file you use must reside in the
+ having a separate configuration file: ::
+
+ BBMULTIFONFIG = "configA configB configC"
+
+ Each configuration file you use must reside in the
build directory within a directory named ``conf/multiconfig`` (e.g.
build_directory\ ``/conf/multiconfig/configA.conf``).
For information on how to use ``BBMULTICONFIG`` in an environment
that supports building targets with multiple configurations, see the
- "`Executing a Multiple Configuration
- Build <#executing-a-multiple-configuration-build>`__" section.
+ ":ref:`bitbake-user-manual/bitbake-user-manual-intro:executing a multiple configuration build`"
+ section.
BBPATH
Used by BitBake to locate class (``.bbclass``) and configuration
@@ -709,7 +766,11 @@ overview of their function and contents.
If you run BitBake from a directory outside of the build directory,
you must be sure to set ``BBPATH`` to point to the build directory.
Set the variable as you would any environment variable and then run
- BitBake: $ BBPATH="build_directory" $ export BBPATH $ bitbake target
+ BitBake: ::
+
+ $ BBPATH="build_directory"
+ $ export BBPATH
+ $ bitbake target
BBSERVER
Points to the server that runs memory-resident BitBake. The variable
@@ -725,8 +786,8 @@ overview of their function and contents.
using the :term:`OVERRIDES` mechanism for a
single version or for an optionally named range of versions.
- For more information on ``BBVERSIONS``, see the "`Variants - Class
- Extension Mechanism <#variants-class-extension-mechanism>`__"
+ For more information on ``BBVERSIONS``, see the
+ ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variants - class extension mechanism`"
section.
BITBAKE_UI
@@ -765,37 +826,35 @@ overview of their function and contents.
.. note::
- The bias provided by
- DEFAULT_PREFERENCE
- is weak and is overridden by
- :term:`BBFILE_PRIORITY`
- if that variable is different between two layers that contain
- different versions of the same recipe.
+ The bias provided by DEFAULT_PREFERENCE is weak and is overridden by
+ :term:`BBFILE_PRIORITY` if that variable is different between two
+ layers that contain different versions of the same recipe.
DEPENDS
Lists a recipe's build-time dependencies (i.e. other recipe files).
Consider this simple example for two recipes named "a" and "b" that
produce similarly named packages. In this example, the ``DEPENDS``
- statement appears in the "a" recipe: DEPENDS = "b" Here, the
- dependency is such that the ``do_configure`` task for recipe "a"
+ statement appears in the "a" recipe: ::
+
+ DEPENDS = "b"
+
+ Here, the dependency is such that the ``do_configure`` task for recipe "a"
depends on the ``do_populate_sysroot`` task of recipe "b". This means
- anything that recipe "b" puts into sysroot is available when recipe
- "a" is configuring itself.
+ anything that recipe "b" puts into sysroot is available when recipe "a" is
+ configuring itself.
- For information on runtime dependencies, see the
- :term:`RDEPENDS` variable.
+ For information on runtime dependencies, see the :term:`RDEPENDS`
+ variable.
DESCRIPTION
A long description for the recipe.
DL_DIR
The central download directory used by the build process to store
- downloads. By default, ``DL_DIR`` gets files suitable for mirroring
- for everything except Git repositories. If you want tarballs of Git
- repositories, use the
- :term:`BB_GENERATE_MIRROR_TARBALLS`
- variable.
+ downloads. By default, ``DL_DIR`` gets files suitable for mirroring for
+ everything except Git repositories. If you want tarballs of Git
+ repositories, use the :term:`BB_GENERATE_MIRROR_TARBALLS` variable.
EXCLUDE_FROM_WORLD
Directs BitBake to exclude a recipe from world builds (i.e.
@@ -808,13 +867,10 @@ overview of their function and contents.
.. note::
- Recipes added to
- EXCLUDE_FROM_WORLD
- may still be built during a world build in order to satisfy
- dependencies of other recipes. Adding a recipe to
- EXCLUDE_FROM_WORLD
- only ensures that the recipe is not explicitly added to the list
- of build targets in a world build.
+ Recipes added to ``EXCLUDE_FROM_WORLD`` may still be built during a world
+ build in order to satisfy dependencies of other recipes. Adding a
+ recipe to ``EXCLUDE_FROM_WORLD`` only ensures that the recipe is not
+ explicitly added to the list of build targets in a world build.
FAKEROOT
Contains the command to use when running a shell script in a fakeroot
@@ -883,8 +939,8 @@ overview of their function and contents.
configuration and in each individual recipe. The OpenEmbedded build
system ignores changes to ``INHERIT`` in individual recipes.
- For more information on ``INHERIT``, see the "```INHERIT``
- Configuration Directive <#inherit-configuration-directive>`__"
+ For more information on ``INHERIT``, see the
+ ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`"
section.
LAYERDEPENDS
@@ -953,8 +1009,9 @@ overview of their function and contents.
Following is a simple example that uses an overrides list based on
machine architectures: OVERRIDES = "arm:x86:mips:powerpc" You can
- find information on how to use ``OVERRIDES`` in the "`Conditional
- Syntax (Overrides) <#conditional-syntax-overrides>`__" section.
+ find information on how to use ``OVERRIDES`` in the
+ ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax
+ (overrides)`" section.
P4DIR
The directory in which a local copy of a Perforce depot is stored
@@ -1000,20 +1057,26 @@ overview of their function and contents.
recipes provide the same item. You should always suffix the variable
with the name of the provided item, and you should set it to the
:term:`PN` of the recipe to which you want to give
- precedence. Some examples: PREFERRED_PROVIDER_virtual/kernel ?=
- "linux-yocto" PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86"
- PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
+ precedence. Some examples: ::
+
+ PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto"
+ PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86"
+ PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
PREFERRED_PROVIDERS
Determines which recipe should be given preference for cases where
multiple recipes provide the same item. Functionally,
``PREFERRED_PROVIDERS`` is identical to
- :term:`PREFERRED_PROVIDER`. However, the
- ``PREFERRED_PROVIDERS`` variable lets you define preferences for
- multiple situations using the following form: PREFERRED_PROVIDERS =
- "xxx:yyy aaa:bbb ..." This form is a convenient replacement for the
- following: PREFERRED_PROVIDER_xxx = "yyy" PREFERRED_PROVIDER_aaa =
- "bbb"
+ :term:`PREFERRED_PROVIDER`. However, the ``PREFERRED_PROVIDERS`` variable
+ lets you define preferences for multiple situations using the following
+ form: ::
+
+ PREFERRED_PROVIDERS = "xxx:yyy aaa:bbb ..."
+
+ This form is a convenient replacement for the following: ::
+
+ PREFERRED_PROVIDER_xxx = "yyy"
+ PREFERRED_PROVIDER_aaa = "bbb"
PREFERRED_VERSION
If there are multiple versions of recipes available, this variable
@@ -1026,15 +1089,15 @@ overview of their function and contents.
through the "``%``" character. You can use the character to match any
number of characters, which can be useful when specifying versions
that contain long revision numbers that potentially change. Here are
- two examples: PREFERRED_VERSION_python = "2.7.3"
- PREFERRED_VERSION_linux-yocto = "4.12%"
+ two examples: ::
- .. note::
+ PREFERRED_VERSION_python = "2.7.3"
+ PREFERRED_VERSION_linux-yocto = "4.12%"
- The use of the "
- %
- " character is limited in that it only works at the end of the
- string. You cannot use the wildcard character in any other
+ .. important::
+
+ The use of the " % " character is limited in that it only works at the
+ end of the string. You cannot use the wildcard character in any other
location of the string.
PREMIRRORS
@@ -1042,19 +1105,21 @@ overview of their function and contents.
the build system searches for source code, it first tries the local
download directory. If that location fails, the build system tries
locations defined by ``PREMIRRORS``, the upstream source, and then
- locations specified by :term:`MIRRORS` in that
- order.
+ locations specified by :term:`MIRRORS` in that order.
Typically, you would add a specific server for the build system to
attempt before any others by adding something like the following to
- your configuration: PREMIRRORS_prepend = "\\ git://.*/.\*
- http://www.yoctoproject.org/sources/ \\n \\ ftp://.*/.\*
- http://www.yoctoproject.org/sources/ \\n \\ http://.*/.\*
- http://www.yoctoproject.org/sources/ \\n \\ https://.*/.\*
- http://www.yoctoproject.org/sources/ \\n" These changes cause the
- build system to intercept Git, FTP, HTTP, and HTTPS requests and
- direct them to the ``http://`` sources mirror. You can use
- ``file://`` URLs to point to local directories or network shares as
+ your configuration: ::
+
+ PREMIRRORS_prepend = "\
+ git://.*/.* http://www.yoctoproject.org/sources/ \n \
+ ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
+ http://.*/.* http://www.yoctoproject.org/sources/ \n \
+ https://.*/.* http://www.yoctoproject.org/sources/ \n"
+
+ These changes cause the build system to intercept Git, FTP, HTTP, and
+ HTTPS requests and direct them to the ``http://`` sources mirror. You can
+ use ``file://`` URLs to point to local directories or network shares as
well.
PROVIDES
@@ -1066,9 +1131,12 @@ overview of their function and contents.
``DEPENDS``.
Consider the following example ``PROVIDES`` statement from a recipe
- file ``libav_0.8.11.bb``: PROVIDES += "libpostproc" The ``PROVIDES``
- statement results in the "libav" recipe also being known as
- "libpostproc".
+ file ``libav_0.8.11.bb``: ::
+
+ PROVIDES += "libpostproc"
+
+ The ``PROVIDES`` statement results in the "libav" recipe also being known
+ as "libpostproc".
In addition to providing recipes under alternate names, the
``PROVIDES`` mechanism is also used to implement virtual targets. A
@@ -1086,10 +1154,13 @@ overview of their function and contents.
PRSERV_HOST
The network based :term:`PR` service host and port.
- Following is an example of how the ``PRSERV_HOST`` variable is set:
- PRSERV_HOST = "localhost:0" You must set the variable if you want to
- automatically start a local PR service. You can set ``PRSERV_HOST``
- to other values to use a remote PR service.
+ Following is an example of how the ``PRSERV_HOST`` variable is set: ::
+
+ PRSERV_HOST = "localhost:0"
+
+ You must set the variable if you want to automatically start a local PR
+ service. You can set ``PRSERV_HOST`` to other values to use a remote PR
+ service.
PV
The version of the recipe.
@@ -1104,21 +1175,36 @@ overview of their function and contents.
you should always use the variable in a form with an attached package
name. For example, suppose you are building a development package
that depends on the ``perl`` package. In this case, you would use the
- following ``RDEPENDS`` statement: RDEPENDS_${PN}-dev += "perl" In the
- example, the development package depends on the ``perl`` package.
- Thus, the ``RDEPENDS`` variable has the ``${PN}-dev`` package name as
- part of the variable.
+ following ``RDEPENDS`` statement: ::
+
+ RDEPENDS_${PN}-dev += "perl"
+
+ In the example, the development package depends on the ``perl`` package.
+ Thus, the ``RDEPENDS`` variable has the ``${PN}-dev`` package name as part
+ of the variable.
BitBake supports specifying versioned dependencies. Although the
syntax varies depending on the packaging format, BitBake hides these
differences from you. Here is the general syntax to specify versions
- with the ``RDEPENDS`` variable: RDEPENDS_${PN} = "package (operator
- version)" For ``operator``, you can specify the following: = < > <=
- >= For example, the following sets up a dependency on version 1.2 or
- greater of the package ``foo``: RDEPENDS_${PN} = "foo (>= 1.2)"
+ with the ``RDEPENDS`` variable: ::
+
+ RDEPENDS_${PN} = "package (operator version)"
- For information on build-time dependencies, see the
- :term:`DEPENDS` variable.
+ For ``operator``, you can specify the following: ::
+
+ =
+ <
+ >
+ <=
+ >=
+
+ For example, the following sets up a dependency on version 1.2 or
+ greater of the package ``foo``: ::
+
+ RDEPENDS_${PN} = "foo (>= 1.2)"
+
+ For information on build-time dependencies, see the :term:`DEPENDS`
+ variable.
REPODIR
The directory in which a local copy of a ``google-repo`` directory is
@@ -1132,7 +1218,9 @@ overview of their function and contents.
As with all package-controlling variables, you must always use the
variable in conjunction with a package name override. Here is an
- example: RPROVIDES_${PN} = "widget-abi-2"
+ example: ::
+
+ RPROVIDES_${PN} = "widget-abi-2"
RRECOMMENDS
A list of packages that extends the usability of a package being
@@ -1144,11 +1232,22 @@ overview of their function and contents.
BitBake supports specifying versioned recommends. Although the syntax
varies depending on the packaging format, BitBake hides these
differences from you. Here is the general syntax to specify versions
- with the ``RRECOMMENDS`` variable: RRECOMMENDS_${PN} = "package
- (operator version)" For ``operator``, you can specify the following:
- = < > <= >= For example, the following sets up a recommend on version
- 1.2 or greater of the package ``foo``: RRECOMMENDS_${PN} = "foo (>=
- 1.2)"
+ with the ``RRECOMMENDS`` variable: ::
+
+ RRECOMMENDS_${PN} = "package (operator version)"
+
+ For ``operator``, you can specify the following: ::
+
+ =
+ <
+ >
+ <=
+ >=
+
+ For example, the following sets up a recommend on version
+ 1.2 or greater of the package ``foo``: ::
+
+ RRECOMMENDS_${PN} = "foo (>= 1.2)"
SECTION
The section in which packages should be categorized.
@@ -1165,56 +1264,56 @@ overview of their function and contents.
The following list explains the available URI protocols:
- - *``file://`` -* Fetches files, which are usually files shipped
+ - ``file://`` : Fetches files, which are usually files shipped
with the metadata, from the local machine. The path is relative to
the :term:`FILESPATH` variable.
- - *``bzr://`` -* Fetches files from a Bazaar revision control
+ - ``bzr://`` : Fetches files from a Bazaar revision control
repository.
- - *``git://`` -* Fetches files from a Git revision control
+ - ``git://`` : Fetches files from a Git revision control
repository.
- - *``osc://`` -* Fetches files from an OSC (OpenSUSE Build service)
+ - ``osc://`` : Fetches files from an OSC (OpenSUSE Build service)
revision control repository.
- - *``repo://`` -* Fetches files from a repo (Git) repository.
+ - ``repo://`` : Fetches files from a repo (Git) repository.
- - *``http://`` -* Fetches files from the Internet using HTTP.
+ - ``http://`` : Fetches files from the Internet using HTTP.
- - *``https://`` -* Fetches files from the Internet using HTTPS.
+ - ``https://`` : Fetches files from the Internet using HTTPS.
- - *``ftp://`` -* Fetches files from the Internet using FTP.
+ - ``ftp://`` : Fetches files from the Internet using FTP.
- - *``cvs://`` -* Fetches files from a CVS revision control
+ - ``cvs://`` : Fetches files from a CVS revision control
repository.
- - *``hg://`` -* Fetches files from a Mercurial (``hg``) revision
+ - ``hg://`` : Fetches files from a Mercurial (``hg``) revision
control repository.
- - *``p4://`` -* Fetches files from a Perforce (``p4``) revision
+ - ``p4://`` : Fetches files from a Perforce (``p4``) revision
control repository.
- - *``ssh://`` -* Fetches files from a secure shell.
+ - ``ssh://`` : Fetches files from a secure shell.
- - *``svn://`` -* Fetches files from a Subversion (``svn``) revision
+ - ``svn://`` : Fetches files from a Subversion (``svn``) revision
control repository.
Here are some additional options worth mentioning:
- - *``unpack`` -* Controls whether or not to unpack the file if it is
+ - ``unpack`` : Controls whether or not to unpack the file if it is
an archive. The default action is to unpack the file.
- - *``subdir`` -* Places the file (or extracts its contents) into the
+ - ``subdir`` : Places the file (or extracts its contents) into the
specified subdirectory. This option is useful for unusual tarballs
or other archives that do not have their files already in a
subdirectory within the archive.
- - *``name`` -* Specifies a name to be used for association with
+ - ``name`` : Specifies a name to be used for association with
``SRC_URI`` checksums when you have more than one file specified
in ``SRC_URI``.
- - *``downloadfilename`` -* Specifies the filename used when storing
+ - ``downloadfilename`` : Specifies the filename used when storing
the downloaded file.
SRCDATE