diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 1d0feb9463..2ac4a0acda 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -309,16 +309,27 @@
ASSUME_SHLIBS
- ASSUME_SHLIBS[doc] = "List of shlib:package[_version] mappings. Useful for lib packages in ASSUME_PROVIDED, for which automatic shlib dependency tracking does not work."
+ ASSUME_SHLIBS[doc] = Provides additional shlibs provider mapping information, which adds to or overwrites the information provided automatically by the system."
- List of shlib:package[_version]
- mappings.
- This variable is useful for library packages in
- ASSUME_PROVIDED,
- for which automatic shlib dependency
- tracking does not work.
+ Provides additional shlibs provider
+ mapping information, which adds to or overwrites the
+ information provided automatically by the system.
+
+
+
+ As an example, use the following form to add an
+ shlib provider of
+ shlibname in
+ packagename with the optional
+ version:
+
+ shlibname:packagename[_version]
+
+
+ Separate multiple entries using spaces.
+
@@ -902,8 +913,12 @@ meta/conf/machine/include//arch-.inc
- The number of log lines the OpenEmbedded build system
- prints upon failure.
+ If
+ BBINCLUDELOGS
+ is set, specifies the maximum number of lines from the
+ task log file to print when reporting a failed task.
+ If you do not set BBINCLUDELOGS_LINES,
+ the entire log is printed.
@@ -1198,6 +1213,9 @@ meta/conf/machine/include//arch-.inc
Specifies the architecture of the build system
(e.g. i686).
+ The uname command, as reported by the
+ machine name, sets the value of
+ BUILD_ARCH.
@@ -1293,7 +1311,12 @@ meta/conf/machine/include//arch-.inc
Specifies the operating system in use on the build
- system (e.g. Linux).
+ host (e.g. Linux).
+ The operating system, as reported by the
+ uname command, sets
+ BUILD_OS.
+ When set, the first word of the value converts to
+ lower-case characters.
@@ -1628,11 +1651,15 @@ meta/conf/machine/include//arch-.inc
CACHE
- CACHE[doc] = "The directory holding the cache of the metadata."
+ CACHE[doc] = "The directory BitBake uses to store a cache of the metadata."
- The directory that contains the cache for the Metadata.
+ Specifies the directory BitBake uses to store a cache
+ of the
+ Metadata
+ so it does not need to be parsed every time BitBake is
+ started.
@@ -2126,6 +2153,12 @@ meta/conf/machine/include//arch-.inc
same as the
TARGET_PREFIX
variable.
+
+ The OpenEmbedded build system sets the
+ CROSS_COMPILE variable only in
+ certain contexts (e.g. when building for kernel
+ and kernel module recipes).
+
@@ -2219,7 +2252,8 @@ meta/conf/machine/include//arch-.inc
The date the build was started.
- Dates appear using the year, month, and day (YMD) format.
+ Dates appear using the year, month, and day (YMD) format
+ (e.g. "20150209" for February 9th and 2015).
@@ -4079,13 +4113,23 @@ meta/conf/machine/include//arch-.inc
Specifies the system, including the architecture and the
operating system, for which the build is occurring
in the context of the current recipe.
- The OpenEmbedded build system automatically sets this
- variable.
- You do not need to set the variable yourself.
- Here are two examples:
+ The OpenEmbedded build system automatically sets this
+ variable based on
+ HOST_ARCH,
+ HOST_VENDOR,
+ and
+ HOST_OS
+ variables.
+
+ You do not need to set the variable yourself.
+
+
+
+
+ Consider these two examples:
Given a native recipe on a 32-bit
x86 machine running Linux, the value is
@@ -7472,12 +7516,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
PACKAGE_INSTALL_ATTEMPTONLY
- PACKAGE_INSTALL_ATTEMPTONLY[doc] = "List of packages attempted to be installed. If a listed package fails to install, the build system does not generate an error. This variable is generally not user-defined."
+ PACKAGE_INSTALL_ATTEMPTONLY[doc] = "List of packages attempted to be installed when creating an image. If a listed package fails to install, the build system does not generate an error. This variable is generally not user-defined."
Specifies a list of packages the OpenEmbedded build
- system attempts to install.
+ system attempts to install when creating an image.
If a listed package fails to install, the build system
does not generate an error.
This variable is generally not user-defined.
@@ -8250,10 +8294,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Indicates the importance of a package.
+
+
+
+ PRIORITY is considered to be part of
+ the distribution policy because the importance of any given
+ recipe depends on the purpose for which the distribution
+ is being produced.
+ Thus, PRIORITY is not normally set
+ within recipes.
+
+
+
You can set PRIORITY to "required",
"standard", "extra", and "optional", which is the default.
--->
@@ -9535,12 +9590,27 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
- Setting this variable within a source mirror generation
- script causes the OpenEmbedded build system to skip
- COMPATIBLE_MACHINE
- and
- COMPATIBLE_HOST
- checks.
+ When you are creating a source mirror, setting
+ SOURCE_MIRROR_FETCH to "1" in your
+ local.conf configuration file ensures
+ the source for all recipes are fetched regardless of
+ whether or not source is marked for exclusion.
+
+ When source files are incompatible with the currently
+ configured
+ MACHINE
+ via the
+ COMPATIBLE_MACHINE
+ variable and via the
+ COMPATIBLE_HOST
+ variable, they are marked for exclusion.
+
+
+ Warning
+ Do not set the
+ SOURCE_MIRROR_FETCH variable
+ during a normal build.
+
@@ -10783,6 +10853,29 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
The toolchain binary prefix for the target tools.
+
+
+ Depending on what you are building your image for, the
+ OpenEmbedded build system sets
+ TARGET_PREFIX as follows:
+
+
+ For targets, which is the default, the build
+ system sets the variable to
+ "${TARGET_SYS}-".
+
+
+ For a native recipe, the build
+ system sets the variable to the value of
+ BUILD_PREFIX.
+
+
+ For a nativesdk recipe, the
+ build system sets the variable to the value of
+ SDK_PREFIX.
+
+
+
@@ -10792,11 +10885,39 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
- The target system, which is comprised of
+ Specifies the system, including the architecture and the
+ operating system, for which the build is occurring in
+ the context of the current recipe.
+
+
+
+ The OpenEmbedded build system automatically sets this
+ variable based on
TARGET_ARCH,
TARGET_VENDOR,
and
- TARGET_OS.
+ TARGET_OS
+ variables.
+
+ You do not need to set the
+ TARGET_SYS variable yourself.
+
+
+
+
+ Consider these two examples:
+
+
+ Given a native recipe on a
+ 32-bit, x86 machine running Linux, the value is
+ "i686-linux".
+
+
+ Given a recipe being built for a little-endian,
+ MIPS target running Linux, the value might be
+ "mipsel-linux".
+
+
@@ -11307,7 +11428,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
The time the build was started.
- Times appear using the hour, minute, and second (HMS) format.
+ Times appear using the hour, minute, and second (HMS)
+ format (e.g. "140159" for one minute and fifty-nine
+ seconds past 1400 hours).