diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 12839ba138..facf2edb68 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -53,15 +53,16 @@
By default, BitBake does not produce empty packages.
This default behavior can cause issues when there is an
RDEPENDS or
- some other runtime hard-requirement on the existence of the package.
+ some other hard runtime requirement on the existence of the package.
Like all package-controlling variables, you must always use them in
- conjunction with a package name override.
- Here is an example:
+ conjunction with a package name override, as in:
ALLOW_EMPTY_${PN} = "1"
+ ALLOW_EMPTY_${PN}-dev = "1"
+ ALLOW_EMPTY_${PN}-staticdev = "1"
@@ -234,9 +235,9 @@
in which the OpenEmbedded build system places generated
objects during a recipe's build process.
By default, this directory is the same as the S
- directory:
+ directory, which is defined as:
- B = "${WORKDIR}/${BPN}/{PV}/"
+ S = "${WORKDIR}/${BP}/"
You can separate the (S) directory
and the directory pointed to by the B
@@ -503,7 +504,7 @@
the Git repositories is not the default action by the
OpenEmbedded build system.
- BB_Generate_MIRROR_TARBALLS = "1"
+ BB_GENERATE_MIRROR_TARBALLS = "1"
Set this variable in your local.conf
file in the
@@ -515,7 +516,7 @@
BB_NUMBER_THREADSThe maximum number of tasks BitBake should run in parallel at any one time.
- If your host development system supports multiple cores a good rule of thumb
+ If your host development system supports multiple cores, a good rule of thumb
is to set this variable to twice the number of cores.
@@ -591,7 +592,7 @@
for a layer with no dependencies, is the lowest defined priority + 1
(or 1 if no priorities are defined).
- You can use the command bitbake-layers show_layers to list
+ You can use the command bitbake-layers show-layers to list
all configured layers along with their priorities.
@@ -974,8 +975,8 @@
Then, provide a space-separated list of files.
Here is an example:
- CONFFILES_${PN} += "${sysconfdir}/file1 \
- ${sysconfdir}/file2 ${sysconfdir}/file3"
+ CONFFILES_${PN} += "${sysconfdir}/file1 \
+ ${sysconfdir}/file2 ${sysconfdir}/file3"
@@ -1090,7 +1091,7 @@
TARGET_CFLAGS
and CFLAGS when compiling
a system for debugging.
- This variable defaults to "-O -fno-omit-frame-pointer -g".
+ This variable defaults to "-O -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe".
@@ -1113,7 +1114,7 @@
The bias provided by DEFAULT_PREFERENCE
is weak and is overridden by
BBFILE_PRIORITY
- if the that variable is different between two layers
+ if that variable is different between two layers
that contain different versions of the same recipe.
@@ -1161,7 +1162,7 @@
files that are ready to be used outside of the build system.
By default, this directory resides within the
Build Directory
- as tmp/deploy.
+ as ${TMPDIR}/deploy.
@@ -1188,7 +1189,7 @@
${MACHINE} name.
By default, this directory resides within the
Build Directory
- as tmp/deploy/images/${MACHINE}/.
+ as ${DEPLOY_DIR}/images/${MACHINE}/.
@@ -1325,7 +1326,7 @@
DISTRO_VERSION
- the version of the distribution.
+ The version of the distribution.
@@ -1626,7 +1627,7 @@
Sometimes a recipe is required to build the final image but is not
needed in the root filesystem.
You can use the EXTRA_IMAGEDEPENDS variable to
- list these recipes and thus, specify the dependencies.
+ list these recipes and thus specify the dependencies.
A typical example is a required bootloader in a machine configuration.
@@ -1673,15 +1674,15 @@
files you want included as part of the resulting package.
Here is an example:
- FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile"
+ FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile"
When specifying paths as part of the FILES variable,
it is good practice to use appropriate path variables.
- For example, ${sysconfdir} rather than
- /etc or ${bindir} rather
+ For example, use ${sysconfdir} rather than
+ /etc, or ${bindir} rather
than /usr/bin.
You can find a list of these variables at the top of the
/meta/conf/bitbake.conf file in the
@@ -1854,7 +1855,7 @@
is located in the meta/files folder in the
Source Directory.
If you create your own file permissions setting table, you should place it in your
- layer or the distros layer.
+ layer or the distro's layer.
You define the FILESYSTEM_PERMS_TABLES variable in the
@@ -1880,7 +1881,7 @@
and CFLAGS
when compiling an optimized system.
This variable defaults to
- "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2".
+ "-O2 -pipe ${DEBUG_FLAGS}".
@@ -1987,7 +1988,7 @@
- For example that shows how to customize your image by
+ For an example that shows how to customize your image by
using this variable, see the
"Customizing Images Using Custom IMAGE_FEATURES and EXTRA_IMAGE_FEATURES"
section in the Yocto Project Development Manual.
@@ -2003,7 +2004,7 @@
For example, setting IMAGE_FSTYPES
as follows causes the build system to create root
filesystems using two formats: .ext3
- and tar.bz2:
+ and .tar.bz2:
IMAGE_FSTYPES = "ext3 tar.bz2"
@@ -2041,7 +2042,7 @@
+= operation against IMAGE_INSTALL
will result in unexpected behavior when used in
/conf/local.conf.
- Furthermore, the same operation from with an image recipe may or may not
+ Furthermore, the same operation from within an image recipe may or may not
succeed depending on the specific situation.
In both these cases, the behavior is contrary to how most users expect
the += operator to work.
@@ -2053,7 +2054,7 @@
IMAGE_INSTALL_append = " package-name"
Be sure to include the space between the quotation character and the start of the
- package name.
+ package name or names.
@@ -2139,9 +2140,9 @@
Alternatively, you can ensure a specific amount of free disk space is added
- to the image by using
+ to the image by using the
IMAGE_ROOTFS_EXTRA_SPACE
- the variable.
+ variable.
@@ -2194,6 +2195,14 @@
IMAGE_ROOTFS_EXTRA_SPACE = "5242880"
+
+
+ For example, the Yocto Project Build Appliance specifically requests 40 Gbytes
+ of extra space with the line:
+
+ IMAGE_ROOTFS_EXTRA_SPACE = "41943040"
+
+
@@ -2415,7 +2424,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
This variable is used in recipes when using update-rc.d.bbclass.
- The variable is Mandatory.
+ The variable is mandatory.
@@ -3094,11 +3103,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
MACHINE ?= "qemux86"
MACHINE ?= "qemux86-64"
MACHINE ?= "genericx86"
+ MACHINE ?= "genericx86-64"
MACHINE ?= "beagleboard"
MACHINE ?= "mpc8315e-rdb"
MACHINE ?= "routerstationpro"
- The last four are Yocto Project reference hardware boards, which
+ The last five are Yocto Project reference hardware boards, which
are provided in the meta-yocto-bsp layer.
Adding additional Board Support Package (BSP) layers
to your configuration adds new possible settings for
@@ -3477,7 +3487,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Some recommended packages might be required for certain
system functionality, such as kernel modules.
- It is up to you to add packages with
+ It is up to you to add packages with the
IMAGE_INSTALL
variable.
@@ -3656,7 +3666,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Enables easily adding packages to
PACKAGES
before ${PN}
- so that the packages can pick up files that would normally be
+ so that those added packages can pick up files that would normally be
included in the default package.
@@ -3874,7 +3884,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
PACKAGECONFIG="f4 f5"
- Or, you can just amended the variable:
+ Or, you can just append the variable:
PACKAGECONFIG_append = " f4"
@@ -3984,15 +3994,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
-
-
-
-PARALLEL_MAKEINST with the description ".
-
-
-
-
-
PATCHRESOLVE
@@ -4089,6 +4090,11 @@ PARALLEL_MAKEINST with the description ".
do_packagedata task packages
data for each recipe and installs it into this temporary,
shared area.
+ This directory defaults to the following:
+
+ ${STAGING_DIR_HOST}/pkgdata
+
+ Do not change this default.
@@ -4174,9 +4180,11 @@ PARALLEL_MAKEINST with the description ".
provided item, and you should set it to the
PN
of the recipe to which you want to give precedence.
- Here is an example:
+ Some examples:
+ PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto"
PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86"
+ PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
@@ -4189,7 +4197,7 @@ PARALLEL_MAKEINST with the description ".
variable determines which recipe should be given preference.
You must always suffix the variable with the
PN
- you want to select, and you should set to the
+ you want to select, and you should set the
PV
accordingly for precedence.
You can use the "%" character as a
@@ -4198,8 +4206,8 @@ PARALLEL_MAKEINST with the description ".
numbers that could potentially change.
Here are two examples:
- PREFERRED_VERSION_python = "2.6.6"
- PREFERRED_VERSION_linux-yocto = "3.0+git%"
+ PREFERRED_VERSION_python = "2.7.3"
+ PREFERRED_VERSION_linux-yocto = "3.10%"
@@ -4257,7 +4265,7 @@ PARALLEL_MAKEINST with the description ".
dynamically increment.
This increment minimizes the impact of layer ordering.
In order to ensure multiple .bbappend files can co-exist,
- PRINC should be self referencing.
+ PRINC should be self-referencing.
This variable defaults to 0.Following is an example that increments PR by two:
@@ -4725,7 +4733,7 @@ PARALLEL_MAKEINST with the description ".
(PV) as
follows:
- ${WORKDIR}/${PN}-${PV}
+ ${WORKDIR}/${PN}-${PV}
As an example, assume a
Source Directory
@@ -4735,7 +4743,7 @@ PARALLEL_MAKEINST with the description ".
to keep the unpacked recipe for db
is the following:
- ~/poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19
+ ~/poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19
@@ -5232,7 +5240,7 @@ PARALLEL_MAKEINST with the description ".
Source Directory defines PV as
follows:
- PV = "1.5.0+git${SRCPV}"
+ PV = "0.12-git${SRCPV}"
@@ -5843,7 +5851,7 @@ PARALLEL_MAKEINST with the description ".
For packages that are not dependent on a particular machine,
WORKDIR is defined as follows:
- ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}/${PV}-${PR}
+ ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}/${PV}-${PR}
As an example, assume a
Source Directory top-level
@@ -5859,9 +5867,9 @@ PARALLEL_MAKEINST with the description ".
For packages that are dependent on a particular machine, WORKDIR
- is defined slightly different:
+ is defined slightly differently:
- ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}/${PV}-${PR}
+ ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}/${PV}-${PR}
As an example, again assume a Source Directory top-level folder
named poky and a default Build Directory