diff --git a/documentation/adt-manual/adt-command.rst b/documentation/adt-manual/adt-command.rst
index 2b81016b68..8b86544f19 100644
--- a/documentation/adt-manual/adt-command.rst
+++ b/documentation/adt-manual/adt-command.rst
@@ -85,7 +85,7 @@ Follow these steps to create a simple Autotools-based project:
7. *Cross-compile the project:* This command compiles the project using
the cross-compiler. The
- ```CONFIGURE_FLAGS`` <&YOCTO_DOCS_REF_URL;#var-CONFIGURE_FLAGS>`__
+ :term:`CONFIGURE_FLAGS`
environment variable provides the minimal arguments for GNU
configure: $ ./configure ${CONFIGURE_FLAGS}
@@ -146,13 +146,13 @@ subject to general ``make`` rules.
To illustrate this, consider the following four cross-toolchain
environment variables:
-`CC <&YOCTO_DOCS_REF_URL;#var-CC>`__\ =i586-poky-linux-gcc -m32
+:term:`CC`\ =i586-poky-linux-gcc -m32
-march=i586 --sysroot=/opt/poky/1.8/sysroots/i586-poky-linux
-`LD <&YOCTO_DOCS_REF_URL;#var-LD>`__\ =i586-poky-linux-ld
+:term:`LD`\ =i586-poky-linux-ld
--sysroot=/opt/poky/1.8/sysroots/i586-poky-linux
-`CFLAGS <&YOCTO_DOCS_REF_URL;#var-CFLAGS>`__\ =-O2 -pipe -g
+:term:`CFLAGS`\ =-O2 -pipe -g
-feliminate-unused-debug-types
-`CXXFLAGS <&YOCTO_DOCS_REF_URL;#var-CXXFLAGS>`__\ =-O2 -pipe -g
+:term:`CXXFLAGS`\ =-O2 -pipe -g
-feliminate-unused-debug-types Now, consider the following three cases:
- *Case 1 - No Variables Set in the ``Makefile``:* Because these
diff --git a/documentation/adt-manual/adt-package.rst b/documentation/adt-manual/adt-package.rst
index cea535072d..38823a104f 100644
--- a/documentation/adt-manual/adt-package.rst
+++ b/documentation/adt-manual/adt-package.rst
@@ -38,7 +38,7 @@ Configuring the PMS
===================
Whichever PMS you are using, you need to be sure that the
-```PACKAGE_CLASSES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES>`__
+:term:`PACKAGE_CLASSES`
variable in the ``conf/local.conf`` file is set to reflect that system.
The first value you choose for the variable specifies the package file
format for the root filesystem at sysroot. Additional values specify
diff --git a/documentation/adt-manual/adt-prepare.rst b/documentation/adt-manual/adt-prepare.rst
index eea12ec0c8..12b1e7918c 100644
--- a/documentation/adt-manual/adt-prepare.rst
+++ b/documentation/adt-manual/adt-prepare.rst
@@ -284,7 +284,7 @@ Follow these steps to generate the toolchain into the Build Directory:
Directory <&YOCTO_DOCS_DEV_URL;#source-directory>`__.
2. *Check your Local Configuration File:* At this point, you should be
- sure that the ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__
+ sure that the :term:`MACHINE`
variable in the ``local.conf`` file found in the ``conf`` directory
of the Build Directory is set for the target architecture. Comments
within the ``local.conf`` file list the values you can use for the
@@ -345,45 +345,45 @@ setup script for a 64-bit IA-based architecture installed in the default
installation directory would be the following:
YOCTO_ADTPATH_DIR/environment-setup-x86_64-poky-linux When you run the
setup script, many environment variables are defined:
-```SDKTARGETSYSROOT`` <&YOCTO_DOCS_REF_URL;#var-SDKTARGETSYSROOT>`__ -
+:term:`SDKTARGETSYSROOT` -
The path to the sysroot used for cross-compilation
-```PKG_CONFIG_PATH`` <&YOCTO_DOCS_REF_URL;#var-PKG_CONFIG_PATH>`__ - The
+:term:`PKG_CONFIG_PATH` - The
path to the target pkg-config files
-```CONFIG_SITE`` <&YOCTO_DOCS_REF_URL;#var-CONFIG_SITE>`__ - A GNU
+:term:`CONFIG_SITE` - A GNU
autoconf site file preconfigured for the target
-```CC`` <&YOCTO_DOCS_REF_URL;#var-CC>`__ - The minimal command and
+:term:`CC` - The minimal command and
arguments to run the C compiler
-```CXX`` <&YOCTO_DOCS_REF_URL;#var-CXX>`__ - The minimal command and
+:term:`CXX` - The minimal command and
arguments to run the C++ compiler
-```CPP`` <&YOCTO_DOCS_REF_URL;#var-CPP>`__ - The minimal command and
+:term:`CPP` - The minimal command and
arguments to run the C preprocessor
-```AS`` <&YOCTO_DOCS_REF_URL;#var-AS>`__ - The minimal command and
-arguments to run the assembler ```LD`` <&YOCTO_DOCS_REF_URL;#var-LD>`__
+:term:`AS` - The minimal command and
+arguments to run the assembler :term:`LD`
- The minimal command and arguments to run the linker
-```GDB`` <&YOCTO_DOCS_REF_URL;#var-GDB>`__ - The minimal command and
+:term:`GDB` - The minimal command and
arguments to run the GNU Debugger
-```STRIP`` <&YOCTO_DOCS_REF_URL;#var-STRIP>`__ - The minimal command and
+:term:`STRIP` - The minimal command and
arguments to run 'strip', which strips symbols
-```RANLIB`` <&YOCTO_DOCS_REF_URL;#var-RANLIB>`__ - The minimal command
+:term:`RANLIB` - The minimal command
and arguments to run 'ranlib'
-```OBJCOPY`` <&YOCTO_DOCS_REF_URL;#var-OBJCOPY>`__ - The minimal command
+:term:`OBJCOPY` - The minimal command
and arguments to run 'objcopy'
-```OBJDUMP`` <&YOCTO_DOCS_REF_URL;#var-OBJDUMP>`__ - The minimal command
-and arguments to run 'objdump' ```AR`` <&YOCTO_DOCS_REF_URL;#var-AR>`__
+:term:`OBJDUMP` - The minimal command
+and arguments to run 'objdump' :term:`AR`
- The minimal command and arguments to run 'ar'
-```NM`` <&YOCTO_DOCS_REF_URL;#var-NM>`__ - The minimal command and
+:term:`NM` - The minimal command and
arguments to run 'nm'
-```TARGET_PREFIX`` <&YOCTO_DOCS_REF_URL;#var-TARGET_PREFIX>`__ - The
+:term:`TARGET_PREFIX` - The
toolchain binary prefix for the target tools
-```CROSS_COMPILE`` <&YOCTO_DOCS_REF_URL;#var-CROSS_COMPILE>`__ - The
+:term:`CROSS_COMPILE` - The
toolchain binary prefix for the target tools
-```CONFIGURE_FLAGS`` <&YOCTO_DOCS_REF_URL;#var-CONFIGURE_FLAGS>`__ - The
+:term:`CONFIGURE_FLAGS` - The
minimal arguments for GNU configure
-```CFLAGS`` <&YOCTO_DOCS_REF_URL;#var-CFLAGS>`__ - Suggested C flags
-```CXXFLAGS`` <&YOCTO_DOCS_REF_URL;#var-CXXFLAGS>`__ - Suggested C++
-flags ```LDFLAGS`` <&YOCTO_DOCS_REF_URL;#var-LDFLAGS>`__ - Suggested
+:term:`CFLAGS` - Suggested C flags
+:term:`CXXFLAGS` - Suggested C++
+flags :term:`LDFLAGS` - Suggested
linker flags when you use CC to link
-```CPPFLAGS`` <&YOCTO_DOCS_REF_URL;#var-CPPFLAGS>`__ - Suggested
+:term:`CPPFLAGS` - Suggested
preprocessor flags
Securing Kernel and Filesystem Images
@@ -411,7 +411,7 @@ that you can use unaltered in the QEMU emulator. These kernel images
reside in the release area - ` <&YOCTO_MACHINES_DL_URL;>`__ and are
ideal for experimentation using Yocto Project. For information on the
image types you can build using the OpenEmbedded build system, see the
-"`Images <&YOCTO_DOCS_REF_URL;#ref-images>`__" chapter in the Yocto
+":ref:`ref-manual/ref-images:Images`" chapter in the Yocto
Project Reference Manual.
If you are planning on developing against your image and you are not
@@ -434,7 +434,7 @@ this by including the ``eclipse-debug`` image feature.
To include the ``eclipse-debug`` image feature, modify your
``local.conf`` file in the `Build
Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__ so that the
-```EXTRA_IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES>`__
+:term:`EXTRA_IMAGE_FEATURES`
variable includes the "eclipse-debug" feature. After modifying the
configuration file, you can rebuild the image. Once the image is
rebuilt, the ``tcf-agent`` will be included in the image and is launched
@@ -513,8 +513,8 @@ Another feature is that only one set of cross-canadian toolchain
binaries are produced per architecture. This feature takes advantage of
the fact that the target hardware can be passed to ``gcc`` as a set of
compiler options. Those options are set up by the environment script and
-contained in variables such as ```CC`` <&YOCTO_DOCS_REF_URL;#var-CC>`__
-and ```LD`` <&YOCTO_DOCS_REF_URL;#var-LD>`__. This reduces the space
+contained in variables such as :term:`CC`
+and :term:`LD`. This reduces the space
needed for the tools. Understand, however, that a sysroot is still
needed for every target since those binaries are target-specific.
@@ -524,9 +524,9 @@ environment setup script (i.e.
```oe-init-build-env-memres`` <&YOCTO_DOCS_REF_URL;#structure-memres-core-script>`__)
located in the Source Directory and you must make sure your
``conf/local.conf`` variables are correct. In particular, you need to be
-sure the ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ variable
+sure the :term:`MACHINE` variable
matches the architecture for which you are building and that the
-```SDKMACHINE`` <&YOCTO_DOCS_REF_URL;#var-SDKMACHINE>`__ variable is
+:term:`SDKMACHINE` variable is
correctly set if you are building a toolchain designed to run on an
architecture that differs from your current development host machine
(i.e. the build machine).
@@ -565,10 +565,10 @@ follows:
- Make sure you add the layer that contains the toolchain to your
``bblayers.conf`` file through the
- ```BBLAYERS`` <&YOCTO_DOCS_REF_URL;#var-BBLAYERS>`__ variable.
+ :term:`BBLAYERS` variable.
- Set the
- ```EXTERNAL_TOOLCHAIN`` <&YOCTO_DOCS_REF_URL;#var-EXTERNAL_TOOLCHAIN>`__
+ :term:`EXTERNAL_TOOLCHAIN`
variable in your ``local.conf`` file to the location in which you
installed the toolchain.
@@ -577,7 +577,7 @@ Mentor Graphics Sourcery G++ Toolchain. You can see information on how
to use that particular layer in the ``README`` file at
` `__. You can find
further information by reading about the
-```TCMODE`` <&YOCTO_DOCS_REF_URL;#var-TCMODE>`__ variable in the Yocto
+:term:`TCMODE` variable in the Yocto
Project Reference Manual's variable glossary.
.. _using-pre-built:
@@ -712,7 +712,7 @@ core-image-profile-qemuarch.ext3 core-image-profile-qemuarch.tar.bz2
Where: profile is the filesystem image's profile: lsb, lsb-dev, lsb-sdk,
lsb-qt3, minimal, minimal-dev, sato, sato-dev, or sato-sdk. For
information on these types of image profiles, see the
-"`Images <&YOCTO_DOCS_REF_URL;#ref-images>`__" chapter in the Yocto
+":ref:`ref-manual/ref-images:Images`" chapter in the Yocto
Project Reference Manual. arch is a string representing the target
architecture: x86, x86-64, ppc, mips, or arm.
diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
index f80ec305ab..712d5c7f8e 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
+++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
@@ -257,7 +257,7 @@ Follow these steps to add a hardware layer:
support hardware from Altera, which is owned by Intel.
3. *Change the Configuration to Build for a Specific Machine:* The
- ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ variable in the
+ :term:`MACHINE` variable in the
``local.conf`` file specifies the machine for the build. For this
example, set the ``MACHINE`` variable to "cyclone5". These
configurations are used:
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 42c8190124..4517604a2a 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -73,7 +73,7 @@ section in the Yocto Project Development Tasks Manual.
The BSP layer's base directory (``meta-bsp_root_name``) is the root
directory of that Layer. This directory is what you add to the
-```BBLAYERS`` <&YOCTO_DOCS_REF_URL;#var-BBLAYERS>`__ variable in the
+:term:`BBLAYERS` variable in the
``conf/bblayers.conf`` file found in your `Build
Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__, which is
established after you run the OpenEmbedded build environment setup
@@ -466,7 +466,7 @@ This file provides information on where to locate the BSP source files
used to build the images (if any) that reside in
``meta-bsp_root_name/binary``. Images in the ``binary`` would be images
released with the BSP. The information in the ``README.sources`` file
-also helps you find the `Metadata <&YOCTO_DOCS_REF_URL;#metadata>`__
+also helps you find the :term:`Metadata`
used to generate the images that ship with the BSP.
.. note::
@@ -532,7 +532,7 @@ BBFILE_PATTERN_raspberrypi := "^${LAYERDIR}/"
BBFILE_PRIORITY_raspberrypi = "9" # Additional license directories.
LICENSE_PATH += "${LAYERDIR}/files/custom-licenses" . . .
-This file simply makes `BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__
+This file simply makes :term:`BitBake`
aware of the recipes and configuration directories. The file must exist
so that the OpenEmbedded build system can recognize the BSP.
@@ -549,10 +549,10 @@ in the BSP into a format that the build system can understand. Each BSP
Layer requires at least one machine file. If the BSP supports multiple
machines, multiple machine configuration files can exist. These
filenames correspond to the values to which users have set the
-```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ variable.
+:term:`MACHINE` variable.
These files define things such as the kernel package to use
-(```PREFERRED_PROVIDER`` <&YOCTO_DOCS_REF_URL;#var-PREFERRED_PROVIDER>`__
+(:term:`PREFERRED_PROVIDER`
of
`virtual/kernel <&YOCTO_DOCS_DEV_URL;#metadata-virtual-providers>`__),
the hardware drivers to include in different types of images, any
@@ -565,7 +565,7 @@ optimization flags, which are carefully chosen to give best performance
on a given processor.
Tuning files are found in the ``meta/conf/machine/include`` directory
-within the `Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__.
+within the :term:`Source Directory`.
For example, many ``tune-*`` files (e.g. ``tune-arm1136jf-s.inc``,
``tune-1586-nlp.inc``, and so forth) reside in the
``poky/meta/conf/machine/include`` directory.
@@ -599,7 +599,7 @@ DISPLAY_ORIENTATION=0 DISPLAY_DPI=133
according to the formfactor configuration file that is installed by
the main formfactor recipe
``meta/recipes-bsp/formfactor/formfactor_0.0.bb``, which is found in
- the `Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__.
+ the :term:`Source Directory`.
.. _bsp-filelayout-recipes-graphics:
@@ -639,9 +639,9 @@ located in the BSP Layer for your target device (e.g. the
Suppose you are using the ``linux-yocto_4.4.bb`` recipe to build the
kernel. In other words, you have selected the kernel in your
bsp_root_name\ ``.conf`` file by adding
-```PREFERRED_PROVIDER`` <&YOCTO_DOCS_REF_URL;#var-PREFERRED_PROVIDER>`__
+:term:`PREFERRED_PROVIDER`
and
-```PREFERRED_VERSION`` <&YOCTO_DOCS_REF_URL;#var-PREFERRED_VERSION>`__
+:term:`PREFERRED_VERSION`
statements as follows: PREFERRED_PROVIDER_virtual/kernel ?=
"linux-yocto" PREFERRED_VERSION_linux-yocto ?= "4.4%"
@@ -796,7 +796,7 @@ workflow.
The build process supports several types of images to satisfy
different needs. See the
- "`Images <&YOCTO_DOCS_REF_URL;#ref-images>`__" chapter in the Yocto
+ ":ref:`ref-manual/ref-images:Images`" chapter in the Yocto
Project Reference Manual for information on supported images.
Requirements and Recommendations for Released BSPs
@@ -1038,7 +1038,7 @@ also supports several other machines:
The
- ```FILESEXTRAPATHS`` <&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS>`__
+ :term:`FILESEXTRAPATHS`
variable in the append files extends the search path the build system
uses to find files during the build. Consequently, for this example
you need to have the ``files`` directory in the same location as your
@@ -1090,11 +1090,11 @@ satisfy the licensing requirements for an encumbered BSP. The following
list describes them in order of preference:
1. *Use
- the*\ ```LICENSE_FLAGS`` <&YOCTO_DOCS_REF_URL;#var-LICENSE_FLAGS>`__\ *Variable
+ the*\ :term:`LICENSE_FLAGS`\ *Variable
to Define the Recipes that Have Commercial or Other Types of
Specially-Licensed Packages:* For each of those recipes, you can
specify a matching license string in a ``local.conf`` variable named
- ```LICENSE_FLAGS_WHITELIST`` <&YOCTO_DOCS_REF_URL;#var-LICENSE_FLAGS_WHITELIST>`__.
+ :term:`LICENSE_FLAGS_WHITELIST`.
Specifying the matching license string signifies that you agree to
the license. Thus, the build system can build the corresponding
recipe and include the component in the image. See the "`Enabling
@@ -1266,12 +1266,12 @@ Project Reference Manual.
"virtual/xserver" is "xserver-xorg", which exists in
``poky/meta/recipes-graphics/xorg-xserver``.
-- ```XSERVER`` <&YOCTO_DOCS_REF_URL;#var-XSERVER>`__: The packages that
+- :term:`XSERVER`: The packages that
should be installed to provide an X server and drivers for the
machine. In this example, the "xserver-xorg" and
"xf86-video-modesetting" are installed.
-- ```MACHINE_EXTRA_RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_EXTRA_RRECOMMENDS>`__:
+- :term:`MACHINE_EXTRA_RRECOMMENDS`:
A list of machine-dependent packages not essential for booting the
image. Thus, the build does not fail if the packages do not exist.
However, the packages are required for a fully-featured image.
@@ -1283,14 +1283,14 @@ Project Reference Manual.
variables exist that help you configure a particular piece of
hardware.
-- ```EXTRA_IMAGEDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGEDEPENDS>`__:
+- :term:`EXTRA_IMAGEDEPENDS`:
Recipes to build that do not provide packages for installing into the
root filesystem but building the image depends on the recipes.
Sometimes a recipe is required to build the final image but is not
needed in the root filesystem. In this case, the U-Boot recipe must
be built for the image.
-- ```DEFAULTTUNE`` <&YOCTO_DOCS_REF_URL;#var-DEFAULTTUNE>`__: Machines
+- :term:`DEFAULTTUNE`: Machines
use tunings to optimize machine, CPU, and application performance.
These features, which are collectively known as "tuning features",
exist in the `OpenEmbedded-Core
@@ -1306,31 +1306,31 @@ Project Reference Manual.
conf/machine/include/tune-cortexa8.inc
file provides many tuning possibilities.
-- ```IMAGE_FSTYPES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES>`__: The
+- :term:`IMAGE_FSTYPES`: The
formats the OpenEmbedded build system uses during the build when
creating the root filesystem. In this example, four types of images
are supported.
-- ```EXTRA_IMAGECMD`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGECMD>`__:
+- :term:`EXTRA_IMAGECMD`:
Specifies additional options for image creation commands. In this
example, the "-lnp " option is used when creating the
`JFFS2 `__ image.
-- ```WKS_FILE`` <&YOCTO_DOCS_REF_URL;#var-WKS_FILE>`__: The location of
+- :term:`WKS_FILE`: The location of
the `Wic kickstart <&YOCTO_DOCS_REF_URL;#ref-kickstart>`__ file used
by the OpenEmbedded build system to create a partitioned image
(image.wic).
-- ```IMAGE_INSTALL`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL>`__:
+- :term:`IMAGE_INSTALL`:
Specifies packages to install into an image through the
- ```image`` <&YOCTO_DOCS_REF_URL;#ref-classes-image>`__ class. Recipes
+ :ref:`image ` class. Recipes
use the ``IMAGE_INSTALL`` variable.
- ``do_image_wic[depends]``: A task that is constructed during the
build. In this example, the task depends on specific tools in order
to create the sysroot when buiding a Wic image.
-- ```SERIAL_CONSOLES`` <&YOCTO_DOCS_REF_URL;#var-SERIAL_CONSOLES>`__:
+- :term:`SERIAL_CONSOLES`:
Defines a serial console (TTY) to enable using getty. In this case,
the baud rate is "115200" and the device name is "ttyO0".
@@ -1344,21 +1344,21 @@ Project Reference Manual.
Defines the version of the recipe used to build the kernel, which is
"5.0" in this case.
-- ```KERNEL_IMAGETYPE`` <&YOCTO_DOCS_REF_URL;#var-KERNEL_IMAGETYPE>`__:
+- :term:`KERNEL_IMAGETYPE`:
The type of kernel to build for the device. In this case, the
OpenEmbedded build system creates a "zImage" image type.
-- ```KERNEL_DEVICETREE`` <&YOCTO_DOCS_REF_URL;#var-KERNEL_DEVICETREE>`__:
+- :term:`KERNEL_DEVICETREE`:
The names of the generated Linux kernel device trees (i.e. the
``*.dtb``) files. All the device trees for the various BeagleBone
devices are included.
-- ```KERNEL_EXTRA_ARGS`` <&YOCTO_DOCS_REF_URL;#var-KERNEL_EXTRA_ARGS>`__:
+- :term:`KERNEL_EXTRA_ARGS`:
Additional ``make`` command-line arguments the OpenEmbedded build
system passes on when compiling the kernel. In this example,
"LOADADDR=${UBOOT_ENTRYPOINT}" is passed as a command-line argument.
-- ```SPL_BINARY`` <&YOCTO_DOCS_REF_URL;#var-SPL_BINARY>`__: Defines the
+- :term:`SPL_BINARY`: Defines the
Secondary Program Loader (SPL) binary type. In this case, the SPL
binary is set to "MLO", which stands for Multimedia card LOader.
@@ -1377,25 +1377,25 @@ Project Reference Manual.
example, a U-Boot image is required to boot the BeagleBone device.
See the following variables for more information:
- - ```UBOOT_SUFFIX`` <&YOCTO_DOCS_REF_URL;#var-UBOOT_SUFFIX>`__:
+ - :term:`UBOOT_SUFFIX`:
Points to the generated U-Boot extension.
- - ```UBOOT_MACHINE`` <&YOCTO_DOCS_REF_URL;#var-UBOOT_MACHINE>`__:
+ - :term:`UBOOT_MACHINE`:
Specifies the value passed on the make command line when building
a U-Boot image.
- - ```UBOOT_ENTRYPOINT`` <&YOCTO_DOCS_REF_URL;#var-UBOOT_ENTRYPOINT>`__:
+ - :term:`UBOOT_ENTRYPOINT`:
Specifies the entry point for the U-Boot image.
- - ```UBOOT_LOADADDRESS`` <&YOCTO_DOCS_REF_URL;#var-UBOOT_LOADADDRESS>`__:
+ - :term:`UBOOT_LOADADDRESS`:
Specifies the load address for the U-Boot image.
-- ```MACHINE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_FEATURES>`__:
+- :term:`MACHINE_FEATURES`:
Specifies the list of hardware features the BeagleBone device is
capable of supporting. In this case, the device supports "usbgadget
usbhost vfat alsa".
-- ```IMAGE_BOOT_FILES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_BOOT_FILES>`__:
+- :term:`IMAGE_BOOT_FILES`:
Files installed into the device's boot partition when preparing the
image using the Wic tool with the ``bootimg-partition`` or
``bootimg-efi`` source plugin.
@@ -1435,21 +1435,21 @@ appended with the "beaglebone-yocto" string. The OpenEmbedded build
system uses these statements to override similar statements in the
kernel recipe:
-- ```KBRANCH`` <&YOCTO_DOCS_REF_URL;#var-KBRANCH>`__: Identifies the
+- :term:`KBRANCH`: Identifies the
kernel branch that is validated, patched, and configured during the
build.
-- ```KMACHINE`` <&YOCTO_DOCS_REF_URL;#var-KMACHINE>`__: Identifies the
+- :term:`KMACHINE`: Identifies the
machine name as known by the kernel, which is sometimes a different
name than what is known by the OpenEmbedded build system.
-- ```SRCREV`` <&YOCTO_DOCS_REF_URL;#var-SRCREV>`__: Identifies the
+- :term:`SRCREV`: Identifies the
revision of the source code used to build the image.
-- ```COMPATIBLE_MACHINE`` <&YOCTO_DOCS_REF_URL;#var-COMPATIBLE_MACHINE>`__:
+- :term:`COMPATIBLE_MACHINE`:
A regular expression that resolves to one or more target machines
with which the recipe is compatible.
-- ```LINUX_VERSION`` <&YOCTO_DOCS_REF_URL;#var-LINUX_VERSION>`__: The
+- :term:`LINUX_VERSION`: The
Linux version from kernel.org used by the OpenEmbedded build system
to build the kernel image.
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
index 133a3dd31c..ae26172f6c 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -14,7 +14,7 @@ Understanding and Creating Layers
=================================
The OpenEmbedded build system supports organizing
-`Metadata <&YOCTO_DOCS_REF_URL;#metadata>`__ into multiple layers.
+:term:`Metadata` into multiple layers.
Layers allow you to isolate different types of customizations from each
other. For introductory information on the Yocto Project Layer Model,
see the "`The Yocto Project Layer
@@ -81,7 +81,7 @@ Follow these general steps to create your layer without using tools:
= "4" LAYERSERIES_COMPAT_yoctobsp = "DISTRO_NAME_NO_CAP" Following is
an explanation of the layer configuration file:
- - ```BBPATH`` <&YOCTO_DOCS_REF_URL;#var-BBPATH>`__: Adds the layer's
+ - :term:`BBPATH`: Adds the layer's
root directory to BitBake's search path. Through the use of the
``BBPATH`` variable, BitBake locates class files (``.bbclass``),
configuration files, and files that are included with ``include``
@@ -91,35 +91,35 @@ Follow these general steps to create your layer without using tools:
is recommended, therefore, that you use unique class and
configuration filenames in your custom layer.
- - ```BBFILES`` <&YOCTO_DOCS_REF_URL;#var-BBFILES>`__: Defines the
+ - :term:`BBFILES`: Defines the
location for all recipes in the layer.
- - ```BBFILE_COLLECTIONS`` <&YOCTO_DOCS_REF_URL;#var-BBFILE_COLLECTIONS>`__:
+ - :term:`BBFILE_COLLECTIONS`:
Establishes the current layer through a unique identifier that is
used throughout the OpenEmbedded build system to refer to the
layer. In this example, the identifier "yoctobsp" is the
representation for the container layer named "meta-yocto-bsp".
- - ```BBFILE_PATTERN`` <&YOCTO_DOCS_REF_URL;#var-BBFILE_PATTERN>`__:
+ - :term:`BBFILE_PATTERN`:
Expands immediately during parsing to provide the directory of the
layer.
- - ```BBFILE_PRIORITY`` <&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY>`__:
+ - :term:`BBFILE_PRIORITY`:
Establishes a priority to use for recipes in the layer when the
OpenEmbedded build finds recipes of the same name in different
layers.
- - ```LAYERVERSION`` <&YOCTO_DOCS_REF_URL;#var-LAYERVERSION>`__:
+ - :term:`LAYERVERSION`:
Establishes a version number for the layer. You can use this
version number to specify this exact version of the layer as a
dependency when using the
- ```LAYERDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-LAYERDEPENDS>`__
+ :term:`LAYERDEPENDS`
variable.
- - ```LAYERDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-LAYERDEPENDS>`__:
+ - :term:`LAYERDEPENDS`:
Lists all layers on which this layer depends (if any).
- - ```LAYERSERIES_COMPAT`` <&YOCTO_DOCS_REF_URL;#var-LAYERSERIES_COMPAT>`__:
+ - :term:`LAYERSERIES_COMPAT`:
Lists the `Yocto Project <&YOCTO_WIKI_URL;/wiki/Releases>`__
releases for which the current version is compatible. This
variable is a good way to indicate if your particular layer is
@@ -184,7 +184,7 @@ following list:
have a layer named ``meta-one`` that adds support for building
machine "one". To do so, you use an append file named
``base-files.bbappend`` and create a dependency on "foo" by
- altering the ```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__
+ altering the :term:`DEPENDS`
variable: DEPENDS = "foo" The dependency is created during any
build that includes the layer ``meta-one``. However, you might not
want this dependency for all machines. For example, suppose you
@@ -221,13 +221,13 @@ following list:
- *Place Machine-Specific Files in Machine-Specific Locations:* When
you have a base recipe, such as ``base-files.bb``, that contains a
- ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ statement to a
+ :term:`SRC_URI` statement to a
file, you can use an append file to cause the build to use your
own version of the file. For example, an append file in your layer
at ``meta-one/recipes-core/base-files/base-files.bbappend`` could
- extend ```FILESPATH`` <&YOCTO_DOCS_REF_URL;#var-FILESPATH>`__
+ extend :term:`FILESPATH`
using
- ```FILESEXTRAPATHS`` <&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS>`__
+ :term:`FILESEXTRAPATHS`
as follows: FILESEXTRAPATHS_prepend := "${THISDIR}/${BPN}:" The
build for machine "one" will pick up your machine-specific file as
long as you have the file in
@@ -401,7 +401,7 @@ Enabling Your Layer
Before the OpenEmbedded build system can use your new layer, you need to
enable it. To enable your layer, simply add your layer's path to the
``BBLAYERS`` variable in your ``conf/bblayers.conf`` file, which is
-found in the `Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__.
+found in the :term:`Build Directory`.
The following example shows how to enable a layer named
``meta-mylayer``: # POKY_BBLAYERS_CONF_VERSION is increased each time
build/conf/bblayers.conf # changes incompatibly
@@ -445,7 +445,7 @@ newer version, you must also rename and possibly update the
corresponding ``.bbappend`` as well. During the build process, BitBake
displays an error on starting if it detects a ``.bbappend`` file that
does not have a corresponding recipe with a matching name. See the
-```BB_DANGLINGAPPENDS_WARNONLY`` <&YOCTO_DOCS_REF_URL;#var-BB_DANGLINGAPPENDS_WARNONLY>`__
+:term:`BB_DANGLINGAPPENDS_WARNONLY`
variable for information on how to handle this error.
As an example, consider the main formfactor recipe and a corresponding
@@ -462,7 +462,7 @@ PACKAGE_ARCH = "${MACHINE_ARCH}" INHIBIT_DEFAULT_DEPS = "1" do_install()
${D}${sysconfdir}/formfactor/ install -m 0644 ${S}/config
${D}${sysconfdir}/formfactor/ if [ -s "${S}/machconfig" ]; then install
-m 0644 ${S}/machconfig ${D}${sysconfdir}/formfactor/ fi } In the main
-recipe, note the ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__
+recipe, note the :term:`SRC_URI`
variable, which tells the OpenEmbedded build system where to find files
during the build.
@@ -472,15 +472,15 @@ file is in the layer at ``recipes-bsp/formfactor``:
FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
By default, the build system uses the
-```FILESPATH`` <&YOCTO_DOCS_REF_URL;#var-FILESPATH>`__ variable to
+:term:`FILESPATH` variable to
locate files. This append file extends the locations by setting the
-```FILESEXTRAPATHS`` <&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS>`__
+:term:`FILESEXTRAPATHS`
variable. Setting this variable in the ``.bbappend`` file is the most
reliable and recommended method for adding directories to the search
path used by the build system to find files.
The statement in this example extends the directories to include
-``${``\ ```THISDIR`` <&YOCTO_DOCS_REF_URL;#var-THISDIR>`__\ ``}/${``\ ```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__\ ``}``,
+``${``\ :term:`THISDIR`\ ``}/${``\ :term:`PN`\ ``}``,
which resolves to a directory named ``formfactor`` in the same directory
in which the append file resides (i.e.
``meta-raspberrypi/recipes-bsp/formfactor``. This implies that you must
@@ -514,13 +514,13 @@ applied. You can either specify the priority manually, or allow the
build system to calculate it based on the layer's dependencies.
To specify the layer's priority manually, use the
-```BBFILE_PRIORITY`` <&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY>`__
+:term:`BBFILE_PRIORITY`
variable and append the layer's root name: BBFILE_PRIORITY_mylayer = "1"
.. note::
It is possible for a recipe with a lower version number
- ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__ in a layer that has a higher
+ :term:`PV` in a layer that has a higher
priority to take precedence.
Also, the layer priority does not currently affect the precedence
@@ -665,7 +665,7 @@ meta-scottrif'
If you want to set the priority of the layer to other than the default
value of "6", you can either use the ``DASHDASHpriority`` option or you
can edit the
-```BBFILE_PRIORITY`` <&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY>`__ value
+:term:`BBFILE_PRIORITY` value
in the ``conf/layer.conf`` after the script creates it. Furthermore, if
you want to give the example recipe file some name other than the
default, you can use the ``DASHDASHexample-recipe-name`` option.
@@ -764,8 +764,8 @@ Customizing Images Using Custom ``IMAGE_FEATURES`` and ``EXTRA_IMAGE_FEATURES``
Another method for customizing your image is to enable or disable
high-level image features by using the
-```IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES>`__ and
-```EXTRA_IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES>`__
+:term:`IMAGE_FEATURES` and
+:term:`EXTRA_IMAGE_FEATURES`
variables. Although the functions for both variables are nearly
equivalent, best practices dictate using ``IMAGE_FEATURES`` from within
a recipe and using ``EXTRA_IMAGE_FEATURES`` from within your
@@ -782,7 +782,7 @@ In summary, the file looks at the contents of the ``IMAGE_FEATURES``
variable and then maps or configures the feature accordingly. Based on
this information, the build system automatically adds the appropriate
packages or configurations to the
-```IMAGE_INSTALL`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL>`__ variable.
+:term:`IMAGE_INSTALL` variable.
Effectively, you are enabling extra features by extending the class or
creating a custom class for use with specialized image ``.bb`` files.
@@ -893,7 +893,7 @@ Customizing an Image Hostname
By default, the configured hostname (i.e. ``/etc/hostname``) in an image
is the same as the machine name. For example, if
-```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ equals "qemux86", the
+:term:`MACHINE` equals "qemux86", the
configured hostname written to ``/etc/hostname`` is "qemux86".
You can customize this name by altering the value of the "hostname"
@@ -1072,7 +1072,7 @@ the recipe.
- *Storing Your Recipe:* The OpenEmbedded build system locates your
recipe through the layer's ``conf/layer.conf`` file and the
- ```BBFILES`` <&YOCTO_DOCS_REF_URL;#var-BBFILES>`__ variable. This
+ :term:`BBFILES` variable. This
variable sets up a path from which the build system can locate
recipes. Here is the typical use: BBFILES +=
"${LAYERDIR}/recipes-*/*/*.bb \\ ${LAYERDIR}/recipes-*/*/*.bbappend"
@@ -1101,14 +1101,14 @@ progressively discover and add information to the recipe file.
Assuming you have sourced the build environment setup script (i.e.
````` <&YOCTO_DOCS_REF_URL;#structure-core-script>`__) and you are in
-the `Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__, use
+the :term:`Build Directory`, use
BitBake to process your recipe. All you need to provide is the
``basename`` of the recipe as described in the previous section: $
bitbake basename
During the build, the OpenEmbedded build system creates a temporary work
directory for each recipe
-(``${``\ ```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__\ ``}``)
+(``${``\ :term:`WORKDIR`\ ``}``)
where it keeps extracted source files, log files, intermediate
compilation and packaging files, and so forth.
@@ -1154,26 +1154,26 @@ Fetching Code
The first thing your recipe must do is specify how to fetch the source
files. Fetching is controlled mainly through the
-```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ variable. Your recipe
+:term:`SRC_URI` variable. Your recipe
must have a ``SRC_URI`` variable that points to where the source is
located. For a graphical representation of source locations, see the
"`Sources <&YOCTO_DOCS_OM_URL;#sources-dev-environment>`__" section in
the Yocto Project Overview and Concepts Manual.
-The ```do_fetch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-fetch>`__ task uses
+The :ref:`ref-tasks-fetch` task uses
the prefix of each entry in the ``SRC_URI`` variable value to determine
which `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ to use to get your
source files. It is the ``SRC_URI`` variable that triggers the fetcher.
-The ```do_patch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-patch>`__ task uses
+The :ref:`ref-tasks-patch` task uses
the variable after source is fetched to apply patches. The OpenEmbedded
build system uses
-```FILESOVERRIDES`` <&YOCTO_DOCS_REF_URL;#var-FILESOVERRIDES>`__ for
+:term:`FILESOVERRIDES` for
scanning directory locations for local files in ``SRC_URI``.
The ``SRC_URI`` variable in your recipe must define each unique location
for your source files. It is good practice to not hard-code version
numbers in a URL used in ``SRC_URI``. Rather than hard-code these
-values, use ``${``\ ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__\ ``}``,
+values, use ``${``\ :term:`PV`\ ``}``,
which causes the fetch process to use the version specified in the
recipe filename. Specifying the version in this manner means that
upgrading the recipe to a future version is as simple as renaming the
@@ -1182,20 +1182,20 @@ recipe to match the new version.
Here is a simple example from the
``meta/recipes-devtools/strace/strace_5.5.bb`` recipe where the source
comes from a single tarball. Notice the use of the
-```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__ variable: SRC_URI =
+:term:`PV` variable: SRC_URI =
"https://strace.io/files/${PV}/strace-${PV}.tar.xz \\
Files mentioned in ``SRC_URI`` whose names end in a typical archive
extension (e.g. ``.tar``, ``.tar.gz``, ``.tar.bz2``, ``.zip``, and so
forth), are automatically extracted during the
-```do_unpack`` <&YOCTO_DOCS_REF_URL;#ref-tasks-unpack>`__ task. For
+:ref:`ref-tasks-unpack` task. For
another example that specifies these types of files, see the
"`Autotooled Package <#new-recipe-autotooled-package>`__" section.
Another way of specifying source is from an SCM. For Git repositories,
-you must specify ```SRCREV`` <&YOCTO_DOCS_REF_URL;#var-SRCREV>`__ and
-you should specify ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__ to include
-the revision with ```SRCPV`` <&YOCTO_DOCS_REF_URL;#var-SRCPV>`__. Here
+you must specify :term:`SRCREV` and
+you should specify :term:`PV` to include
+the revision with :term:`SRCPV`. Here
is an example from the recipe
``meta/recipes-kernel/blktrace/blktrace_git.bb``: SRCREV =
"d6918c8832793b4205ed3bfede78c2f915c23385" PR = "r6" PV =
@@ -1254,10 +1254,10 @@ file://xwc.patch \\ file://rxvt.desktop \\ file://rxvt.png"
When you specify local files using the ``file://`` URI protocol, the
build system fetches files from the local machine. The path is relative
-to the ```FILESPATH`` <&YOCTO_DOCS_REF_URL;#var-FILESPATH>`__ variable
+to the :term:`FILESPATH` variable
and searches specific directories in a certain order:
-``${``\ ```BP`` <&YOCTO_DOCS_REF_URL;#var-BP>`__\ ``}``,
-``${``\ ```BPN`` <&YOCTO_DOCS_REF_URL;#var-BPN>`__\ ``}``, and
+``${``\ :term:`BP`\ ``}``,
+``${``\ :term:`BPN`\ ``}``, and
``files``. The directories are assumed to be subdirectories of the
directory in which the recipe or append file resides. For another
example that specifies these types of files, see the "`Single .c File
@@ -1276,14 +1276,14 @@ Unpacking Code
--------------
During the build, the
-```do_unpack`` <&YOCTO_DOCS_REF_URL;#ref-tasks-unpack>`__ task unpacks
-the source with ``${``\ ```S`` <&YOCTO_DOCS_REF_URL;#var-S>`__\ ``}``
+:ref:`ref-tasks-unpack` task unpacks
+the source with ``${``\ :term:`S`\ ``}``
pointing to where it is unpacked.
If you are fetching your source files from an upstream source archived
tarball and the tarball's internal structure matches the common
convention of a top-level subdirectory named
-``${``\ ```BPN`` <&YOCTO_DOCS_REF_URL;#var-BPN>`__\ ``}-${``\ ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__\ ``}``,
+``${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``,
then you do not need to set ``S``. However, if ``SRC_URI`` specifies to
fetch source from an archive that does not use this convention, or from
an SCM like Git or Subversion, your recipe needs to define ``S``.
@@ -1301,7 +1301,7 @@ Sometimes it is necessary to patch code after it has been fetched. Any
files mentioned in ``SRC_URI`` whose names end in ``.patch`` or
``.diff`` or compressed versions of these suffixes (e.g. ``diff.gz`` are
treated as patches. The
-```do_patch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-patch>`__ task
+:ref:`ref-tasks-patch` task
automatically applies these patches.
The build system should be able to apply patches with the "-p1" option
@@ -1313,11 +1313,11 @@ specific subdirectory that is not specified in the patch file, use the
"patchdir" option in the entry.
As with all local files referenced in
-```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ using ``file://``,
+:term:`SRC_URI` using ``file://``,
you should place patch files in a directory next to the recipe either
named the same as the base name of the recipe
-(```BP`` <&YOCTO_DOCS_REF_URL;#var-BP>`__ and
-```BPN`` <&YOCTO_DOCS_REF_URL;#var-BPN>`__) or "files".
+(:term:`BP` and
+:term:`BPN`) or "files".
.. _new-recipe-licensing:
@@ -1325,8 +1325,8 @@ Licensing
---------
Your recipe needs to have both the
-```LICENSE`` <&YOCTO_DOCS_REF_URL;#var-LICENSE>`__ and
-```LIC_FILES_CHKSUM`` <&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM>`__
+:term:`LICENSE` and
+:term:`LIC_FILES_CHKSUM`
variables:
- *``LICENSE``:* This variable specifies the license for the software.
@@ -1383,15 +1383,15 @@ software is built; and runtime dependencies, which are required to be
installed on the target in order for the software to run.
Within a recipe, you specify build-time dependencies using the
-```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__ variable. Although
+:term:`DEPENDS` variable. Although
nuances exist, items specified in ``DEPENDS`` should be names of other
recipes. It is important that you specify all build-time dependencies
explicitly. If you do not, due to the parallel nature of BitBake's
execution, you can end up with a race condition where the dependency is
present for one task of a recipe (e.g.
-```do_configure`` <&YOCTO_DOCS_REF_URL;#ref-tasks-configure>`__) and
+:ref:`ref-tasks-configure`) and
then gone when the next task runs (e.g.
-```do_compile`` <&YOCTO_DOCS_REF_URL;#ref-tasks-compile>`__).
+:ref:`ref-tasks-compile`).
Another consideration is that configure scripts might automatically
check for optional dependencies and enable corresponding functionality
@@ -1402,18 +1402,18 @@ configure script explicitly to disable the functionality. If you wish to
make a recipe that is more generally useful (e.g. publish the recipe in
a layer for others to use), instead of hard-disabling the functionality,
you can use the
-```PACKAGECONFIG`` <&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG>`__ variable
+:term:`PACKAGECONFIG` variable
to allow functionality and the corresponding dependencies to be enabled
and disabled easily by other users of the recipe.
Similar to build-time dependencies, you specify runtime dependencies
through a variable -
-```RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-RDEPENDS>`__, which is
+:term:`RDEPENDS`, which is
package-specific. All variables that are package-specific need to have
the name of the package added to the end as an override. Since the main
package for a recipe has the same name as the recipe, and the recipe's
name can be found through the
-``${``\ ```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__\ ``}`` variable, then
+``${``\ :term:`PN`\ ``}`` variable, then
you specify the dependencies for the main package by setting
``RDEPENDS_${PN}``. If the package were named ``${PN}-tools``, then you
would set ``RDEPENDS_${PN}-tools``, and so forth.
@@ -1455,7 +1455,7 @@ A major part of build-time configuration is about checking for
build-time dependencies and possibly enabling optional functionality as
a result. You need to specify any build-time dependencies for the
software you are building in your recipe's
-```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__ value, in terms of
+:term:`DEPENDS` value, in terms of
other recipes that satisfy those dependencies. You can often find
build-time or runtime dependencies described in the software's
documentation.
@@ -1468,13 +1468,13 @@ your software is built:
need to worry about modifying the configuration.
When using Autotools, your recipe needs to inherit the
- ```autotools`` <&YOCTO_DOCS_REF_URL;#ref-classes-autotools>`__ class
+ :ref:`autotools ` class
and your recipe does not have to contain a
- ```do_configure`` <&YOCTO_DOCS_REF_URL;#ref-tasks-configure>`__ task.
+ :ref:`ref-tasks-configure` task.
However, you might still want to make some adjustments. For example,
you can set
- ```EXTRA_OECONF`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_OECONF>`__ or
- ```PACKAGECONFIG_CONFARGS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS>`__
+ :term:`EXTRA_OECONF` or
+ :term:`PACKAGECONFIG_CONFARGS`
to pass any needed configure options that are specific to the recipe.
- *CMake:* If your source files have a ``CMakeLists.txt`` file, then
@@ -1482,11 +1482,11 @@ your software is built:
need to worry about modifying the configuration.
When you use CMake, your recipe needs to inherit the
- ```cmake`` <&YOCTO_DOCS_REF_URL;#ref-classes-cmake>`__ class and your
+ :ref:`cmake ` class and your
recipe does not have to contain a
- ```do_configure`` <&YOCTO_DOCS_REF_URL;#ref-tasks-configure>`__ task.
+ :ref:`ref-tasks-configure` task.
You can make some adjustments by setting
- ```EXTRA_OECMAKE`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_OECMAKE>`__ to
+ :term:`EXTRA_OECMAKE` to
pass any needed configure options that are specific to the recipe.
.. note::
@@ -1503,7 +1503,7 @@ your software is built:
``CMakeLists.txt`` file, then your software is built using some
method other than Autotools or CMake. If this is the case, you
normally need to provide a
- ```do_configure`` <&YOCTO_DOCS_REF_URL;#ref-tasks-configure>`__ task
+ :ref:`ref-tasks-configure` task
in your recipe unless, of course, there is nothing to configure.
Even if your software is not being built by Autotools or CMake, you
@@ -1591,7 +1591,7 @@ Consider a case where your kernel is older and you need an older
standard mainline kernel, not your own custom one.
When you use custom kernel headers you need to get them from
-```STAGING_KERNEL_DIR`` <&YOCTO_DOCS_REF_URL;#var-STAGING_KERNEL_DIR>`__,
+:term:`STAGING_KERNEL_DIR`,
which is the directory with kernel headers that are required to build
out-of-tree modules. Your recipe will also need the following:
do_configure[depends] += "virtual/kernel:do_shared_workdir"
@@ -1629,7 +1629,7 @@ Here are some common issues that cause failures.
To fix the problem, you need to either satisfy the missing dependency
in the Makefile or whatever script produced the Makefile, or (as a
workaround) set
- ```PARALLEL_MAKE`` <&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE>`__ to an
+ :term:`PARALLEL_MAKE` to an
empty string: PARALLEL_MAKE = ""
For information on parallel Makefile issues, see the "`Debugging
@@ -1647,7 +1647,7 @@ Here are some common issues that cause failures.
- *Failure to find required libraries/headers:* If a build-time
dependency is missing because it has not been declared in
- ```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__, or because the
+ :term:`DEPENDS`, or because the
dependency exists but the path used by the build process to find the
file is incorrect and the configure step did not detect it, the
compilation process could fail. For either of these failures, the
@@ -1671,10 +1671,10 @@ Installing
During ``do_install``, the task copies the built files along with their
hierarchy to locations that would mirror their locations on the target
device. The installation process copies files from the
-``${``\ ```S`` <&YOCTO_DOCS_REF_URL;#var-S>`__\ ``}``,
-``${``\ ```B`` <&YOCTO_DOCS_REF_URL;#var-B>`__\ ``}``, and
-``${``\ ```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__\ ``}``
-directories to the ``${``\ ```D`` <&YOCTO_DOCS_REF_URL;#var-D>`__\ ``}``
+``${``\ :term:`S`\ ``}``,
+``${``\ :term:`B`\ ``}``, and
+``${``\ :term:`WORKDIR`\ ``}``
+directories to the ``${``\ :term:`D`\ ``}``
directory to create the structure as it should appear on the target
system.
@@ -1707,7 +1707,7 @@ the software being built:
- *Manual:* You need to define a ``do_install`` function in your
recipe. The function must first use ``install -d`` to create the
directories under
- ``${``\ ```D`` <&YOCTO_DOCS_REF_URL;#var-D>`__\ ``}``. Once the
+ ``${``\ :term:`D`\ ``}``. Once the
directories exist, your function can use ``install`` to manually
install the built software into the directories.
@@ -1734,21 +1734,21 @@ installed correctly.
- ``oe_runmake install``, which can be run directly or can be run
indirectly by the
- ```autotools`` <&YOCTO_DOCS_REF_URL;#ref-classes-autotools>`__ and
- ```cmake`` <&YOCTO_DOCS_REF_URL;#ref-classes-cmake>`__ classes,
+ :ref:`autotools ` and
+ :ref:`cmake ` classes,
runs ``make install`` in parallel. Sometimes, a Makefile can have
missing dependencies between targets that can result in race
conditions. If you experience intermittent failures during
``do_install``, you might be able to work around them by disabling
parallel Makefile installs by adding the following to the recipe:
PARALLEL_MAKEINST = "" See
- ```PARALLEL_MAKEINST`` <&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKEINST>`__
+ :term:`PARALLEL_MAKEINST`
for additional information.
- If you need to install one or more custom CMake toolchain files
that are supplied by the application you are building, install the
files to ``${D}${datadir}/cmake/`` Modules during
- ```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__.
+ :ref:`ref-tasks-install`.
.. _new-recipe-enabling-system-services:
@@ -1781,15 +1781,15 @@ different ways:
shutdown of all other programs.
To enable a service using SysVinit, your recipe needs to inherit the
- ```update-rc.d`` <&YOCTO_DOCS_REF_URL;#ref-classes-update-rc.d>`__
+ :ref:`update-rc.d `
class. The class helps facilitate safely installing the package on
the target.
You will need to set the
- ```INITSCRIPT_PACKAGES`` <&YOCTO_DOCS_REF_URL;#var-INITSCRIPT_PACKAGES>`__,
- ```INITSCRIPT_NAME`` <&YOCTO_DOCS_REF_URL;#var-INITSCRIPT_NAME>`__,
+ :term:`INITSCRIPT_PACKAGES`,
+ :term:`INITSCRIPT_NAME`,
and
- ```INITSCRIPT_PARAMS`` <&YOCTO_DOCS_REF_URL;#var-INITSCRIPT_PARAMS>`__
+ :term:`INITSCRIPT_PARAMS`
variables within your recipe.
- *systemd:* System Management Daemon (systemd) was designed to replace
@@ -1798,7 +1798,7 @@ different ways:
` `__.
To enable a service using systemd, your recipe needs to inherit the
- ```systemd`` <&YOCTO_DOCS_REF_URL;#ref-classes-systemd>`__ class. See
+ :ref:`systemd ` class. See
the ``systemd.bbclass`` file located in your `Source
Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__. section for
more information.
@@ -1819,24 +1819,24 @@ take. The following list describes the process:
task ensures that files are split up and packaged correctly.
- *Running QA Checks*: The
- ```insane`` <&YOCTO_DOCS_REF_URL;#ref-classes-insane>`__ class adds a
+ :ref:`insane ` class adds a
step to the package generation process so that output quality
assurance checks are generated by the OpenEmbedded build system. This
step performs a range of checks to be sure the build's output is free
of common problems that show up during runtime. For information on
these checks, see the
- ```insane`` <&YOCTO_DOCS_REF_URL;#ref-classes-insane>`__ class and
+ :ref:`insane ` class and
the "`QA Error and Warning
Messages <&YOCTO_DOCS_REF_URL;#ref-qa-checks>`__" chapter in the
Yocto Project Reference Manual.
- *Hand-Checking Your Packages*: After you build your software, you
need to be sure your packages are correct. Examine the
- ``${``\ ```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__\ ``}/packages-split``
+ ``${``\ :term:`WORKDIR`\ ``}/packages-split``
directory and make sure files are where you expect them to be. If you
discover problems, you can set
- ```PACKAGES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGES>`__,
- ```FILES`` <&YOCTO_DOCS_REF_URL;#var-FILES>`__,
+ :term:`PACKAGES`,
+ :term:`FILES`,
``do_install(_append)``, and so forth as needed.
- *Splitting an Application into Multiple Packages*: If you need to
@@ -1858,7 +1858,7 @@ take. The following list describes the process:
By default, packages apply to any machine with the same architecture
as the target machine. When a recipe produces packages that are
machine-specific (e.g. the
- ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ value is passed
+ :term:`MACHINE` value is passed
into the configure script or a patch is applied only for a particular
machine), you should mark them as such by adding the following to the
recipe: PACKAGE_ARCH = "${MACHINE_ARCH}"
@@ -1867,7 +1867,7 @@ take. The following list describes the process:
contain anything specific to the target machine or architecture at
all (e.g. recipes that simply package script files or configuration
files), you should use the
- ```allarch`` <&YOCTO_DOCS_REF_URL;#ref-classes-allarch>`__ class to
+ :ref:`allarch ` class to
do this for you by adding this to your recipe: inherit allarch
Ensuring that the package architecture is correct is not critical
while you are doing the first few builds of your recipe. However, it
@@ -1900,28 +1900,28 @@ recipe has two sysroots in its work directory, one for target files
Recipes should never populate the sysroot directly (i.e. write files
into sysroot). Instead, files should be installed into standard
locations during the
-```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__ task within
-the ``${``\ ```D`` <&YOCTO_DOCS_REF_URL;#var-D>`__\ ``}`` directory. The
+:ref:`ref-tasks-install` task within
+the ``${``\ :term:`D`\ ``}`` directory. The
reason for this limitation is that almost all files that populate the
sysroot are cataloged in manifests in order to ensure the files can be
removed later when a recipe is either modified or removed. Thus, the
sysroot is able to remain free from stale files.
A subset of the files installed by the
-```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__ task are
+:ref:`ref-tasks-install` task are
used by the
-```do_populate_sysroot`` <&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sysroot>`__
+:ref:`ref-tasks-populate_sysroot`
task as defined by the the
-```SYSROOT_DIRS`` <&YOCTO_DOCS_REF_URL;#var-SYSROOT_DIRS>`__ variable to
+:term:`SYSROOT_DIRS` variable to
automatically populate the sysroot. It is possible to modify the list of
directories that populate the sysroot. The following example shows how
you could add the ``/opt`` directory to the list of directories within a
recipe: SYSROOT_DIRS += "/opt"
For a more complete description of the
-```do_populate_sysroot`` <&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sysroot>`__
+:ref:`ref-tasks-populate_sysroot`
task and its associated functions, see the
-```staging`` <&YOCTO_DOCS_REF_URL;#ref-classes-staging>`__ class.
+:ref:`staging ` class.
.. _metadata-virtual-providers:
@@ -1935,12 +1935,12 @@ determined at build-time.
A common scenario where a virtual provider is used would be for the
kernel recipe. Suppose you have three kernel recipes whose
-```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__ values map to ``kernel-big``,
+:term:`PN` values map to ``kernel-big``,
``kernel-mid``, and ``kernel-small``. Furthermore, each of these recipes
-in some way uses a ```PROVIDES`` <&YOCTO_DOCS_REF_URL;#var-PROVIDES>`__
+in some way uses a :term:`PROVIDES`
statement that essentially identifies itself as being able to provide
``virtual/kernel``. Here is one way through the
-```kernel`` <&YOCTO_DOCS_REF_URL;#ref-classes-kernel>`__ class: PROVIDES
+:ref:`kernel ` class: PROVIDES
+= "${@ "virtual/kernel" if (d.getVar("KERNEL_PACKAGE_NAME") ==
"kernel") else "" }" Any recipe that inherits the ``kernel`` class is
going to utilize a ``PROVIDES`` statement that identifies that recipe as
@@ -1949,11 +1949,11 @@ being able to provide the ``virtual/kernel`` item.
Now comes the time to actually build an image and you need a kernel
recipe, but which one? You can configure your build to call out the
kernel recipe you want by using the
-```PREFERRED_PROVIDER`` <&YOCTO_DOCS_REF_URL;#var-PREFERRED_PROVIDER>`__
+:term:`PREFERRED_PROVIDER`
variable. As an example, consider the
```x86-base.inc`` `__
include file, which is a machine (i.e.
-```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__) configuration file.
+:term:`MACHINE`) configuration file.
This include file is the reason all x86-based machines use the
``linux-yocto`` kernel. Here are the relevant lines from the include
file: PREFERRED_PROVIDER_virtual/kernel ??= "linux-yocto"
@@ -1961,7 +1961,7 @@ PREFERRED_VERSION_linux-yocto ??= "4.15%"
When you use a virtual provider, you do not have to "hard code" a recipe
name as a build dependency. You can use the
-```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__ variable to state the
+:term:`DEPENDS` variable to state the
build is dependent on ``virtual/kernel`` for example: DEPENDS =
"virtual/kernel" During the build, the OpenEmbedded build system picks
the correct recipe needed for the ``virtual/kernel`` dependency based on
@@ -2014,7 +2014,7 @@ build system and package managers, so the resulting packages will not
correctly trigger an upgrade.
In order to ensure the versions compare properly, the recommended
-convention is to set ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__ within the
+convention is to set :term:`PV` within the
recipe to "previous_version+current_version". You can use an additional
variable so that you can use the current version elsewhere. Here is an
example: REALPV = "0.8.16-rc1" PV = "0.8.15+${REALPV}"
@@ -2032,7 +2032,7 @@ image. To add a post-installation script to a package, add a
to attach to the ``postinst`` script. To apply the post-installation
script to the main package for the recipe, which is usually what is
required, specify
-``${``\ ```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__\ ``}`` in place of
+``${``\ :term:`PN`\ ``}`` in place of
PACKAGENAME.
A post-installation function has the following structure:
@@ -2057,12 +2057,12 @@ target. You can use ``pkg_postinst_ontarget()`` or call
``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``. Any
failure of a ``pkg_postinst()`` script (including exit 1) triggers an
error during the
-```do_rootfs`` <&YOCTO_DOCS_REF_URL;#ref-tasks-rootfs>`__ task.
+:ref:`ref-tasks-rootfs` task.
If you have recipes that use ``pkg_postinst`` function and they require
the use of non-standard native tools that have dependencies during
rootfs construction, you need to use the
-```PACKAGE_WRITE_DEPS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_WRITE_DEPS>`__
+:term:`PACKAGE_WRITE_DEPS`
variable in your recipe to list these tools. If you do not use this
variable, the tools might be missing and execution of the
post-installation script is deferred until first boot. Deferring the
@@ -2126,7 +2126,7 @@ under ``files``) requires a recipe that has the file listed in the
``SRC_URI`` variable. Additionally, you need to manually write the
``do_compile`` and ``do_install`` tasks. The ``S`` variable defines the
directory containing the source code, which is set to
-```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__ in this case - the
+:term:`WORKDIR` in this case - the
directory BitBake uses for the build. SUMMARY = "Simple helloworld
application" SECTION = "examples" LICENSE = "MIT" LIC_FILES_CHKSUM =
"file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302"
@@ -2148,7 +2148,7 @@ Autotooled Package
Applications that use Autotools such as ``autoconf`` and ``automake``
require a recipe that has a source archive listed in ``SRC_URI`` and
also inherit the
-```autotools`` <&YOCTO_DOCS_REF_URL;#ref-classes-autotools>`__ class,
+:ref:`autotools ` class,
which contains the definitions of all the steps needed to build an
Autotool-based application. The result of the build is automatically
packaged. And, if the application uses NLS for localization, packages
@@ -2174,8 +2174,8 @@ source archive listed in ``SRC_URI``. You do not need to add a
``do_compile`` step since by default BitBake starts the ``make`` command
to compile the application. If you need additional ``make`` options, you
should store them in the
-```EXTRA_OEMAKE`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_OEMAKE>`__ or
-```PACKAGECONFIG_CONFARGS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS>`__
+:term:`EXTRA_OEMAKE` or
+:term:`PACKAGECONFIG_CONFARGS`
variables. BitBake passes these options into the GNU ``make``
invocation. Note that a ``do_install`` task is still required.
Otherwise, BitBake runs an empty ``do_install`` task by default.
@@ -2242,7 +2242,7 @@ needs to use those binaries as part of an image that you are building
using the OpenEmbedded build system. Since you only have the binaries
and not the source code, you cannot use a typical recipe that expects to
fetch the source specified in
-```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ and then compile it.
+:term:`SRC_URI` and then compile it.
One method is to package the binaries and then install them as part of
the image. Generally, it is not a good idea to package binaries since,
@@ -2256,23 +2256,23 @@ and to be sure that you are using default locations for build artifacts.
In most cases, the ``bin_package`` class handles "skipping" the
configure and compile steps as well as sets things up to grab packages
from the appropriate area. In particular, this class sets ``noexec`` on
-both the ```do_configure`` <&YOCTO_DOCS_REF_URL;#ref-tasks-configure>`__
-and ```do_compile`` <&YOCTO_DOCS_REF_URL;#ref-tasks-compile>`__ tasks,
+both the :ref:`ref-tasks-configure`
+and :ref:`ref-tasks-compile` tasks,
sets ``FILES_${PN}`` to "/" so that it picks up all files, and sets up a
-```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__ task, which
+:ref:`ref-tasks-install` task, which
effectively copies all files from ``${S}`` to ``${D}``. The
``bin_package`` class works well when the files extracted into ``${S}``
are already laid out in the way they should be laid out on the target.
For more information on these variables, see the
-```FILES`` <&YOCTO_DOCS_REF_URL;#var-FILES>`__,
-```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__,
-```S`` <&YOCTO_DOCS_REF_URL;#var-S>`__, and
-```D`` <&YOCTO_DOCS_REF_URL;#var-D>`__ variables in the Yocto Project
+:term:`FILES`,
+:term:`PN`,
+:term:`S`, and
+:term:`D` variables in the Yocto Project
Reference Manual's variable glossary.
.. note::
- - Using ```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__ is a good
+ - Using :term:`DEPENDS` is a good
idea even for components distributed in binary form, and is often
necessary for shared libraries. For a shared library, listing the
library dependencies in ``DEPENDS`` makes sure that the libraries
@@ -2291,12 +2291,12 @@ If you cannot use the ``bin_package`` class, you need to be sure you are
doing the following:
- Create a recipe where the
- ```do_configure`` <&YOCTO_DOCS_REF_URL;#ref-tasks-configure>`__ and
- ```do_compile`` <&YOCTO_DOCS_REF_URL;#ref-tasks-compile>`__ tasks do
+ :ref:`ref-tasks-configure` and
+ :ref:`ref-tasks-compile` tasks do
nothing: It is usually sufficient to just not define these tasks in
the recipe, because the default implementations do nothing unless a
Makefile is found in
- ``${``\ ```S`` <&YOCTO_DOCS_REF_URL;#var-S>`__\ ``}``.
+ ``${``\ :term:`S`\ ``}``.
If ``${S}`` might contain a Makefile, or if you inherit some class
that replaces ``do_configure`` and ``do_compile`` with custom
@@ -2306,17 +2306,17 @@ doing the following:
= "1" do_compile[noexec] = "1" Unlike
```deleting the tasks`` <&YOCTO_DOCS_BB_URL;#deleting-a-task>`__,
using the flag preserves the dependency chain from the
- ```do_fetch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-fetch>`__,
- ```do_unpack`` <&YOCTO_DOCS_REF_URL;#ref-tasks-unpack>`__, and
- ```do_patch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-patch>`__ tasks to the
- ```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__ task.
+ :ref:`ref-tasks-fetch`,
+ :ref:`ref-tasks-unpack`, and
+ :ref:`ref-tasks-patch` tasks to the
+ :ref:`ref-tasks-install` task.
- Make sure your ``do_install`` task installs the binaries
appropriately.
-- Ensure that you set up ```FILES`` <&YOCTO_DOCS_REF_URL;#var-FILES>`__
+- Ensure that you set up :term:`FILES`
(usually
- ``FILES_${``\ ```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__\ ``}``) to
+ ``FILES_${``\ :term:`PN`\ ``}``) to
point to the files you have installed, which of course depends on
where you have installed them and whether those files are in
different locations than the defaults.
@@ -2482,16 +2482,16 @@ in the BitBake User Manual.
- *Overrides:* You can use overrides to set a value conditionally,
typically based on how the recipe is being built. For example, to set
- the ```KBRANCH`` <&YOCTO_DOCS_REF_URL;#var-KBRANCH>`__ variable's
+ the :term:`KBRANCH` variable's
value to "standard/base" for any target
- ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__, except for
+ :term:`MACHINE`, except for
qemuarm where it should be set to "standard/arm-versatile-926ejs",
you would do the following: KBRANCH = "standard/base" KBRANCH_qemuarm
= "standard/arm-versatile-926ejs" Overrides are also used to separate
alternate values of a variable in other situations. For example, when
setting variables such as
- ```FILES`` <&YOCTO_DOCS_REF_URL;#var-FILES>`__ and
- ```RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-RDEPENDS>`__ that are
+ :term:`FILES` and
+ :term:`RDEPENDS` that are
specific to individual packages produced by a recipe, you should
always use an override that specifies the name of the package.
@@ -2713,7 +2713,7 @@ The following steps describe how to set up the AUH utility:
499), reused 703 (delta 434) Receiving objects: 100% (768/768),
191.47 KiB \| 98.00 KiB/s, done. Resolving deltas: 100% (499/499),
done. Checking connectivity... done. AUH is not part of the
- `OpenEmbedded-Core (OE-Core) <&YOCTO_DOCS_REF_URL;#oe-core>`__ or
+ :term:`OpenEmbedded-Core (OE-Core)` or
`Poky <&YOCTO_DOCS_REF_URL;#poky>`__ repositories.
4. *Create a Dedicated Build Directory:* Run the
@@ -2956,13 +2956,13 @@ edit the recipe files to upgrade the versions.
To manually upgrade recipe versions, follow these general steps:
1. *Change the Version:* Rename the recipe such that the version (i.e.
- the ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__ part of the recipe name)
+ the :term:`PV` part of the recipe name)
changes appropriately. If the version is not part of the recipe name,
change the value as it is set for ``PV`` within the recipe itself.
2. *Update ``SRCREV`` if Needed:* If the source code your recipe builds
is fetched from Git or some other version control system, update
- ```SRCREV`` <&YOCTO_DOCS_REF_URL;#var-SRCREV>`__ to point to the
+ :term:`SRCREV` to point to the
commit hash that matches the new version.
3. *Build the Software:* Try to build the recipe using BitBake. Typical
@@ -2970,8 +2970,8 @@ To manually upgrade recipe versions, follow these general steps:
- License statements were updated for the new version. For this
case, you need to review any changes to the license and update the
- values of ```LICENSE`` <&YOCTO_DOCS_REF_URL;#var-LICENSE>`__ and
- ```LIC_FILES_CHKSUM`` <&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM>`__
+ values of :term:`LICENSE` and
+ :term:`LIC_FILES_CHKSUM`
as needed.
.. note::
@@ -2989,7 +2989,7 @@ To manually upgrade recipe versions, follow these general steps:
4. *Optionally Attempt to Build for Several Architectures:* Once you
successfully build the new software for a given architecture, you
could test the build for other architectures by changing the
- ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ variable and
+ :term:`MACHINE` variable and
rebuilding the software. This optional step is especially important
if the recipe is to be released publicly.
@@ -3022,7 +3022,7 @@ patches.
During a build, the unpacked temporary source code used by recipes to
build packages is available in the Build Directory as defined by the
-```S`` <&YOCTO_DOCS_REF_URL;#var-S>`__ variable. Below is the default
+:term:`S` variable. Below is the default
value for the ``S`` variable as defined in the
``meta/conf/bitbake.conf`` configuration file in the `Source
Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__: S =
@@ -3042,26 +3042,26 @@ usually set ``S`` to ``${WORKDIR}/git``.
The path to the work directory for the recipe
-(```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__) is defined as
+(:term:`WORKDIR`) is defined as
follows:
${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR} The
actual directory depends on several things:
-- ```TMPDIR`` <&YOCTO_DOCS_REF_URL;#var-TMPDIR>`__: The top-level build
+- :term:`TMPDIR`: The top-level build
output directory.
-- ```MULTIMACH_TARGET_SYS`` <&YOCTO_DOCS_REF_URL;#var-MULTIMACH_TARGET_SYS>`__:
+- :term:`MULTIMACH_TARGET_SYS`:
The target system identifier.
-- ```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__: The recipe name.
+- :term:`PN`: The recipe name.
-- ```EXTENDPE`` <&YOCTO_DOCS_REF_URL;#var-EXTENDPE>`__: The epoch - (if
- ```PE`` <&YOCTO_DOCS_REF_URL;#var-PE>`__ is not specified, which is
+- :term:`EXTENDPE`: The epoch - (if
+ :term:`PE` is not specified, which is
usually the case for most recipes, then ``EXTENDPE`` is blank).
-- ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__: The recipe version.
+- :term:`PV`: The recipe version.
-- ```PR`` <&YOCTO_DOCS_REF_URL;#var-PR>`__: The recipe revision.
+- :term:`PR`: The recipe revision.
As an example, assume a Source Directory top-level folder named
``poky``, a default Build Directory at ``poky/build``, and a
@@ -3105,7 +3105,7 @@ Follow these general steps:
2. *Change Your Working Directory:* You need to be in the directory that
has the temporary source code. That directory is defined by the
- ```S`` <&YOCTO_DOCS_REF_URL;#var-S>`__ variable.
+ :term:`S` variable.
3. *Create a New Patch:* Before modifying source code, you need to
create a new patch. To create a new patch file, use ``quilt new`` as
@@ -3170,9 +3170,9 @@ Using a Development Shell
When debugging certain commands or even when just editing packages,
``devshell`` can be a useful tool. When you invoke ``devshell``, all
tasks up to and including
-```do_patch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-patch>`__ are run for the
+:ref:`ref-tasks-patch` are run for the
specified target. Then, a new terminal is opened and you are placed in
-``${``\ ```S`` <&YOCTO_DOCS_REF_URL;#var-S>`__\ ``}``, the source
+``${``\ :term:`S`\ ``}``, the source
directory. In the new terminal, all the OpenEmbedded build-related
environment variables are still defined so you can use commands such as
``configure`` and ``make``. The commands execute just as if the
@@ -3185,7 +3185,7 @@ Following is an example that uses ``devshell`` on a target named
This command spawns a terminal with a shell prompt within the
OpenEmbedded build environment. The
-```OE_TERMINAL`` <&YOCTO_DOCS_REF_URL;#var-OE_TERMINAL>`__ variable
+:term:`OE_TERMINAL` variable
controls what type of shell is opened.
For spawned terminals, the following occurs:
@@ -3200,11 +3200,11 @@ For spawned terminals, the following occurs:
Within this environment, you can run configure or compile commands as if
they were being run by the OpenEmbedded build system itself. As noted
earlier, the working directory also automatically changes to the Source
-Directory (```S`` <&YOCTO_DOCS_REF_URL;#var-S>`__).
+Directory (:term:`S`).
To manually run a specific task using ``devshell``, run the
corresponding ``run.*`` script in the
-``${``\ ```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__\ ``}/temp``
+``${``\ :term:`WORKDIR`\ ``}/temp``
directory (e.g., ``run.do_configure.``\ pid). If a task's script does
not exist, which would be the case if the task was skipped by way of the
sstate cache, you can create the task by first running it outside of the
@@ -3250,7 +3250,7 @@ previous section, you can also spawn and work within an interactive
Python development shell. When debugging certain commands or even when
just editing packages, ``devpyshell`` can be a useful tool. When you
invoke ``devpyshell``, all tasks up to and including
-```do_patch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-patch>`__ are run for the
+:ref:`ref-tasks-patch` are run for the
specified target. Then a new terminal is opened. Additionally, key
Python objects and code are available in the same way they are to
BitBake tasks, in particular, the data store 'd'. So, commands such as
@@ -3270,7 +3270,7 @@ Following is an example that uses ``devpyshell`` on a target named
This command spawns a terminal and places you in an interactive Python
interpreter within the OpenEmbedded build environment. The
-```OE_TERMINAL`` <&YOCTO_DOCS_REF_URL;#var-OE_TERMINAL>`__ variable
+:term:`OE_TERMINAL` variable
controls what type of shell is opened.
When you are finished using ``devpyshell``, you can exit the shell
@@ -3357,9 +3357,9 @@ The following figure and list overviews the build process:
of the build environment including the target machine architecture
through the ``MACHINE`` variable, the packaging format used during
the build
- (```PACKAGE_CLASSES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES>`__),
+ (:term:`PACKAGE_CLASSES`),
and a centralized tarball download directory through the
- ```DL_DIR`` <&YOCTO_DOCS_REF_URL;#var-DL_DIR>`__ variable.
+ :term:`DL_DIR` variable.
4. *Build the Image:* Build the image using the ``bitbake`` command: $
bitbake target
@@ -3377,7 +3377,7 @@ The following figure and list overviews the build process:
can be the name of a recipe for a specific piece of software such as
BusyBox. For more details about the images the OpenEmbedded build
system supports, see the
- "`Images <&YOCTO_DOCS_REF_URL;#ref-images>`__" chapter in the Yocto
+ ":ref:`ref-manual/ref-images:Images`" chapter in the Yocto
Project Reference Manual.
As an example, the following command builds the
@@ -3413,7 +3413,7 @@ Setting Up and Running a Multiple Configuration Build
To accomplish a multiple configuration build, you must define each
target's configuration separately using a parallel configuration file in
-the `Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__, and you
+the :term:`Build Directory`, and you
must follow a required file hierarchy. Additionally, you must enable the
multiple configuration builds in your ``local.conf`` file.
@@ -3426,9 +3426,9 @@ Follow these steps to set up and execute multiple configuration builds:
dictates that you do not overlap the temporary directories used
during the builds. However, it is possible that you can share the
temporary directory
- (```TMPDIR`` <&YOCTO_DOCS_REF_URL;#var-TMPDIR>`__). For example,
+ (:term:`TMPDIR`). For example,
consider a scenario with two different multiconfigs for the same
- ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__: "qemux86" built
+ :term:`MACHINE`: "qemux86" built
for two distributions such as "poky" and "poky-lsb". In this case,
you might want to use the same ``TMPDIR``.
@@ -3450,7 +3450,7 @@ Follow these steps to set up and execute multiple configuration builds:
- *Add the BitBake Multi-configuration Variable to the Local
Configuration File*: Use the
- ```BBMULTICONFIG`` <&YOCTO_DOCS_REF_URL;#var-BBMULTICONFIG>`__
+ :term:`BBMULTICONFIG`
variable in your ``conf/local.conf`` configuration file to specify
each multiconfig. Continuing with the example from the previous
figure, the ``BBMULTICONFIG`` variable needs to enable two
@@ -3498,9 +3498,9 @@ multiple configuration build. For example, suppose that in order to
build a ``core-image-sato`` image for an "x86" multiconfig, the root
filesystem of an "arm" multiconfig must exist. This dependency is
essentially that the
-```do_image`` <&YOCTO_DOCS_REF_URL;#ref-tasks-image>`__ task in the
+:ref:`ref-tasks-image` task in the
``core-image-sato`` recipe depends on the completion of the
-```do_rootfs`` <&YOCTO_DOCS_REF_URL;#ref-tasks-rootfs>`__ task of the
+:ref:`ref-tasks-rootfs` task of the
``core-image-minimal`` recipe.
To enable dependencies in a multiple configuration build, you must
@@ -3533,7 +3533,7 @@ create the ``core-image-minimal`` image for the "arm" build since the
Because "x86" and "arm" are enabled for multiple configuration builds
and have separate configuration files, BitBake places the artifacts for
each build in the respective temporary build directories (i.e.
-```TMPDIR`` <&YOCTO_DOCS_REF_URL;#var-TMPDIR>`__).
+:term:`TMPDIR`).
.. _building-an-initramfs-image:
@@ -3564,9 +3564,9 @@ Follow these steps to create an initramfs image:
2. *Decide if You Need to Bundle the initramfs Image Into the Kernel
Image:* If you want the initramfs image that is built to be bundled
in with the kernel image, set the
- ```INITRAMFS_IMAGE_BUNDLE`` <&YOCTO_DOCS_REF_URL;#var-INITRAMFS_IMAGE_BUNDLE>`__
+ :term:`INITRAMFS_IMAGE_BUNDLE`
variable to "1" in your ``local.conf`` configuration file and set the
- ```INITRAMFS_IMAGE`` <&YOCTO_DOCS_REF_URL;#var-INITRAMFS_IMAGE>`__
+ :term:`INITRAMFS_IMAGE`
variable in the recipe that builds the kernel image.
.. note::
@@ -3579,7 +3579,7 @@ Follow these steps to create an initramfs image:
Setting the ``INITRAMFS_IMAGE_BUNDLE`` flag causes the initramfs
image to be unpacked into the ``${B}/usr/`` directory. The unpacked
initramfs image is then passed to the kernel's ``Makefile`` using the
- ```CONFIG_INITRAMFS_SOURCE`` <&YOCTO_DOCS_REF_URL;#var-CONFIG_INITRAMFS_SOURCE>`__
+ :term:`CONFIG_INITRAMFS_SOURCE`
variable, allowing the initramfs image to be built into the kernel
normally.
@@ -3601,20 +3601,20 @@ Follow these steps to create an initramfs image:
3. *Optionally Add Items to the initramfs Image Through the initramfs
Image Recipe:* If you add items to the initramfs image by way of its
recipe, you should use
- ```PACKAGE_INSTALL`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_INSTALL>`__
+ :term:`PACKAGE_INSTALL`
rather than
- ```IMAGE_INSTALL`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL>`__.
+ :term:`IMAGE_INSTALL`.
``PACKAGE_INSTALL`` gives more direct control of what is added to the
image as compared to the defaults you might not necessarily want that
- are set by the ```image`` <&YOCTO_DOCS_REF_URL;#ref-classes-image>`__
- or ```core-image`` <&YOCTO_DOCS_REF_URL;#ref-classes-core-image>`__
+ are set by the :ref:`image `
+ or :ref:`core-image `
classes.
4. *Build the Kernel Image and the initramfs Image:* Build your kernel
image using BitBake. Because the initramfs image recipe is a
dependency of the kernel image, the initramfs image is built as well
and bundled with the kernel image if you used the
- ```INITRAMFS_IMAGE_BUNDLE`` <&YOCTO_DOCS_REF_URL;#var-INITRAMFS_IMAGE_BUNDLE>`__
+ :term:`INITRAMFS_IMAGE_BUNDLE`
variable described earlier.
Building a Tiny System
@@ -3850,7 +3850,7 @@ dependencies as well as removing the package management data itself.
To eliminate all the packaging requirements for an image, be sure that
"package-management" is not part of your
-```IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES>`__
+:term:`IMAGE_FEATURES`
statement for the image. When you remove this feature, you are removing
the package manager as well as its dependencies from the root
filesystem.
@@ -3866,7 +3866,7 @@ are a couple of areas to experiment with:
- ``glibc``: In general, follow this process:
1. Remove ``glibc`` features from
- ```DISTRO_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES>`__
+ :term:`DISTRO_FEATURES`
that you think you do not need.
2. Build your distribution.
@@ -3913,7 +3913,7 @@ that are extremely specific to a CPU core used in a system might enable
some micro optimizations in GCC for that particular system but would
otherwise not gain you much of a performance difference across the other
systems as compared to using a more general tuning across all the builds
-(e.g. setting ```DEFAULTTUNE`` <&YOCTO_DOCS_REF_URL;#var-DEFAULTTUNE>`__
+(e.g. setting :term:`DEFAULTTUNE`
specifically for each machine's build). Rather than "max out" each
build's tunings, you can take steps that cause the OpenEmbedded build
system to reuse software across the various machines where it makes
@@ -3924,9 +3924,9 @@ should consider the points in this section that can help you optimize
your tunings to best consider build times and package feed maintenance.
- *Share the Build Directory:* If at all possible, share the
- ```TMPDIR`` <&YOCTO_DOCS_REF_URL;#var-TMPDIR>`__ across builds. The
+ :term:`TMPDIR` across builds. The
Yocto Project supports switching between different
- ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ values in the same
+ :term:`MACHINE` values in the same
``TMPDIR``. This practice is well supported and regularly used by
developers when building for multiple machines. When you use the same
``TMPDIR`` for multiple machine builds, the OpenEmbedded build system
@@ -3958,7 +3958,7 @@ your tunings to best consider build times and package feed maintenance.
A recipe that just generates scripts can enable "all" architecture
because there are no binaries to build. To specifically enable "all"
architecture, be sure your recipe inherits the
- ```allarch`` <&YOCTO_DOCS_REF_URL;#ref-classes-allarch>`__ class.
+ :ref:`allarch ` class.
This class is useful for "all" architectures because it configures
many variables so packages can be used across multiple architectures.
@@ -3967,12 +3967,12 @@ your tunings to best consider build times and package feed maintenance.
machine-architecture dependent, which makes your recipe also
machine-architecture dependent, make sure your recipe enables the
"machine" package architecture through the
- ```MACHINE_ARCH`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_ARCH>`__
+ :term:`MACHINE_ARCH`
variable: PACKAGE_ARCH = "${MACHINE_ARCH}" When you do not
specifically enable a package architecture through the
- ```PACKAGE_ARCH`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH>`__, The
+ :term:`PACKAGE_ARCH`, The
OpenEmbedded build system defaults to the
- ```TUNE_PKGARCH`` <&YOCTO_DOCS_REF_URL;#var-TUNE_PKGARCH>`__ setting:
+ :term:`TUNE_PKGARCH` setting:
PACKAGE_ARCH = "${TUNE_PKGARCH}"
- *Choose a Generic Tuning File if Possible:* Some tunes are more
@@ -4001,11 +4001,11 @@ your tunings to best consider build times and package feed maintenance.
boards share the Vivante GPU. This class inspects the BitBake
datastore to identify if the package provides or depends on one of
the sub-architecture values. If so, the class sets the
- ```PACKAGE_ARCH`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH>`__ value
+ :term:`PACKAGE_ARCH` value
based on the ``MACHINE_SUBARCH`` value. If the package does not
provide or depend on one of the sub-architecture values but it
matches a value in the machine-specific filter, it sets
- ```MACHINE_ARCH`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_ARCH>`__. This
+ :term:`MACHINE_ARCH`. This
behavior reduces the number of packages built and saves build time by
reusing binaries.
@@ -4014,18 +4014,18 @@ your tunings to best consider build times and package feed maintenance.
example, the OpenEmbedded build system might not be using shared
state between machines when you think it should be. These types of
situations are usually due to references to machine-specific
- variables such as ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__,
- ```SERIAL_CONSOLES`` <&YOCTO_DOCS_REF_URL;#var-SERIAL_CONSOLES>`__,
- ```XSERVER`` <&YOCTO_DOCS_REF_URL;#var-XSERVER>`__,
- ```MACHINE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_FEATURES>`__,
+ variables such as :term:`MACHINE`,
+ :term:`SERIAL_CONSOLES`,
+ :term:`XSERVER`,
+ :term:`MACHINE_FEATURES`,
and so forth in code that is supposed to only be tune-specific or
when the recipe depends
- (```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__,
- ```RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-RDEPENDS>`__,
- ```RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS>`__,
- ```RSUGGESTS`` <&YOCTO_DOCS_REF_URL;#var-RSUGGESTS>`__, and so forth)
+ (:term:`DEPENDS`,
+ :term:`RDEPENDS`,
+ :term:`RRECOMMENDS`,
+ :term:`RSUGGESTS`, and so forth)
on some other recipe that already has
- ```PACKAGE_ARCH`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH>`__ defined
+ :term:`PACKAGE_ARCH` defined
as "${MACHINE_ARCH}".
.. note::
@@ -4062,14 +4062,14 @@ build system to the development team so that they can focus on their
project and maintain everyone's workflow as much as possible. In this
case, you want a kernel source directory on the development machine
where the development occurs. You want the recipe's
-```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ variable to point to
+:term:`SRC_URI` variable to point to
the external directory and use it as is, not copy it.
To build from software that comes from an external source, all you need
to do is inherit the
-```externalsrc`` <&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc>`__ class
+:ref:`externalsrc ` class
and then set the
-```EXTERNALSRC`` <&YOCTO_DOCS_REF_URL;#var-EXTERNALSRC>`__ variable to
+:term:`EXTERNALSRC` variable to
point to your external source code. Here are the statements to put in
your ``local.conf`` file: INHERIT += "externalsrc"
EXTERNALSRC_pn-myrecipe = "path-to-your-source-tree"
@@ -4087,10 +4087,10 @@ EXTERNALSRC = "path" EXTERNALSRC_BUILD = "path"
By default, ``externalsrc.bbclass`` builds the source code in a
directory separate from the external source directory as specified by
-```EXTERNALSRC`` <&YOCTO_DOCS_REF_URL;#var-EXTERNALSRC>`__. If you need
+:term:`EXTERNALSRC`. If you need
to have the source built in the same directory in which it resides, or
some other nominated directory, you can set
-```EXTERNALSRC_BUILD`` <&YOCTO_DOCS_REF_URL;#var-EXTERNALSRC_BUILD>`__
+:term:`EXTERNALSRC_BUILD`
to point to that directory: EXTERNALSRC_BUILD_pn-myrecipe =
"path-to-your-source-tree"
@@ -4107,7 +4107,7 @@ build.
Follow these steps to populate your Downloads directory:
1. *Create a Clean Downloads Directory:* Start with an empty downloads
- directory (```DL_DIR`` <&YOCTO_DOCS_REF_URL;#var-DL_DIR>`__). You
+ directory (:term:`DL_DIR`). You
start with an empty downloads directory by either removing the files
in the existing directory or by setting ``DL_DIR`` to point to either
an empty location or one that does not yet exist.
@@ -4118,7 +4118,7 @@ Follow these steps to populate your Downloads directory:
the fetch process in the next step, BitBake gathers the source files
and creates tarballs in the directory pointed to by ``DL_DIR``. See
the
- ```BB_GENERATE_MIRROR_TARBALLS`` <&YOCTO_DOCS_REF_URL;#var-BB_GENERATE_MIRROR_TARBALLS>`__
+ :term:`BB_GENERATE_MIRROR_TARBALLS`
variable for more information.
3. *Populate Your Downloads Directory Without Building:* Use BitBake to
@@ -4142,9 +4142,9 @@ Follow these steps to build your target using the files in the downloads
directory:
1. *Using Local Files Only:* Inside your ``local.conf`` file, add the
- ```SOURCE_MIRROR_URL`` <&YOCTO_DOCS_REF_URL;#var-SOURCE_MIRROR_URL>`__
+ :term:`SOURCE_MIRROR_URL`
variable, inherit the
- ```own-mirrors`` <&YOCTO_DOCS_REF_URL;#ref-classes-own-mirrors>`__
+ :ref:`own-mirrors `
class, and use the
```BB_NO_NETWORK`` <&YOCTO_DOCS_BB_URL;#var-bb-BB_NO_NETWORK>`__
variable to your ``local.conf``. SOURCE_MIRROR_URL ?=
@@ -4157,7 +4157,7 @@ directory:
2. *Start With a Clean Build:* You can start with a clean build by
removing the
- ``${``\ ```TMPDIR`` <&YOCTO_DOCS_REF_URL;#var-TMPDIR>`__\ ``}``
+ ``${``\ :term:`TMPDIR`\ ``}``
directory or using a new `Build
Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__.
@@ -4170,8 +4170,8 @@ directory:
The offline build does not work if recipes attempt to find the
latest version of software by setting
- ```SRCREV`` <&YOCTO_DOCS_REF_URL;#var-SRCREV>`__ to
- ``${``\ ```AUTOREV`` <&YOCTO_DOCS_REF_URL;#var-AUTOREV>`__\ ``}``:
+ :term:`SRCREV` to
+ ``${``\ :term:`AUTOREV`\ ``}``:
SRCREV = "${AUTOREV}" When a recipe sets ``SRCREV`` to
``${AUTOREV}``, the build system accesses the network in an
attempt to determine the latest version of software from the SCM.
@@ -4214,12 +4214,12 @@ variable for more information:
- ```PARALLEL_MAKE``: <&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE>`__ Extra
options passed to the ``make`` command during the
- ```do_compile`` <&YOCTO_DOCS_REF_URL;#ref-tasks-compile>`__ task in
+ :ref:`ref-tasks-compile` task in
order to specify parallel compilation on the local build host.
- ```PARALLEL_MAKEINST``: <&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKEINST>`__
Extra options passed to the ``make`` command during the
- ```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__ task in
+ :ref:`ref-tasks-install` task in
order to specify parallel installation on the local build host.
As mentioned, these variables all scale to the number of processor cores
@@ -4249,12 +4249,12 @@ Following are additional factors that can affect build speed:
IPK is the fastest. Additionally, selecting a singular packaging
backend also helps.
-- Using ``tmpfs`` for ```TMPDIR`` <&YOCTO_DOCS_REF_URL;#var-TMPDIR>`__
+- Using ``tmpfs`` for :term:`TMPDIR`
as a temporary file system: While this can help speed up the build,
the benefits are limited due to the compiler using ``-pipe``. The
build system goes to some lengths to avoid ``sync()`` calls into the
file system on the principle that if there was a significant failure,
- the `Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__
+ the :term:`Build Directory`
contents could easily be rebuilt.
- Inheriting the
@@ -4262,7 +4262,7 @@ Following are additional factors that can affect build speed:
Inheriting this class has shown to speed up builds due to
significantly lower amounts of data stored in the data cache as well
as on disk. Inheriting this class also makes cleanup of
- ```TMPDIR`` <&YOCTO_DOCS_REF_URL;#var-TMPDIR>`__ faster, at the
+ :term:`TMPDIR` faster, at the
expense of being easily able to dive into the source code. File
system maintainers have recommended that the fastest way to clean up
large numbers of files is to reformat partitions rather than delete
@@ -4274,14 +4274,14 @@ Aside from the previous list, you should keep some trade offs in mind
that can help you speed up the build:
- Remove items from
- ```DISTRO_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES>`__
+ :term:`DISTRO_FEATURES`
that you might not need.
- Exclude debug symbols and other debug information: If you do not need
these symbols and other debug information, disabling the ``*-dbg``
package generation can speed up the build. You can disable this
generation by setting the
- ```INHIBIT_PACKAGE_DEBUG_SPLIT`` <&YOCTO_DOCS_REF_URL;#var-INHIBIT_PACKAGE_DEBUG_SPLIT>`__
+ :term:`INHIBIT_PACKAGE_DEBUG_SPLIT`
variable to "1".
- Disable static library generation for recipes derived from
@@ -4328,7 +4328,7 @@ If you are building a library and the library offers static linking, you
can control which static library files (``*.a`` files) get included in
the built library.
-The ```PACKAGES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGES>`__ and
+The :term:`PACKAGES` and
```FILES_*`` <&YOCTO_DOCS_REF_URL;#var-FILES>`__ variables in the
``meta/conf/bitbake.conf`` configuration file define how files installed
by the ``do_install`` task are packaged. By default, the ``PACKAGES``
@@ -4391,7 +4391,7 @@ libraries could differ in architecture, compiler options, or other
optimizations.
Several examples exist in the ``meta-skeleton`` layer found in the
-`Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__:
+:term:`Source Directory`:
- ``conf/multilib-example.conf`` configuration file
@@ -4412,7 +4412,7 @@ already extended and support multiple libraries. You can check in the
``meta/conf/multilib.conf`` configuration file in the `Source
Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ to see how this is
done using the
-```BBCLASSEXTEND`` <&YOCTO_DOCS_REF_URL;#var-BBCLASSEXTEND>`__ variable.
+:term:`BBCLASSEXTEND` variable.
Eventually, all recipes will be covered and this list will not be
needed.
@@ -4420,12 +4420,12 @@ For the most part, the Multilib class extension works automatically to
extend the package name from ``${PN}`` to ``${MLPREFIX}${PN}``, where
``MLPREFIX`` is the particular multilib (e.g. "lib32-" or "lib64-").
Standard variables such as
-```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__,
-```RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-RDEPENDS>`__,
-```RPROVIDES`` <&YOCTO_DOCS_REF_URL;#var-RPROVIDES>`__,
-```RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS>`__,
-```PACKAGES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGES>`__, and
-```PACKAGES_DYNAMIC`` <&YOCTO_DOCS_REF_URL;#var-PACKAGES_DYNAMIC>`__ are
+:term:`DEPENDS`,
+:term:`RDEPENDS`,
+:term:`RPROVIDES`,
+:term:`RRECOMMENDS`,
+:term:`PACKAGES`, and
+:term:`PACKAGES_DYNAMIC` are
automatically extended by the system. If you are extending any manual
code in the recipe, you can use the ``${MLPREFIX}`` variable to ensure
those names are extended correctly. This automatic extension code
@@ -4462,12 +4462,12 @@ that exist regardless of the package management system:
- The typical convention used for the class extension code as used by
Multilib assumes that all package names specified in
- ```PACKAGES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGES>`__ that contain
+ :term:`PACKAGES` that contain
``${PN}`` have ``${PN}`` at the start of the name. When that
convention is not followed and ``${PN}`` appears at the middle or the
end of a name, problems occur.
-- The ```TARGET_VENDOR`` <&YOCTO_DOCS_REF_URL;#var-TARGET_VENDOR>`__
+- The :term:`TARGET_VENDOR`
value under Multilib will be extended to "-vendormlmultilib" (e.g.
"-pokymllib32" for a "lib32" Multilib with Poky). The reason for this
slightly unwieldy contraction is that any "-" characters in the
@@ -4479,7 +4479,7 @@ details exist:
- A unique architecture is defined for the Multilib packages, along
with creating a unique deploy folder under ``tmp/deploy/rpm`` in the
- `Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__. For
+ :term:`Build Directory`. For
example, consider ``lib32`` in a ``qemux86-64`` image. The possible
architectures in the system are "all", "qemux86_64",
"lib32_qemux86_64", and "lib32_x86".
@@ -4525,7 +4525,7 @@ versions of the same library in parallel on the same system.
The process is straightforward as long as the libraries use proper
versioning. With properly versioned libraries, all you need to do to
individually specify the libraries is create separate, appropriately
-named recipes where the ```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__ part of
+named recipes where the :term:`PN` part of
the name includes a portion that differentiates each library version
(e.g.the major part of the version number). Thus, instead of having a
single recipe that loads one version of a library (e.g. ``clutter``),
@@ -4534,7 +4534,7 @@ libraries you want. As an example, the following two recipes would allow
the two separate versions of the ``clutter`` library to co-exist on the
same system: clutter-1.6_1.6.20.bb clutter-1.8_1.8.4.bb Additionally, if
you have other recipes that depend on a given library, you need to use
-the ```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__ variable to
+the :term:`DEPENDS` variable to
create the dependency. Continuing with the same example, if you want to
have a recipe depend on the 1.8 version of the ``clutter`` library, use
the following in your recipe: DEPENDS = "clutter-1.8"
@@ -4625,15 +4625,15 @@ Enabling the generation of introspection data (GIR files) in your
library package involves the following:
1. Inherit the
- ```gobject-introspection`` <&YOCTO_DOCS_REF_URL;#ref-classes-gobject-introspection>`__
+ :ref:`gobject-introspection `
class.
2. Make sure introspection is not disabled anywhere in the recipe or
from anything the recipe includes. Also, make sure that
"gobject-introspection-data" is not in
- ```DISTRO_FEATURES_BACKFILL_CONSIDERED`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES_BACKFILL_CONSIDERED>`__
+ :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
and that "qemu-usermode" is not in
- ```MACHINE_FEATURES_BACKFILL_CONSIDERED`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_FEATURES_BACKFILL_CONSIDERED>`__.
+ :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`.
If either of these conditions exist, nothing will happen.
3. Try to build the recipe. If you encounter build errors that look like
@@ -4699,9 +4699,9 @@ Use the following procedure to test if generating introspection data is
working in an image:
1. Make sure that "gobject-introspection-data" is not in
- ```DISTRO_FEATURES_BACKFILL_CONSIDERED`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES_BACKFILL_CONSIDERED>`__
+ :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
and that "qemu-usermode" is not in
- ```MACHINE_FEATURES_BACKFILL_CONSIDERED`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_FEATURES_BACKFILL_CONSIDERED>`__.
+ :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`.
2. Build ``core-image-sato``.
@@ -4750,7 +4750,7 @@ follows:
- Make sure you add the layer that contains the toolchain to your
``bblayers.conf`` file through the
- ```BBLAYERS`` <&YOCTO_DOCS_REF_URL;#var-BBLAYERS>`__ variable.
+ :term:`BBLAYERS` variable.
- Set the ``EXTERNAL_TOOLCHAIN`` variable in your ``local.conf`` file
to the location in which you installed the toolchain.
@@ -4760,7 +4760,7 @@ Mentor Graphics Sourcery G++ Toolchain. You can see information on how
to use that particular layer in the ``README`` file at
` `__. You can find
further information by reading about the
-```TCMODE`` <&YOCTO_DOCS_REF_URL;#var-TCMODE>`__ variable in the Yocto
+:term:`TCMODE` variable in the Yocto
Project Reference Manual's variable glossary.
Creating Partitioned Images Using Wic
@@ -4827,7 +4827,7 @@ this information is required to use Wic, you might find it interesting.
- Wic is a completely independent standalone utility that initially
provides easier-to-use and more flexible replacements for an existing
functionality in OE-Core's
- ```image-live`` <&YOCTO_DOCS_REF_URL;#ref-classes-image-live>`__
+ :ref:`image-live `
class. The difference between Wic and those examples is that with Wic
the functionality of those scripts is implemented by a
general-purpose partitioning language, which is based on Redhat
@@ -4852,7 +4852,7 @@ system needs to meet the following requirements:
- You must have sourced the build environment setup script (i.e.
````` <&YOCTO_DOCS_REF_URL;#structure-core-script>`__) found in the
- `Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__.
+ :term:`Build Directory`.
- You need to have the build artifacts already available, which
typically means that you must have already created an image using the
@@ -4865,12 +4865,12 @@ system needs to meet the following requirements:
build system: $ bitbake parted-native dosfstools-native mtools-native
- Include "wic" as part of the
- ```IMAGE_FSTYPES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES>`__
+ :term:`IMAGE_FSTYPES`
variable.
- Include the name of the `wic kickstart
file <&YOCTO_DOCS_REF_URL;#openembedded-kickstart-wks-reference>`__
- as part of the ```WKS_FILE`` <&YOCTO_DOCS_REF_URL;#var-WKS_FILE>`__
+ as part of the :term:`WKS_FILE`
variable
.. _wic-getting-help:
@@ -4923,7 +4923,7 @@ for creating the image: Raw and Cooked:
command-line arguments.
- *Cooked Mode:* The current
- ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ setting and image
+ :term:`MACHINE` setting and image
name are used to automatically locate and provide the build
artifacts. You just supply a kickstart file and the name of the image
from which to use artifacts.
@@ -5172,7 +5172,7 @@ INFO: The image(s) were created using OE kickstart file:
The previous example shows the easiest way to create an image by running
in cooked mode and supplying a kickstart file and the "-e" option to
point to the existing build artifacts. Your ``local.conf`` file needs to
-have the ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ variable set
+have the :term:`MACHINE` variable set
to the machine you are using, which is "qemux86" in this example.
Once the image builds, the output provides image location, artifact use,
@@ -5234,7 +5234,7 @@ untouched: part /boot --source bootimg-pcbios --ondisk sdb --label boot
--label platform --align 1024 --use-uuid Once the lines are changed, the
example generates the ``directdisksdb-gpt`` image. The command points
the process at the ``core-image-minimal`` artifacts for the Next Unit of
-Computing (nuc) ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ the
+Computing (nuc) :term:`MACHINE` the
``local.conf``. $ wic create directdisksdb-gpt -e core-image-minimal
INFO: Building wic-tools... . . . Initialising tasks: 100%
\|#######################################\| Time: 0:00:01 NOTE:
@@ -5287,7 +5287,7 @@ NATIVE_SYSROOT:
/home/stephano/build/master/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native
INFO: The image(s) were created using OE kickstart file:
/home/stephano/my_yocto/test.wks For this example,
-```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ did not have to be
+:term:`MACHINE` did not have to be
specified in the ``local.conf`` file since the artifact is manually
specified.
@@ -5419,7 +5419,7 @@ any type of image. Use these steps to flash an image using Bmaptool:
+= "wic wic.bmap"
2. *Get Your Image:* Either have your image ready (pre-built with the
- ```IMAGE_FSTYPES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES>`__
+ :term:`IMAGE_FSTYPES`
setting previously mentioned) or take the step to build the image: $
bitbake image
@@ -5540,10 +5540,10 @@ You can take some steps that are specific to the OpenEmbedded build
system to make your images more secure:
- Ensure "debug-tweaks" is not one of your selected
- ```IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES>`__.
+ :term:`IMAGE_FEATURES`.
When creating a new project, the default is to provide you with an
initial ``local.conf`` file that enables this feature using the
- ```EXTRA_IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES>`__
+ :term:`EXTRA_IMAGE_FEATURES`
variable with the line: EXTRA_IMAGE_FEATURES = "debug-tweaks" To
disable that feature, simply comment out that line in your
``local.conf`` file, or make sure ``IMAGE_FEATURES`` does not contain
@@ -5558,7 +5558,7 @@ system to make your images more secure:
users, you should not duplicate passwords.
To set up passwords, use the
- ```extrausers`` <&YOCTO_DOCS_REF_URL;#ref-classes-extrausers>`__
+ :ref:`extrausers `
class, which is the preferred method. For an example on how to set up
both root and user passwords, see the
"```extrausers.bbclass`` <&YOCTO_DOCS_REF_URL;#ref-classes-extrausers>`__"
@@ -5591,7 +5591,7 @@ Creating Your Own Distribution
==============================
When you build an image using the Yocto Project and do not alter any
-distribution `Metadata <&YOCTO_DOCS_REF_URL;#metadata>`__, you are
+distribution :term:`Metadata`, you are
creating a Poky distribution. If you wish to gain more control over
package alternative selections, compile-time options, and other
low-level configurations, you can create your own distribution.
@@ -5633,14 +5633,14 @@ layer. The following steps provide some more detail:
desired version and revisions for individual recipes.
Your configuration file needs to set the following required
- variables: ```DISTRO_NAME`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_NAME>`__
- ```DISTRO_VERSION`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_VERSION>`__
+ variables: :term:`DISTRO_NAME`
+ :term:`DISTRO_VERSION`
These following variables are optional and you typically set them
from the distribution configuration file:
- ```DISTRO_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES>`__
- ```DISTRO_EXTRA_RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_EXTRA_RDEPENDS>`__
- ```DISTRO_EXTRA_RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_EXTRA_RRECOMMENDS>`__
- ```TCLIBC`` <&YOCTO_DOCS_REF_URL;#var-TCLIBC>`__
+ :term:`DISTRO_FEATURES`
+ :term:`DISTRO_EXTRA_RDEPENDS`
+ :term:`DISTRO_EXTRA_RRECOMMENDS`
+ :term:`TCLIBC`
.. tip::
@@ -5665,7 +5665,7 @@ layer. The following steps provide some more detail:
- *Point to Your distribution configuration file:* In your
``local.conf`` file in the `Build
Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__, set your
- ```DISTRO`` <&YOCTO_DOCS_REF_URL;#var-DISTRO>`__ variable to point to
+ :term:`DISTRO` variable to point to
your distribution's configuration file. For example, if your
distribution's configuration file is named ``mydistro.conf``, then
you point to it as follows: DISTRO = "mydistro"
@@ -5719,7 +5719,7 @@ To override these default configuration files with configurations you
want used within every new Build Directory, simply set the
``TEMPLATECONF`` variable to your directory. The ``TEMPLATECONF``
variable is set in the ``.templateconf`` file, which is in the top-level
-`Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ folder
+:term:`Source Directory` folder
(e.g. ``poky``). Edit the ``.templateconf`` so that it can locate your
directory.
@@ -5758,7 +5758,7 @@ Conserving Disk Space During Builds
To help conserve disk space during builds, you can add the following
statement to your project's ``local.conf`` configuration file found in
-the `Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__: INHERIT
+the :term:`Build Directory`: INHERIT
+= "rm_work" Adding this statement deletes the work directory used for
building a recipe once the recipe is built. For more information on
"rm_work", see the
@@ -5810,15 +5810,15 @@ or attach them to a specific image recipe by using a recipe name
override. For more detail on the variables, see the descriptions in the
Yocto Project Reference Manual's glossary chapter.
-- ```BAD_RECOMMENDATIONS`` <&YOCTO_DOCS_REF_URL;#var-BAD_RECOMMENDATIONS>`__:
+- :term:`BAD_RECOMMENDATIONS`:
Use this variable to specify "recommended-only" packages that you do
not want installed.
-- ```NO_RECOMMENDATIONS`` <&YOCTO_DOCS_REF_URL;#var-NO_RECOMMENDATIONS>`__:
+- :term:`NO_RECOMMENDATIONS`:
Use this variable to prevent all "recommended-only" packages from
being installed.
-- ```PACKAGE_EXCLUDE`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_EXCLUDE>`__:
+- :term:`PACKAGE_EXCLUDE`:
Use this variable to prevent specific packages from being installed
regardless of whether they are "recommended-only" or not. You need to
realize that the build process could fail with an error when you
@@ -5852,8 +5852,8 @@ the following:
.
The version and revision are taken from the
- ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__ and
- ```PR`` <&YOCTO_DOCS_REF_URL;#var-PR>`__ variables, respectively.
+ :term:`PV` and
+ :term:`PR` variables, respectively.
- ``PV``: The recipe version. ``PV`` represents the version of the
software being packaged. Do not confuse ``PV`` with the binary
@@ -5861,7 +5861,7 @@ the following:
- ``PR``: The recipe revision.
-- ```SRCPV`` <&YOCTO_DOCS_REF_URL;#var-SRCPV>`__: The OpenEmbedded
+- :term:`SRCPV`: The OpenEmbedded
build system uses this string to help define the value of ``PV`` when
the source code revision needs to be included in it.
@@ -5899,7 +5899,7 @@ Working With a PR Service
~~~~~~~~~~~~~~~~~~~~~~~~~
As mentioned, attempting to maintain revision numbers in the
-`Metadata <&YOCTO_DOCS_REF_URL;#metadata>`__ is error prone, inaccurate,
+:term:`Metadata` is error prone, inaccurate,
and causes problems for people submitting recipes. Conversely, the PR
Service automatically generates increasing numbers, particularly the
revision field, which removes the human element.
@@ -5912,9 +5912,9 @@ revision field, which removes the human element.
The Yocto Project uses variables in order of decreasing priority to
facilitate revision numbering (i.e.
-```PE`` <&YOCTO_DOCS_REF_URL;#var-PE>`__,
-```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__, and
-```PR`` <&YOCTO_DOCS_REF_URL;#var-PR>`__ for epoch, version, and
+:term:`PE`,
+:term:`PV`, and
+:term:`PR` for epoch, version, and
revision, respectively). The values are highly dependent on the policies
and procedures of a given distribution and package feed.
@@ -5946,7 +5946,7 @@ be consistent and correct with the latest changes.
The simplest form for a PR Service is for it to exist for a single host
development system that builds the package feed (building system). For
this scenario, you can enable a local PR Service by setting
-```PRSERV_HOST`` <&YOCTO_DOCS_REF_URL;#var-PRSERV_HOST>`__ in your
+:term:`PRSERV_HOST` in your
``local.conf`` file in the `Build
Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__: PRSERV_HOST =
"localhost:0" Once the service is started, packages will automatically
@@ -5988,7 +5988,7 @@ Manually Bumping PR
~~~~~~~~~~~~~~~~~~~
The alternative to setting up a PR Service is to manually "bump" the
-```PR`` <&YOCTO_DOCS_REF_URL;#var-PR>`__ variable.
+:term:`PR` variable.
If a committed change results in changing the package output, then the
value of the PR variable needs to be increased (or "bumped") as part of
@@ -6027,10 +6027,10 @@ Automatically Incrementing a Package Version Number
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When fetching a repository, BitBake uses the
-```SRCREV`` <&YOCTO_DOCS_REF_URL;#var-SRCREV>`__ variable to determine
+:term:`SRCREV` variable to determine
the specific source code revision from which to build. You set the
``SRCREV`` variable to
-```AUTOREV`` <&YOCTO_DOCS_REF_URL;#var-AUTOREV>`__ to cause the
+:term:`AUTOREV` to cause the
OpenEmbedded build system to automatically use the latest revision of
the software: SRCREV = "${AUTOREV}"
@@ -6043,7 +6043,7 @@ with a number. The number used depends on the state of the PR Service:
- If PR Service is enabled, the build system increments the number,
which is similar to the behavior of
- ```PR`` <&YOCTO_DOCS_REF_URL;#var-PR>`__. This behavior results in
+ :term:`PR`. This behavior results in
linearly increasing package versions, which is desirable. Here is an
example: hello-world-git_0.0+git0+b6558dd387-r0.0_armv7a-neon.ipk
hello-world-git_0.0+git1+dd2f5c3565-r0.0_armv7a-neon.ipk
@@ -6087,7 +6087,7 @@ To ensure the module packaging actually gets done, you use the
function in your recipe. The ``do_split_packages`` function searches for
a pattern of files or directories under a specified path and creates a
package for each one it finds by appending to the
-```PACKAGES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGES>`__ variable and
+:term:`PACKAGES` variable and
setting the appropriate values for ``FILES_packagename``,
``RDEPENDS_packagename``, ``DESCRIPTION_packagename``, and so forth.
Here is an example from the ``lighttpd`` recipe: python
@@ -6112,7 +6112,7 @@ previous example specifies a number of things in the call to
dependency on the main ``lighttpd`` package. Thus, if a file in
``${libdir}`` called ``mod_alias.so`` is found, a package called
``lighttpd-module-alias`` is created for it and the
- ```DESCRIPTION`` <&YOCTO_DOCS_REF_URL;#var-DESCRIPTION>`__ is set to
+ :term:`DESCRIPTION` is set to
"Lighttpd module for alias".
Often, packaging modules is as simple as the previous example. However,
@@ -6165,13 +6165,13 @@ Satisfying Dependencies
The second part for handling optional module packaging is to ensure that
any dependencies on optional modules from other recipes are satisfied by
your recipe. You can be sure these dependencies are satisfied by using
-the ```PACKAGES_DYNAMIC`` <&YOCTO_DOCS_REF_URL;#var-PACKAGES_DYNAMIC>`__
+the :term:`PACKAGES_DYNAMIC`
variable. Here is an example that continues with the ``lighttpd`` recipe
shown earlier: PACKAGES_DYNAMIC = "lighttpd-module-.*" The name
specified in the regular expression can of course be anything. In this
example, it is ``lighttpd-module-`` and is specified as the prefix to
-ensure that any ```RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-RDEPENDS>`__ and
-```RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS>`__ on a package
+ensure that any :term:`RDEPENDS` and
+:term:`RRECOMMENDS` on a package
name starting with the prefix are satisfied during build time. If you
are using ``do_split_packages`` as described in the previous section,
the value you put in ``PACKAGES_DYNAMIC`` should correspond to the name
@@ -6250,7 +6250,7 @@ aware in order to provide support for runtime package management.
When BitBake generates packages, it needs to know what format or formats
to use. In your configuration, you use the
-```PACKAGE_CLASSES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES>`__
+:term:`PACKAGE_CLASSES`
variable to specify the format:
1. Open the ``local.conf`` file inside your `Build
@@ -6272,7 +6272,7 @@ If you would like your image to start off with a basic package database
containing the packages in your current build as well as to have the
relevant tools available on the target for runtime package management,
you can include "package-management" in the
-```IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES>`__
+:term:`IMAGE_FEATURES`
variable. Including "package-management" in this configuration variable
ensures that when the image is assembled for your target, the image
includes the currently-known package databases as well as the
@@ -6281,7 +6281,7 @@ performed on the target. However, this is not strictly necessary. You
could start your image off without any databases but only include the
required on-target package tool(s). As an example, you could include
"opkg" in your
-```IMAGE_INSTALL`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL>`__ variable
+:term:`IMAGE_INSTALL` variable
if you are using the IPK package format. You can then initialize your
target's package database(s) later once your image is up and running.
@@ -6298,10 +6298,10 @@ Thus, be sure to run the package update step separately after building
any packages.
You can use the
-```PACKAGE_FEED_ARCHS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_FEED_ARCHS>`__,
-```PACKAGE_FEED_BASE_PATHS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_FEED_BASE_PATHS>`__,
+:term:`PACKAGE_FEED_ARCHS`,
+:term:`PACKAGE_FEED_BASE_PATHS`,
and
-```PACKAGE_FEED_URIS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_FEED_URIS>`__
+:term:`PACKAGE_FEED_URIS`
variables to pre-configure target images to use a package feed. If you
do not define these variables, then manual steps as described in the
subsequent sections are necessary to configure the target. You should
@@ -6310,7 +6310,7 @@ correctly configured image.
When your build is complete, your packages reside in the
``${TMPDIR}/deploy/packageformat`` directory. For example, if
-``${``\ ```TMPDIR`` <&YOCTO_DOCS_REF_URL;#var-TMPDIR>`__\ ``}`` is
+``${``\ :term:`TMPDIR`\ ``}`` is
``tmp`` and your selected package type is RPM, then your RPM packages
are available in ``tmp/deploy/rpm``.
@@ -6333,7 +6333,7 @@ Lighttpd, or Nginx), take the appropriate steps to do so.
From within the build directory where you have built an image based on
your packaging choice (i.e. the
-```PACKAGE_CLASSES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES>`__
+:term:`PACKAGE_CLASSES`
setting), simply start the server. The following example assumes a build
directory of ``~/poky/build/tmp/deploy/rpm`` and a ``PACKAGE_CLASSES``
setting of "package_rpm": $ cd ~/poky/build/tmp/deploy/rpm $ python -m
@@ -6431,10 +6431,10 @@ Using IPK
The ``opkg`` application performs runtime package management of IPK
packages. You must perform an initial setup for ``opkg`` on the target
machine if the
-```PACKAGE_FEED_ARCHS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_FEED_ARCHS>`__,
-```PACKAGE_FEED_BASE_PATHS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_FEED_BASE_PATHS>`__,
+:term:`PACKAGE_FEED_ARCHS`,
+:term:`PACKAGE_FEED_BASE_PATHS`,
and
-```PACKAGE_FEED_URIS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_FEED_URIS>`__
+:term:`PACKAGE_FEED_URIS`
variables have not been set or the target image was built before the
variables were set.
@@ -6463,10 +6463,10 @@ The ``apt`` application performs runtime package management of DEB
packages. This application uses a source list file to find available
package databases. You must perform an initial setup for ``apt`` on the
target machine if the
-```PACKAGE_FEED_ARCHS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_FEED_ARCHS>`__,
-```PACKAGE_FEED_BASE_PATHS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_FEED_BASE_PATHS>`__,
+:term:`PACKAGE_FEED_ARCHS`,
+:term:`PACKAGE_FEED_BASE_PATHS`,
and
-```PACKAGE_FEED_URIS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_FEED_URIS>`__
+:term:`PACKAGE_FEED_URIS`
variables have not been set or the target image was built before the
variables were set.
@@ -6580,8 +6580,8 @@ Adding ptest to Your Build
~~~~~~~~~~~~~~~~~~~~~~~~~~
To add package testing to your build, add the
-```DISTRO_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES>`__ and
-```EXTRA_IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES>`__
+:term:`DISTRO_FEATURES` and
+:term:`EXTRA_IMAGE_FEATURES`
variables to your ``local.conf`` file, which is found in the `Build
Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__:
DISTRO_FEATURES_append = " ptest" EXTRA_IMAGE_FEATURES += "ptest-pkgs"
@@ -6604,20 +6604,20 @@ you need to prepare the recipes that build the packages you want to
test. Here is what you have to do for each recipe:
- *Be sure the recipe inherits
- the*\ ```ptest`` <&YOCTO_DOCS_REF_URL;#ref-classes-ptest>`__\ *class:*
+ the*\ :ref:`ptest `\ *class:*
Include the following line in each recipe: inherit ptest
- *Create ``run-ptest``:* This script starts your test. Locate the
script where you will refer to it using
- ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__. Here is an
+ :term:`SRC_URI`. Here is an
example that starts a test for ``dbus``: #!/bin/sh cd test make -k
runtest-TESTS
- *Ensure dependencies are met:* If the test adds build or runtime
dependencies that normally do not exist for the package (such as
requiring "make" to run the test suite), use the
- ```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__ and
- ```RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-RDEPENDS>`__ variables in
+ :term:`DEPENDS` and
+ :term:`RDEPENDS` variables in
your recipe in order for the package to meet the dependencies. Here
is an example where the package has a runtime dependency on "make":
RDEPENDS_${PN}-ptest += "make"
@@ -6732,9 +6732,9 @@ possible. The result is a generated recipe.
The recipe file is fairly simple and contains every license that
``recipetool`` finds and includes the licenses in the recipe's
-```LIC_FILES_CHKSUM`` <&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM>`__
+:term:`LIC_FILES_CHKSUM`
variables. You need to examine the variables and look for those with
-"unknown" in the ```LICENSE`` <&YOCTO_DOCS_REF_URL;#var-LICENSE>`__
+"unknown" in the :term:`LICENSE`
field. You need to track down the license information for "unknown"
modules and manually add the information to the recipe.
@@ -6764,7 +6764,7 @@ inherit npm LICENSE_${PN} = "MIT" LICENSE_${PN}-accepts = "MIT"
LICENSE_${PN}-array-flatten = "MIT" ... LICENSE_${PN}-vary = "MIT" Three
key points exist in the previous example:
-- ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ uses the NPM
+- :term:`SRC_URI` uses the NPM
scheme so that the NPM fetcher is used.
- ``recipetool`` collects all the license information. If a
@@ -6772,7 +6772,7 @@ key points exist in the previous example:
the comments.
- The ``inherit npm`` statement causes the
- ```npm`` <&YOCTO_DOCS_REF_URL;#ref-classes-npm>`__ class to package
+ :ref:`npm ` class to package
up all the modules.
You can run the following command to build the ``cute-files`` package: $
@@ -6828,7 +6828,7 @@ Adding custom metadata to packages
----------------------------------
The variable
-```PACKAGE_ADD_METADATA`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_ADD_METADATA>`__
+:term:`PACKAGE_ADD_METADATA`
can be used to add additional metadata to packages. This is reflected in
the package control/spec file. To take the ipk format for example, the
CONTROL file stored inside would contain the additional metadata as
@@ -6869,7 +6869,7 @@ Efficiently Fetching Source Files During a Build
================================================
The OpenEmbedded build system works with source files located through
-the ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ variable. When
+the :term:`SRC_URI` variable. When
you build something using BitBake, a big part of the operation is
locating and downloading all the source tarballs. For images,
downloading all the source for various packages can take a significant
@@ -6896,15 +6896,15 @@ SOURCE_MIRROR_URL ?= "file:///home/you/your-download-dir/" INHERIT +=
"own-mirrors" BB_GENERATE_MIRROR_TARBALLS = "1" # BB_NO_NETWORK = "1"
In the previous example, the
-```BB_GENERATE_MIRROR_TARBALLS`` <&YOCTO_DOCS_REF_URL;#var-BB_GENERATE_MIRROR_TARBALLS>`__
+:term:`BB_GENERATE_MIRROR_TARBALLS`
variable causes the OpenEmbedded build system to generate tarballs of
the Git repositories and store them in the
-```DL_DIR`` <&YOCTO_DOCS_REF_URL;#var-DL_DIR>`__ directory. Due to
+:term:`DL_DIR` directory. Due to
performance reasons, generating and storing these tarballs is not the
build system's default behavior.
You can also use the
-```PREMIRRORS`` <&YOCTO_DOCS_REF_URL;#var-PREMIRRORS>`__ variable. For
+:term:`PREMIRRORS` variable. For
an example, see the variable's glossary entry in the Yocto Project
Reference Manual.
@@ -6917,7 +6917,7 @@ actually starting a build. This technique lets you work through any
download issues and ultimately gathers all the source files into your
download directory
```build/downloads`` <&YOCTO_DOCS_REF_URL;#structure-build-downloads>`__,
-which is located with ```DL_DIR`` <&YOCTO_DOCS_REF_URL;#var-DL_DIR>`__.
+which is located with :term:`DL_DIR`.
Use the following BitBake command form to fetch all the necessary
sources without starting the build: $ bitbake target --runall=fetch This
@@ -6974,7 +6974,7 @@ To remove initscripts from your image altogether, set this variable
also: VIRTUAL-RUNTIME_initscripts = ""
For information on the backfill variable, see
-```DISTRO_FEATURES_BACKFILL_CONSIDERED`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES_BACKFILL_CONSIDERED>`__.
+:term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`.
Using systemd for the Main Image and Using SysVinit for the Rescue Image
------------------------------------------------------------------------
@@ -7011,12 +7011,12 @@ Using Persistent and Pre-Populated\ ``/dev``
--------------------------------------------
To use the static method for device population, you need to set the
-```USE_DEVFS`` <&YOCTO_DOCS_REF_URL;#var-USE_DEVFS>`__ variable to "0"
+:term:`USE_DEVFS` variable to "0"
as follows: USE_DEVFS = "0"
The content of the resulting ``/dev`` directory is defined in a Device
Table file. The
-```IMAGE_DEVICE_TABLES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_DEVICE_TABLES>`__
+:term:`IMAGE_DEVICE_TABLES`
variable defines the Device Table to use and should be set in the
machine or distro configuration file. Alternatively, you can set this
variable in your ``local.conf`` configuration file.
@@ -7034,7 +7034,7 @@ Using ``devtmpfs`` and a Device Manager
---------------------------------------
To use the dynamic method for device population, you need to use (or be
-sure to set) the ```USE_DEVFS`` <&YOCTO_DOCS_REF_URL;#var-USE_DEVFS>`__
+sure to set) the :term:`USE_DEVFS`
variable to "1", which is the default: USE_DEVFS = "1" With this
setting, the resulting ``/dev`` directory is populated by the kernel
using ``devtmpfs``. Make sure the corresponding kernel configuration
@@ -7065,12 +7065,12 @@ This only works for SCMs from which it is possible to get a sensible
revision number for changes. Currently, you can do this with Apache
Subversion (SVN), Git, and Bazaar (BZR) repositories.
-To enable this behavior, the ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__ of
+To enable this behavior, the :term:`PV` of
the recipe needs to reference
-```SRCPV`` <&YOCTO_DOCS_REF_URL;#var-SRCPV>`__. Here is an example: PV =
+:term:`SRCPV`. Here is an example: PV =
"1.2.3+git${SRCPV}" Then, you can add the following to your
``local.conf``: SRCREV_pn-PN = "${AUTOREV}"
-```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__ is the name of the recipe for
+:term:`PN` is the name of the recipe for
which you want to enable automatic source revision updating.
If you do not want to update your local configuration file, you can add
@@ -7135,8 +7135,8 @@ For more information on how to use these variables, see the
"`Customizing Images Using Custom ``IMAGE_FEATURES`` and
``EXTRA_IMAGE_FEATURES`` <#usingpoky-extend-customimage-imagefeatures>`__"
section. For information on the variables, see
-```IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES>`__ and
-```EXTRA_IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES>`__.
+:term:`IMAGE_FEATURES` and
+:term:`EXTRA_IMAGE_FEATURES`.
Post-Installation Scripts
-------------------------
@@ -7163,7 +7163,7 @@ Here are some common problems that prevent post-installation scripts
from running during root filesystem creation:
- *Not using $D in front of absolute paths:* The build system defines
- ``$``\ ```D`` <&YOCTO_DOCS_REF_URL;#var-D>`__ when the root
+ ``$``\ :term:`D` when the root
filesystem is created. Furthermore, ``$D`` is blank when the script
is run on the target device. This implies two purposes for ``$D``:
ensuring paths are valid in both the host and target environments,
@@ -7175,7 +7175,7 @@ from running during root filesystem creation:
native tools, which run on the host system, to accomplish the same
tasks, or by alternatively running the processes under QEMU, which
has the ``qemu_run_binary`` function. For more information, see the
- ```qemu`` <&YOCTO_DOCS_REF_URL;#ref-classes-qemu>`__ class.
+ :ref:`qemu ` class.
Areas With Write Access
-----------------------
@@ -7200,7 +7200,7 @@ has already been built when the software is building, the software will
link to the built library and that library will be pulled into your
image along with the new software even if you did not want the library.
-The ```buildhistory`` <&YOCTO_DOCS_REF_URL;#ref-classes-buildhistory>`__
+The :ref:`buildhistory `
class exists to help you maintain the quality of your build output. You
can use the class to highlight unexpected and possibly unwanted changes
in the build output. When you enable build history, it records
@@ -7224,9 +7224,9 @@ Enabling and Disabling Build History
Build history is disabled by default. To enable it, add the following
``INHERIT`` statement and set the
-```BUILDHISTORY_COMMIT`` <&YOCTO_DOCS_REF_URL;#var-BUILDHISTORY_COMMIT>`__
+:term:`BUILDHISTORY_COMMIT`
variable to "1" at the end of your ``conf/local.conf`` file found in the
-`Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__: INHERIT +=
+:term:`Build Directory`: INHERIT +=
"buildhistory" BUILDHISTORY_COMMIT = "1" Enabling build history as
previously described causes the OpenEmbedded build system to collect
build output information and commit it as a single commit to a local
@@ -7245,9 +7245,9 @@ Understanding What the Build History Contains
---------------------------------------------
Build history information is kept in
-``${``\ ```TOPDIR`` <&YOCTO_DOCS_REF_URL;#var-TOPDIR>`__\ ``}/buildhistory``
+``${``\ :term:`TOPDIR`\ ``}/buildhistory``
in the Build Directory as defined by the
-```BUILDHISTORY_DIR`` <&YOCTO_DOCS_REF_URL;#var-BUILDHISTORY_DIR>`__
+:term:`BUILDHISTORY_DIR`
variable. The following is an example abbreviated listing:
At the top level, a ``metadata-revs`` file exists that lists the
@@ -7353,7 +7353,7 @@ The files produced for each image are as follows:
- ``image-files:`` A directory containing selected files from the root
filesystem. The files are defined by
- ```BUILDHISTORY_IMAGE_FILES`` <&YOCTO_DOCS_REF_URL;#var-BUILDHISTORY_IMAGE_FILES>`__.
+ :term:`BUILDHISTORY_IMAGE_FILES`.
- ``build-id.txt:`` Human-readable information about the build
configuration and metadata source revisions. This file contains the
@@ -7411,7 +7411,7 @@ following to your ``conf/local.conf`` file found in the `Build
Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__: INHERIT +=
"buildhistory" BUILDHISTORY_COMMIT = "0" BUILDHISTORY_FEATURES = "image"
Here, you set the
-```BUILDHISTORY_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-BUILDHISTORY_FEATURES>`__
+:term:`BUILDHISTORY_FEATURES`
variable to use the image feature only.
Build History SDK Information
@@ -7491,7 +7491,7 @@ You can examine build history output from the command line or from a web
interface.
To see any changes that have occurred (assuming you have
-```BUILDHISTORY_COMMIT`` <&YOCTO_DOCS_REF_URL;#var-BUILDHISTORY_COMMIT>`__\ `` = "1"``),
+:term:`BUILDHISTORY_COMMIT`\ `` = "1"``),
you can simply use any Git command that allows you to view the history
of a repository. Here is one method: $ git log -p You need to realize,
however, that this method does show changes that are not significant
@@ -7635,7 +7635,7 @@ Once you start running the tests, the following happens:
3. A default timeout of 500 seconds occurs to allow for the boot process
to reach the login prompt. You can change the timeout period by
setting
- ```TEST_QEMUBOOT_TIMEOUT`` <&YOCTO_DOCS_REF_URL;#var-TEST_QEMUBOOT_TIMEOUT>`__
+ :term:`TEST_QEMUBOOT_TIMEOUT`
in the ``local.conf`` file.
4. Once the boot process is reached and the login prompt appears, the
@@ -7815,7 +7815,7 @@ wish to experiment with automated hardware testing, you can use the
dialog-power-control script that shows a dialog prompting you to perform
the required power action. This script requires either KDialog or Zenity
to be installed. To use this script, set the
-```TEST_POWERCONTROL_CMD`` <&YOCTO_DOCS_REF_URL;#var-TEST_POWERCONTROL_CMD>`__
+:term:`TEST_POWERCONTROL_CMD`
variable as follows: TEST_POWERCONTROL_CMD =
"${COREBASE}/scripts/contrib/dialog-power-control"
@@ -7826,9 +7826,9 @@ For test target classes requiring a serial console to interact with the
bootloader (e.g. BeagleBoneTarget, EdgeRouterTarget, and GrubTarget),
you need to specify a command to use to connect to the serial console of
the target machine by using the
-```TEST_SERIALCONTROL_CMD`` <&YOCTO_DOCS_REF_URL;#var-TEST_SERIALCONTROL_CMD>`__
+:term:`TEST_SERIALCONTROL_CMD`
variable and optionally the
-```TEST_SERIALCONTROL_EXTRA_ARGS`` <&YOCTO_DOCS_REF_URL;#var-TEST_SERIALCONTROL_EXTRA_ARGS>`__
+:term:`TEST_SERIALCONTROL_EXTRA_ARGS`
variable.
These cases could be a serial terminal program if the machine is
@@ -7855,7 +7855,7 @@ You can start the tests automatically or manually:
- *Automatically running tests:* To run the tests automatically after
the OpenEmbedded build system successfully creates an image, first
set the
- ```TESTIMAGE_AUTO`` <&YOCTO_DOCS_REF_URL;#var-TESTIMAGE_AUTO>`__
+ :term:`TESTIMAGE_AUTO`
variable to "1" in your ``local.conf`` file in the `Build
Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__: TESTIMAGE_AUTO =
"1" Next, build your image. If the image successfully builds, the
@@ -7874,7 +7874,7 @@ individual tests. Tests are usually grouped together by the area tested
(e.g tests for systemd reside in ``meta/lib/oeqa/runtime/systemd.py``).
You can add tests to any layer provided you place them in the proper
-area and you extend ```BBPATH`` <&YOCTO_DOCS_REF_URL;#var-BBPATH>`__ in
+area and you extend :term:`BBPATH` in
the ``local.conf`` file as normal. Be sure that tests reside in
``layer/lib/oeqa/runtime``.
@@ -7886,7 +7886,7 @@ the ``local.conf`` file as normal. Be sure that tests reside in
.
You can change the set of tests run by appending or overriding
-```TEST_SUITES`` <&YOCTO_DOCS_REF_URL;#var-TEST_SUITES>`__ variable in
+:term:`TEST_SUITES` variable in
``local.conf``. Each name in ``TEST_SUITES`` represents a required test
for the image. Test modules named within ``TEST_SUITES`` cannot be
skipped even if a test is not suitable for an image (e.g. running the
@@ -7927,7 +7927,7 @@ Exporting Tests
You can export tests so that they can run independently of the build
system. Exporting tests is required if you want to be able to hand the
test execution off to a scheduler. You can only export tests that are
-defined in ```TEST_SUITES`` <&YOCTO_DOCS_REF_URL;#var-TEST_SUITES>`__.
+defined in :term:`TEST_SUITES`.
If your image is already built, make sure the following are set in your
``local.conf`` file: INHERIT +="testexport" TEST_TARGET_IP =
@@ -7958,7 +7958,7 @@ As mentioned previously, all new test files need to be in the proper
place for the build system to find them. New tests for additional
functionality outside of the core should be added to the layer that adds
the functionality, in ``layer/lib/oeqa/runtime`` (as long as
-```BBPATH`` <&YOCTO_DOCS_REF_URL;#var-BBPATH>`__ is extended in the
+:term:`BBPATH` is extended in the
layer's ``layer.conf`` file as normal). Just remember the following:
- Filenames need to map directly to test (module) names.
@@ -7998,8 +7998,8 @@ Class methods are as follows:
is generated during the ``do_rootfs`` task.
- *``hasFeature(feature)``:* Returns "True" if the feature is in
- ```IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES>`__ or
- ```DISTRO_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES>`__.
+ :term:`IMAGE_FEATURES` or
+ :term:`DISTRO_FEATURES`.
.. _qemu-image-writing-tests-class-attributes:
@@ -8147,7 +8147,7 @@ section:
- "`Viewing Package Information with
``oe-pkgdata-util`` <#viewing-package-information-with-oe-pkgdata-util>`__"
describes how to use the ``oe-pkgdata-util`` utility to query
- ```PKGDATA_DIR`` <&YOCTO_DOCS_REF_URL;#var-PKGDATA_DIR>`__ and
+ :term:`PKGDATA_DIR` and
display package-related information for built packages.
- "`Viewing Dependencies Between Recipes and
@@ -8203,12 +8203,12 @@ Viewing Logs from Failed Tasks
------------------------------
You can find the log for a task in the file
-``${``\ ```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__\ ``}/temp/log.do_``\ taskname.
+``${``\ :term:`WORKDIR`\ ``}/temp/log.do_``\ taskname.
For example, the log for the
-```do_compile`` <&YOCTO_DOCS_REF_URL;#ref-tasks-compile>`__ task of the
+:ref:`ref-tasks-compile` task of the
QEMU minimal image for the x86 machine (``qemux86``) might be in
``tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/temp/log.do_compile``.
-To see the commands `BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__ ran
+To see the commands :term:`BitBake` ran
to generate a log, look at the corresponding ``run.do_``\ taskname file
in the same directory.
@@ -8269,7 +8269,7 @@ In addition to variable values, the output of the ``bitbake -e`` and
system (including the behavior of the `normal recipe build
tasks <&YOCTO_DOCS_REF_URL;#normal-recipe-build-tasks>`__) is
implemented in the
- ```base`` <&YOCTO_DOCS_REF_URL;#ref-classes-base>`__ class and the
+ :ref:`base ` class and the
classes it inherits, rather than being built into BitBake itself.
- After the variable values, all functions appear in the output. For
@@ -8282,7 +8282,7 @@ Viewing Package Information with ``oe-pkgdata-util``
----------------------------------------------------
You can use the ``oe-pkgdata-util`` command-line utility to query
-```PKGDATA_DIR`` <&YOCTO_DOCS_REF_URL;#var-PKGDATA_DIR>`__ and display
+:term:`PKGDATA_DIR` and display
various package-related information. When you use the utility, you must
use it to view information on packages that have already been built.
@@ -8304,10 +8304,10 @@ Following are a few of the available ``oe-pkgdata-util`` subcommands.
A different way to view the contents of a package is to look at
the
- ``${``\ ```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__\ ``}/packages-split``
+ ``${``\ :term:`WORKDIR`\ ``}/packages-split``
directory of the recipe that generates the package. This directory
is created by the
- ```do_package`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package>`__ task
+ :ref:`ref-tasks-package` task
and has one subdirectory for each package the recipe generates,
which contains the files stored in that package.
@@ -8346,7 +8346,7 @@ in the current directory:
recipename. "Involved" here means that at least one task from the
recipe needs to run when building recipename from scratch. Targets
that are in
- ```ASSUME_PROVIDED`` <&YOCTO_DOCS_REF_URL;#var-ASSUME_PROVIDED>`__
+ :term:`ASSUME_PROVIDED`
are not listed.
- ``task-depends.dot``: A graph showing dependencies between tasks.
@@ -8369,11 +8369,11 @@ format and can be converted to images (e.g. using the ``dot`` tool from
as the following: "libxslt.do_configure" ->
"libxml2.do_populate_sysroot" The above example line reveals that
the
- ```do_configure`` <&YOCTO_DOCS_REF_URL;#ref-tasks-configure>`__
+ :ref:`ref-tasks-configure`
task in ``libxslt`` depends on the
- ```do_populate_sysroot`` <&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sysroot>`__
+ :ref:`ref-tasks-populate_sysroot`
task in ``libxml2``, which is a normal
- ```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__ dependency
+ :term:`DEPENDS` dependency
between the two recipes.
- For an example of how ``.dot`` files can be processed, see the
@@ -8407,19 +8407,19 @@ BitBake has determined by doing the following:
1. Build the recipe containing the task: $ bitbake recipename
-2. Inside the ```STAMPS_DIR`` <&YOCTO_DOCS_REF_URL;#var-STAMPS_DIR>`__
+2. Inside the :term:`STAMPS_DIR`
directory, find the signature data (``sigdata``) file that
corresponds to the task. The ``sigdata`` files contain a pickled
Python database of all the metadata that went into creating the input
checksum for the task. As an example, for the
- ```do_fetch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-fetch>`__ task of the
+ :ref:`ref-tasks-fetch` task of the
``db`` recipe, the ``sigdata`` file might be found in the following
location:
${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1
For tasks that are accelerated through the shared state
(`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) cache, an
additional ``siginfo`` file is written into
- ```SSTATE_DIR`` <&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR>`__ along with
+ :term:`SSTATE_DIR` along with
the cached task output. The ``siginfo`` files contain exactly the
same information as ``sigdata`` files.
@@ -8475,7 +8475,7 @@ Viewing Metadata Used to Create the Input Signature of a Shared State Task
Seeing what metadata went into creating the input signature of a shared
state (sstate) task can be a useful debugging aid. This information is
available in signature information (``siginfo``) files in
-```SSTATE_DIR`` <&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR>`__. For
+:term:`SSTATE_DIR`. For
information on how to view and interpret information in ``siginfo``
files, see the "`Viewing Task Variable
Dependencies <#dev-viewing-task-variable-dependencies>`__" section.
@@ -8521,7 +8521,7 @@ invalidate the cache and force the tasks to run. The steps you can take
are as simple as changing a function's comments in the source code. For
example, to invalidate package shared state files, change the comment
statements of
-```do_package`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package>`__ or the
+:ref:`ref-tasks-package` or the
comments of one of the functions it calls. Even though the change is
purely cosmetic, it causes the checksum to be recalculated and forces
the build system to run the task again.
@@ -8559,7 +8559,7 @@ BitBake determines whether a task is "out of date".
If you want to force an up-to-date task to be rerun (e.g. because you
made manual modifications to the recipe's
-```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__ that you want to try
+:term:`WORKDIR` that you want to try
out), then you can use the ``-f`` option.
.. note::
@@ -8595,7 +8595,7 @@ it is to use the ``-C`` option.
option, which is lower-cased.
Using this option invalidates the given task and then runs the
-```do_build`` <&YOCTO_DOCS_REF_URL;#ref-tasks-build>`__ task, which is
+:ref:`ref-tasks-build` task, which is
the default task if no task is given, and the tasks on which it depends.
You could replace the final two commands in the previous example with
the following single command: $ bitbake matchbox-desktop -C compile
@@ -8702,7 +8702,7 @@ log to ``${T}/log.do_``\ task, and can also log to standard output
The same logging functions are also available in shell functions, under
the names ``bbplain``, ``bbnote``, ``bbdebug``, ``bbwarn``, ``bberror``,
and ``bbfatal``. The
-```logging`` <&YOCTO_DOCS_REF_URL;#ref-classes-logging>`__ class
+:ref:`logging ` class
implements these functions. See that class in the ``meta/classes``
folder of the `Source
Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ for information.
@@ -8717,7 +8717,7 @@ in the log, use the "debug" loglevel.
Following is an example written in Python. The code handles logging for
a function that determines the number of tasks needed to be run. See the
-"```do_listtasks`` <&YOCTO_DOCS_REF_URL;#ref-tasks-listtasks>`__"
+":ref:`ref-tasks-listtasks`"
section for additional information: python do_listtasks() { bb.debug(2,
"Starting to figure out the task list") if noteworthy_condition:
bb.note("There are 47 tasks to run") bb.debug(2, "Got to point xyz") if
@@ -8851,7 +8851,7 @@ exists. Thus, once the error surfaces, you need a way to reproduce it.
In this example, compiling the "neard" package is causing the problem.
So the first thing to do is build "neard" locally. Before you start the
build, set the
-```PARALLEL_MAKE`` <&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE>`__ variable
+:term:`PARALLEL_MAKE` variable
in your ``local.conf`` file to a high number (e.g. "-j 20"). Using a
high value for ``PARALLEL_MAKE`` increases the chances of the race
condition showing up: $ bitbake neard
@@ -8895,7 +8895,7 @@ Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ named ``poky``: $
cp patches/parallelmake.patch poky/meta/recipes-connectivity/neard/neard
The final thing you need to do to implement the fix in the build is to
update the "neard" recipe (i.e. ``neard-0.14.bb``) so that the
-```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ statement includes
+:term:`SRC_URI` statement includes
the patch file. The recipe file is in the folder above the patch. Here
is what the edited ``SRC_URI`` statement would look like: SRC_URI =
"${KERNELORG_MIRROR}/linux/network/nfc/${BPN}-${PV}.tar.xz \\
@@ -8930,7 +8930,7 @@ GDB allows you to examine running programs, which in turn helps you to
understand and fix problems. It also allows you to perform post-mortem
style analysis of program crashes. GDB is available as a package within
the Yocto Project and is installed in SDK images by default. See the
-"`Images <&YOCTO_DOCS_REF_URL;#ref-images>`__" chapter in the Yocto
+":ref:`ref-manual/ref-images:Images`" chapter in the Yocto
Project Reference Manual for a description of these images. You can find
information on GDB at ` `__.
@@ -9114,10 +9114,10 @@ debug on the target hardware.
To support this kind of debugging, you need do the following:
- Ensure that GDB is on the target. You can do this by adding "gdb" to
- ```IMAGE_INSTALL`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL>`__:
+ :term:`IMAGE_INSTALL`:
IMAGE_INSTALL_append = " gdb" Alternatively, you can add
"tools-debug" to
- ```IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES>`__:
+ :term:`IMAGE_FEATURES`:
IMAGE_FEATURES_append = " tools-debug"
- Ensure that debug symbols are present. You can make sure these
@@ -9162,12 +9162,12 @@ Here are some other tips that you might find useful:
is also possible to switch out of the splashscreen by switching the
virtual console (e.g. Fn+Left or Fn+Right on a Zaurus).
-- Removing ```TMPDIR`` <&YOCTO_DOCS_REF_URL;#var-TMPDIR>`__ (usually
+- Removing :term:`TMPDIR` (usually
``tmp/``, within the `Build
Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__) can often fix
temporary build issues. Removing ``TMPDIR`` is usually a relatively
cheap operation, because task output will be cached in
- ```SSTATE_DIR`` <&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR>`__ (usually
+ :term:`SSTATE_DIR` (usually
``sstate-cache/``, which is also in the Build Directory).
.. note::
@@ -9654,7 +9654,7 @@ Tracking License Changes
The license of an upstream project might change in the future. In order
to prevent these changes going unnoticed, the
-```LIC_FILES_CHKSUM`` <&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM>`__
+:term:`LIC_FILES_CHKSUM`
variable tracks changes to the license text. The checksums are validated
at the end of the configure step, and if the checksums do not match, the
build will fail.
@@ -9682,7 +9682,7 @@ file://licfile2.txt;endline=50;md5=zzzz \\ ..."
as part of the QA message. Using this output, you can determine
the exact start and finish for the needed license text.
-The build system uses the ```S`` <&YOCTO_DOCS_REF_URL;#var-S>`__
+The build system uses the :term:`S`
variable as the default directory when searching files listed in
``LIC_FILES_CHKSUM``. The previous example employs the default
directory.
@@ -9694,7 +9694,7 @@ md5=bb14ed3c4cda583abc85401304b5cd4e" LIC_FILES_CHKSUM =
The first line locates a file in ``${S}/src/ls.c`` and isolates lines
five through 16 as license text. The second line refers to a file in
-```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__.
+:term:`WORKDIR`.
Note that ``LIC_FILES_CHKSUM`` variable is mandatory for all recipes,
unless the ``LICENSE`` variable is set to "CLOSED".
@@ -9733,7 +9733,7 @@ long as it is kept up to date.
.. note::
- If you specify an empty or invalid "md5" parameter,
- `BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__ returns an md5
+ :term:`BitBake` returns an md5
mis-match error and displays the correct "md5" parameter value
during the build. The correct parameter is also captured in the
build log.
@@ -9747,7 +9747,7 @@ Enabling Commercially Licensed Recipes
By default, the OpenEmbedded build system disables components that have
commercial or other special licensing requirements. Such requirements
are defined on a recipe-by-recipe basis through the
-```LICENSE_FLAGS`` <&YOCTO_DOCS_REF_URL;#var-LICENSE_FLAGS>`__ variable
+:term:`LICENSE_FLAGS` variable
definition in the affected recipe. For instance, the
``poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly`` recipe
contains the following statement: LICENSE_FLAGS = "commercial" Here is a
@@ -9756,7 +9756,7 @@ name and version (after variable expansion): LICENSE_FLAGS =
"license_${PN}_${PV}" In order for a component restricted by a
``LICENSE_FLAGS`` definition to be enabled and included in an image, it
needs to have a matching entry in the global
-```LICENSE_FLAGS_WHITELIST`` <&YOCTO_DOCS_REF_URL;#var-LICENSE_FLAGS_WHITELIST>`__
+:term:`LICENSE_FLAGS_WHITELIST`
variable, which is a variable typically defined in your ``local.conf``
file. For example, to enable the
``poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly`` package, you
@@ -9930,14 +9930,14 @@ for most compliance groups - providing the source. The Yocto Project has
a few ways of meeting this requirement.
One of the easiest ways to meet this requirement is to provide the
-entire ```DL_DIR`` <&YOCTO_DOCS_REF_URL;#var-DL_DIR>`__ used by the
+entire :term:`DL_DIR` used by the
build. This method, however, has a few issues. The most obvious is the
size of the directory since it includes all sources used in the build
and not just the source used in the released image. It will include
toolchain source, and other artifacts, which you would not generally
release. However, the more serious issue for most companies is
accidental release of proprietary software. The Yocto Project provides
-an ```archiver`` <&YOCTO_DOCS_REF_URL;#ref-classes-archiver>`__ class to
+an :ref:`archiver ` class to
help avoid some of these concerns.
Before you employ ``DL_DIR`` or the ``archiver`` class, you need to
@@ -9952,7 +9952,7 @@ Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__: INHERIT +=
"archiver" ARCHIVER_MODE[src] = "original" During the creation of your
image, the source from all recipes that deploy packages to the image is
placed within subdirectories of ``DEPLOY_DIR/sources`` based on the
-```LICENSE`` <&YOCTO_DOCS_REF_URL;#var-LICENSE>`__ for each recipe.
+:term:`LICENSE` for each recipe.
Releasing the entire directory enables you to comply with requirements
concerning providing the unmodified source. It is important to note that
the size of the directory can get large.
@@ -9997,11 +9997,11 @@ generation are included on your image.
``/usr/share/license``.
The reason for this behavior is because
- ```COPY_LIC_DIRS`` <&YOCTO_DOCS_REF_URL;#var-COPY_LIC_DIRS>`__ and
- ```COPY_LIC_MANIFEST`` <&YOCTO_DOCS_REF_URL;#var-COPY_LIC_MANIFEST>`__
+ :term:`COPY_LIC_DIRS` and
+ :term:`COPY_LIC_MANIFEST`
add a copy of the license when the image is built but do not offer a
path for adding licenses for newly installed packages to an image.
- ```LICENSE_CREATE_PACKAGE`` <&YOCTO_DOCS_REF_URL;#var-LICENSE_CREATE_PACKAGE>`__
+ :term:`LICENSE_CREATE_PACKAGE`
adds a separate package and an upgrade path for adding licenses to an
image.
@@ -10043,7 +10043,7 @@ is increased each time build/conf/bblayers.conf # changes incompatibly
POKY_BBLAYERS_CONF_VERSION = "2" BBPATH = "${TOPDIR}" BBFILES ?= ""
BBLAYERS ?= " \\ ##OEROOT##/meta \\ ##OEROOT##/meta-poky \\
##OEROOT##/meta-yocto-bsp \\ ##OEROOT##/meta-mylayer \\ " Creating and
-providing an archive of the `Metadata <&YOCTO_DOCS_REF_URL;#metadata>`__
+providing an archive of the :term:`Metadata`
layers (recipes, configuration files, and so forth) enables you to meet
your requirements to include the scripts to control compilation as well
as any modifications to the original source.
@@ -10055,7 +10055,7 @@ Some packages, such as the linux-firmware package, have many licenses
that are not in any way common. You can avoid adding a lot of these
types of common license files, which are only applicable to a specific
package, by using the
-```NO_GENERIC_LICENSE`` <&YOCTO_DOCS_REF_URL;#var-NO_GENERIC_LICENSE>`__
+:term:`NO_GENERIC_LICENSE`
variable. Using this variable also avoids QA errors when you use a
non-common, non-CLOSED license in a recipe.
@@ -10091,14 +10091,14 @@ Enabling and Using the Tool
By default, the error reporting tool is disabled. You can enable it by
inheriting the
-```report-error`` <&YOCTO_DOCS_REF_URL;#ref-classes-report-error>`__
+:ref:`report-error `
class by adding the following statement to the end of your
``local.conf`` file in your `Build
Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__. INHERIT +=
"report-error"
By default, the error reporting feature stores information in
-``${``\ ```LOG_DIR`` <&YOCTO_DOCS_REF_URL;#var-LOG_DIR>`__\ ``}/error-report``.
+``${``\ :term:`LOG_DIR`\ ``}/error-report``.
However, you can specify a directory to use by adding the following to
your ``local.conf`` file: ERR_REPORT_DIR = "path" Enabling error
reporting causes the build process to collect the errors and store them
@@ -10127,7 +10127,7 @@ Disabling the Tool
To disable the error reporting feature, simply remove or comment out the
following statement from the end of your ``local.conf`` file in your
-`Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__. INHERIT +=
+:term:`Build Directory`. INHERIT +=
"report-error"
Setting Up Your Own Error Reporting Server
@@ -10191,7 +10191,7 @@ To cause Mesa to build the ``wayland-egl`` platform and Weston to build
Wayland with Kernel Mode Setting
(`KMS `__)
support, include the "wayland" flag in the
-```DISTRO_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES>`__
+:term:`DISTRO_FEATURES`
statement in your ``local.conf`` file: DISTRO_FEATURES_append = "
wayland"
@@ -10207,7 +10207,7 @@ Installing
To install the Wayland feature into an image, you must include the
following
-```CORE_IMAGE_EXTRA_INSTALL`` <&YOCTO_DOCS_REF_URL;#var-CORE_IMAGE_EXTRA_INSTALL>`__
+:term:`CORE_IMAGE_EXTRA_INSTALL`
statement in your ``local.conf`` file: CORE_IMAGE_EXTRA_INSTALL +=
"wayland weston"
diff --git a/documentation/dev-manual/dev-manual-qemu.rst b/documentation/dev-manual/dev-manual-qemu.rst
index 9bae9eaa68..653f90573e 100644
--- a/documentation/dev-manual/dev-manual-qemu.rst
+++ b/documentation/dev-manual/dev-manual-qemu.rst
@@ -75,7 +75,7 @@ available. Follow these general steps to run QEMU:
- If you have previously built an image for QEMU (e.g. ``qemux86``,
``qemuarm``, and so forth), then the artifacts are in place in
- your `Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__.
+ your :term:`Build Directory`.
- If you have not built an image, you can go to the
`machines/qemu <&YOCTO_MACHINES_DL_URL;>`__ area and download a
diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/dev-manual-start.rst
index 2dd426b29f..fadc0bff3e 100644
--- a/documentation/dev-manual/dev-manual-start.rst
+++ b/documentation/dev-manual/dev-manual-start.rst
@@ -75,7 +75,7 @@ particular working environment and set of practices.
development environment.
4. *Use Git as Your Source Control Manager (SCM):* Keeping your
- `Metadata <&YOCTO_DOCS_REF_URL;#metadata>`__ (i.e. recipes,
+ :term:`Metadata` (i.e. recipes,
configuration files, classes, and so forth) and any software you are
developing under the control of an SCM system that is compatible
with the OpenEmbedded build system is advisable. Of all of the SCMs
@@ -248,7 +248,7 @@ particular working environment and set of practices.
for related upstream Yocto Project Git repositories.
- Set up the directory for the shared state cache
- (```SSTATE_DIR`` <&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR>`__) where
+ (:term:`SSTATE_DIR`) where
it makes sense. For example, set up the sstate cache on a system
used by developers in the same organization and share the same
source directories on their machines.
diff --git a/documentation/kernel-dev/kernel-dev-advanced.rst b/documentation/kernel-dev/kernel-dev-advanced.rst
index 90323d3e2a..36a34ca28c 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.rst
+++ b/documentation/kernel-dev/kernel-dev-advanced.rst
@@ -11,7 +11,7 @@ Overview
In addition to supporting configuration fragments and patches, the Yocto
Project kernel tools also support rich
-`Metadata <&YOCTO_DOCS_REF_URL;#metadata>`__ that you can use to define
+:term:`Metadata` that you can use to define
complex policies and Board Support Package (BSP) support. The purpose of
the Metadata and the tools that manage it is to help you manage the
complexity of the configuration and sources used to support multiple
@@ -27,7 +27,7 @@ Kernel development tools ("kern-tools") exist also in the Yocto Project
Source Repositories under the "Yocto Linux Kernel" heading in the
``yocto-kernel-tools`` Git repository. The recipe that builds these
tools is ``meta/recipes-kernel/kern-tools/kern-tools-native_git.bb`` in
-the `Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ (e.g.
+the :term:`Source Directory` (e.g.
``poky``).
Using Kernel Metadata in a Recipe
@@ -49,9 +49,9 @@ linux-yocto recipe.
file) is said to be a "linux-yocto style" recipe.
Every linux-yocto style recipe must define the
-```KMACHINE`` <&YOCTO_DOCS_REF_URL;#var-KMACHINE>`__ variable. This
+:term:`KMACHINE` variable. This
variable is typically set to the same value as the ``MACHINE`` variable,
-which is used by `BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__.
+which is used by :term:`BitBake`.
However, in some cases, the variable might instead refer to the
underlying platform of the ``MACHINE``.
@@ -65,7 +65,7 @@ Descriptions <#bsp-descriptions>`__ section for more information.
Every linux-yocto style recipe must also indicate the Linux kernel
source repository branch used to build the Linux kernel. The
-```KBRANCH`` <&YOCTO_DOCS_REF_URL;#var-KBRANCH>`__ variable must be set
+:term:`KBRANCH` variable must be set
to indicate the branch.
.. note::
@@ -84,7 +84,7 @@ to indicate the branch.
The linux-yocto style recipes can optionally define the following
variables: KERNEL_FEATURES LINUX_KERNEL_TYPE
-```LINUX_KERNEL_TYPE`` <&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE>`__
+:term:`LINUX_KERNEL_TYPE`
defines the kernel type to be used in assembling the configuration. If
you do not specify a ``LINUX_KERNEL_TYPE``, it defaults to "standard".
Together with ``KMACHINE``, ``LINUX_KERNEL_TYPE`` defines the search
@@ -103,10 +103,10 @@ a match, they issue a warning.
The tools first search for the ``KMACHINE`` and then for the
``LINUX_KERNEL_TYPE``. If the tools cannot find a partial match, they
will use the sources from the ``KBRANCH`` and any configuration
-specified in the ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__.
+specified in the :term:`SRC_URI`.
You can use the
-```KERNEL_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES>`__
+:term:`KERNEL_FEATURES`
variable to include features (configuration fragments, patches, or both)
that are not already included by the ``KMACHINE`` and
``LINUX_KERNEL_TYPE`` variable combination. For example, to include a
@@ -185,7 +185,7 @@ contain "features" as far as the kernel tools are concerned.
Paths used in kernel Metadata files are relative to base, which is
either
-```FILESEXTRAPATHS`` <&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS>`__ if
+:term:`FILESEXTRAPATHS` if
you are creating Metadata in `recipe-space <#recipe-space-metadata>`__,
or the top level of
```yocto-kernel-cache`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache/tree/>`__
@@ -218,7 +218,7 @@ fragment files in the "`Creating Configuration
Fragments <#creating-config-fragments>`__" section.
Within the ``smp.scc`` file, the
-```KFEATURE_DESCRIPTION`` <&YOCTO_DOCS_REF_URL;#var-KFEATURE_DESCRIPTION>`__
+:term:`KFEATURE_DESCRIPTION`
statement provides a short description of the fragment. Higher level
kernel tools use this description.
@@ -312,7 +312,7 @@ non-hardware configuration fragments with patches you want to use when
building a Linux kernel of a specific type (e.g. a real-time kernel).
Syntactically, kernel types are no different than features as described
in the "`Features <#features>`__" section. The
-```LINUX_KERNEL_TYPE`` <&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE>`__
+:term:`LINUX_KERNEL_TYPE`
variable in the kernel recipe selects the kernel type. For example, in
the ``linux-yocto_4.12.bb`` kernel recipe found in
``poky/meta/recipes-kernel/linux``, a
@@ -432,9 +432,9 @@ ktypes/standard/standard.scc branch beaglebone include beaglebone.scc #
default policy for standard kernels include
features/latencytop/latencytop.scc include
features/profiling/profiling.scc Every top-level BSP description file
-should define the ```KMACHINE`` <&YOCTO_DOCS_REF_URL;#var-KMACHINE>`__,
-```KTYPE`` <&YOCTO_DOCS_REF_URL;#var-KTYPE>`__, and
-```KARCH`` <&YOCTO_DOCS_REF_URL;#var-KARCH>`__ variables. These
+should define the :term:`KMACHINE`,
+:term:`KTYPE`, and
+:term:`KARCH` variables. These
variables allow the OpenEmbedded build system to identify the
description as meeting the criteria set by the recipe being built. This
example supports the "beaglebone" machine for the "standard" kernel and
@@ -444,7 +444,7 @@ Be aware that a hard link between the ``KTYPE`` variable and a kernel
type description file does not exist. Thus, if you do not have the
kernel type defined in your kernel Metadata as it is here, you only need
to ensure that the
-```LINUX_KERNEL_TYPE`` <&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE>`__
+:term:`LINUX_KERNEL_TYPE`
variable in the kernel recipe and the ``KTYPE`` variable in the BSP
description file match.
@@ -529,9 +529,9 @@ with the most basic functionality of the system as defined in the base
"minnow" description file.
Notice again the three critical variables:
-```KMACHINE`` <&YOCTO_DOCS_REF_URL;#var-KMACHINE>`__,
-```KTYPE`` <&YOCTO_DOCS_REF_URL;#var-KTYPE>`__, and
-```KARCH`` <&YOCTO_DOCS_REF_URL;#var-KARCH>`__. Of these variables, only
+:term:`KMACHINE`,
+:term:`KTYPE`, and
+:term:`KARCH`. Of these variables, only
``KTYPE`` has changed to specify the "tiny" kernel type.
Kernel Metadata Location
@@ -564,12 +564,12 @@ Recipe-Space Metadata
When stored in recipe-space, the kernel Metadata files reside in a
directory hierarchy below
-```FILESEXTRAPATHS`` <&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS>`__. For
+:term:`FILESEXTRAPATHS`. For
a linux-yocto recipe or for a Linux kernel recipe derived by copying and
modifying
``oe-core/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb`` to
a recipe in your layer, ``FILESEXTRAPATHS`` is typically set to
-``${``\ ```THISDIR`` <&YOCTO_DOCS_REF_URL;#var-THISDIR>`__\ ``}/${``\ ```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__\ ``}``.
+``${``\ :term:`THISDIR`\ ``}/${``\ :term:`PN`\ ``}``.
See the "`Modifying an Existing
Recipe <#modifying-an-existing-recipe>`__" section for more information.
@@ -582,10 +582,10 @@ When the Metadata is stored in recipe-space, you must take steps to
ensure BitBake has the necessary information to decide what files to
fetch and when they need to be fetched again. It is only necessary to
specify the ``.scc`` files on the
-```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__. BitBake parses them
+:term:`SRC_URI`. BitBake parses them
and fetches any files referenced in the ``.scc`` files by the
``include``, ``patch``, or ``kconf`` commands. Because of this, it is
-necessary to bump the recipe ```PR`` <&YOCTO_DOCS_REF_URL;#var-PR>`__
+necessary to bump the recipe :term:`PR`
value when changing the content of files not explicitly listed in the
``SRC_URI``.
@@ -600,7 +600,7 @@ Metadata Outside the Recipe-Space
When stored outside of the recipe-space, the kernel Metadata files
reside in a separate repository. The OpenEmbedded build system adds the
Metadata to the build as a "type=kmeta" repository through the
-```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ variable. As an
+:term:`SRC_URI` variable. As an
example, consider the following ``SRC_URI`` statement from the
``linux-yocto_4.12.bb`` kernel recipe: SRC_URI =
"git://git.yoctoproject.org/linux-yocto-4.12.git;name=machine;branch=${KBRANCH};
@@ -742,10 +742,10 @@ within an SCC description file (``.scc``):
"ref" if specified.
- ``define``: Defines variables, such as
- ```KMACHINE`` <&YOCTO_DOCS_REF_URL;#var-KMACHINE>`__,
- ```KTYPE`` <&YOCTO_DOCS_REF_URL;#var-KTYPE>`__,
- ```KARCH`` <&YOCTO_DOCS_REF_URL;#var-KARCH>`__, and
- ```KFEATURE_DESCRIPTION`` <&YOCTO_DOCS_REF_URL;#var-KFEATURE_DESCRIPTION>`__.
+ :term:`KMACHINE`,
+ :term:`KTYPE`,
+ :term:`KARCH`, and
+ :term:`KFEATURE_DESCRIPTION`.
- ``include SCC_FILE``: Includes an SCC file in the current file. The
file is parsed as if you had inserted it inline.
diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/kernel-dev-common.rst
index 085c6d396c..b5f794e733 100644
--- a/documentation/kernel-dev/kernel-dev-common.rst
+++ b/documentation/kernel-dev/kernel-dev-common.rst
@@ -72,7 +72,7 @@ section:
"poky".
2. *Prepare Your ``local.conf`` File:* By default, the
- ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ variable is set to
+ :term:`MACHINE` variable is set to
"qemux86-64", which is fine if you are building for the QEMU emulator
in 64-bit mode. However, if you are not, you need to set the
``MACHINE`` variable appropriately in your ``conf/local.conf`` file
@@ -82,7 +82,7 @@ section:
Also, since you are preparing to work on the kernel image, you need
to set the
- ```MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS>`__
+ :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`
variable to include kernel modules.
In this example we wish to build for qemux86 so we must set the
@@ -115,7 +115,7 @@ section:
4. *Inform the BitBake Build Environment About Your Layer:* As directed
when you created your layer, you need to add the layer to the
- ```BBLAYERS`` <&YOCTO_DOCS_REF_URL;#var-BBLAYERS>`__ variable in the
+ :term:`BBLAYERS` variable in the
``bblayers.conf`` file as follows: $ cd ~/poky/build $ bitbake-layers
add-layer ../../meta-mylayer NOTE: Starting bitbake server... $
@@ -236,7 +236,7 @@ section:
"poky".
2. *Prepare Your ``local.conf`` File:* By default, the
- ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ variable is set to
+ :term:`MACHINE` variable is set to
"qemux86-64", which is fine if you are building for the QEMU emulator
in 64-bit mode. However, if you are not, you need to set the
``MACHINE`` variable appropriately in your ``conf/local.conf`` file
@@ -246,7 +246,7 @@ section:
Also, since you are preparing to work on the kernel image, you need
to set the
- ```MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS>`__
+ :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`
variable to include kernel modules.
In this example we wish to build for qemux86 so we must set the
@@ -279,7 +279,7 @@ section:
4. *Inform the BitBake Build Environment About Your Layer:* As directed
when you created your layer, you need to add the layer to the
- ```BBLAYERS`` <&YOCTO_DOCS_REF_URL;#var-BBLAYERS>`__ variable in the
+ :term:`BBLAYERS` variable in the
``bblayers.conf`` file as follows: $ cd ~/poky/build $ bitbake-layers
add-layer ../../meta-mylayer NOTE: Starting bitbake server ... $
@@ -343,7 +343,7 @@ Creating and Preparing a Layer
If you are going to be modifying kernel recipes, it is recommended that
you create and prepare your own layer in which to do your work. Your
-layer contains its own `BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__
+layer contains its own :term:`BitBake`
append files (``.bbappend``) and provides a convenient mechanism to
create your own recipe files (``.bb``) as well as store and use kernel
patch files. For background information on working with layers, see the
@@ -393,8 +393,8 @@ home directory:
"${THISDIR}/${PN}:" SRC_URI_append = " file://patch-file-one"
SRC_URI_append = " file://patch-file-two" SRC_URI_append = "
file://patch-file-three" The
- ```FILESEXTRAPATHS`` <&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS>`__
- and ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ statements
+ :term:`FILESEXTRAPATHS`
+ and :term:`SRC_URI` statements
enable the OpenEmbedded build system to find patch files. For more
information on using append files, see the "`Using .bbappend Files in
Your Layer <&YOCTO_DOCS_DEV_URL;#using-bbappend-files>`__" section in
@@ -406,7 +406,7 @@ Modifying an Existing Recipe
In many cases, you can customize an existing linux-yocto recipe to meet
the needs of your project. Each release of the Yocto Project provides a
few Linux kernel recipes from which you can choose. These are located in
-the `Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ in
+the :term:`Source Directory` in
``meta/recipes-kernel/linux``.
Modifying an existing recipe can consist of the following:
@@ -431,12 +431,12 @@ modifying the ``meta/recipes-kernel/linux/linux-yocto_4.12.bb`` recipe,
the append file will typically be located as follows within your custom
layer: your-layer/recipes-kernel/linux/linux-yocto_4.12.bbappend The
append file should initially extend the
-```FILESPATH`` <&YOCTO_DOCS_REF_URL;#var-FILESPATH>`__ search path by
+:term:`FILESPATH` search path by
prepending the directory that contains your files to the
-```FILESEXTRAPATHS`` <&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS>`__
+:term:`FILESEXTRAPATHS`
variable as follows: FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" The
path
-``${``\ ```THISDIR`` <&YOCTO_DOCS_REF_URL;#var-THISDIR>`__\ ``}/${``\ ```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__\ ``}``
+``${``\ :term:`THISDIR`\ ``}/${``\ :term:`PN`\ ``}``
expands to "linux-yocto" in the current directory for this example. If
you add any new files that modify the kernel recipe and you have
extended ``FILESPATH`` as described above, you must place the files in
@@ -472,16 +472,16 @@ COMPATIBLE_MACHINE_beaglebone = "beaglebone" LINUX_VERSION_genericx86 =
= "4.12.10" LINUX_VERSION_beaglebone = "4.12.10" This append file
contains statements used to support several BSPs that ship with the
Yocto Project. The file defines machines using the
-```COMPATIBLE_MACHINE`` <&YOCTO_DOCS_REF_URL;#var-COMPATIBLE_MACHINE>`__
+:term:`COMPATIBLE_MACHINE`
variable and uses the
-```KMACHINE`` <&YOCTO_DOCS_REF_URL;#var-KMACHINE>`__ variable to ensure
+:term:`KMACHINE` variable to ensure
the machine name used by the OpenEmbedded build system maps to the
machine name used by the Linux Yocto kernel. The file also uses the
-optional ```KBRANCH`` <&YOCTO_DOCS_REF_URL;#var-KBRANCH>`__ variable to
+optional :term:`KBRANCH` variable to
ensure the build process uses the appropriate kernel branch.
Although this particular example does not use it, the
-```KERNEL_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES>`__
+:term:`KERNEL_FEATURES`
variable could be used to enable features specific to the kernel. The
append file points to specific commits in the `Source
Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ Git repository and
@@ -497,7 +497,7 @@ accomplish this definition by putting the configurations in a file or a
set of files inside a directory located at the same level as your
kernel's append file and having the same name as the kernel's main
recipe file. With all these conditions met, simply reference those files
-in the ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ statement in
+in the :term:`SRC_URI` statement in
the append file.
For example, suppose you had some configuration options in a file called
@@ -515,7 +515,7 @@ the following in your append file: SRC_URI += "file://myconfig.cfg \\
file://eth.cfg \\ file://gfx.cfg"
Another variable you can use in your kernel recipe append file is the
-```FILESEXTRAPATHS`` <&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS>`__
+:term:`FILESEXTRAPATHS`
variable. When you use this statement, you are extending the locations
used by the OpenEmbedded system to look for files and patches as the
recipe is processed.
@@ -546,9 +546,9 @@ Applying Patches
If you have a single patch or a small series of patches that you want to
apply to the Linux kernel source, you can do so just as you would with
any other recipe. You first copy the patches to the path added to
-```FILESEXTRAPATHS`` <&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS>`__ in
+:term:`FILESEXTRAPATHS` in
your ``.bbappend`` file as described in the previous section, and then
-reference them in ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__
+reference them in :term:`SRC_URI`
statements.
For example, you can apply a three-patch series by adding the following
@@ -572,7 +572,7 @@ Changing the Configuration
You can make wholesale or incremental changes to the final ``.config``
file used for the eventual Linux kernel configuration by including a
``defconfig`` file and by specifying configuration fragments in the
-```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ to be applied to that
+:term:`SRC_URI` to be applied to that
file.
If you have a complete, working Linux kernel ``.config`` file you want
@@ -583,8 +583,8 @@ following lines to the linux-yocto ``.bbappend`` file in your layer:
FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" SRC_URI +=
"file://defconfig" The ``SRC_URI`` tells the build system how to search
for the file, while the
-```FILESEXTRAPATHS`` <&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS>`__
-extends the ```FILESPATH`` <&YOCTO_DOCS_REF_URL;#var-FILESPATH>`__
+:term:`FILESEXTRAPATHS`
+extends the :term:`FILESPATH`
variable (search directories) to include the ``${PN}`` directory you
created to hold the configuration changes.
@@ -631,7 +631,7 @@ looks for ``defconfig`` files in the layer used for Metadata, which is
``defconfig`` files in your layer but would rather allow users to use
the default configuration from the kernel tree and still be able to add
configuration fragments to the
-```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ through, for example,
+:term:`SRC_URI` through, for example,
append files, you can direct the OpenEmbedded build system to use a
``defconfig`` file that is "in-tree".
@@ -651,7 +651,7 @@ build system detects a statement that identifies an "out-of-tree"
``KBUILD_DEFCONFIG`` variable.
See the
-```KBUILD_DEFCONFIG`` <&YOCTO_DOCS_REF_URL;#var-KBUILD_DEFCONFIG>`__
+:term:`KBUILD_DEFCONFIG`
variable description for more information.
Using ``devtool`` to Patch the Kernel
@@ -844,8 +844,8 @@ Section.
addition to your ``local.conf`` file specifying to use
"kernel-modules" and the "qemux86" machine, it must also point to the
updated kernel source files. Add
- ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ and
- ```SRCREV`` <&YOCTO_DOCS_REF_URL;#var-SRCREV>`__ statements similar
+ :term:`SRC_URI` and
+ :term:`SRCREV` statements similar
to the following to your ``local.conf``: $ cd ~/poky/build/conf Add
the following to the ``local.conf``: SRC_URI_pn-linux-yocto =
"git:///path-to/linux-yocto-4.12;protocol=file;name=machine;branch=standard/base;
@@ -907,8 +907,8 @@ Section.
contents: FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
SRC_URI_append = "
file://0001-calibrate.c-Added-some-printk-statements.patch" The
- ```FILESEXTRAPATHS`` <&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS>`__
- and ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ statements
+ :term:`FILESEXTRAPATHS`
+ and :term:`SRC_URI` statements
enable the OpenEmbedded build system to find the patch file.
For more information on append files and patches, see the "`Creating
@@ -968,16 +968,16 @@ environment, you must do the following:
- Because you launch ``menuconfig`` using BitBake, you must be sure to
set up your environment by running the
````` <&YOCTO_DOCS_REF_URL;#structure-core-script>`__ script found in
- the `Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__.
+ the :term:`Build Directory`.
- You must be sure of the state of your build's configuration in the
- `Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__.
+ :term:`Source Directory`.
- Your build host must have the following two packages installed:
libncurses5-dev libtinfo-dev
The following commands initialize the BitBake environment, run the
-```do_kernel_configme`` <&YOCTO_DOCS_REF_URL;#ref-tasks-kernel_configme>`__
+:ref:`ref-tasks-kernel_configme`
task, and launch ``menuconfig``. These commands assume the Source
Directory's top-level folder is ``~/poky``: $ cd poky $ source
oe-init-build-env $ bitbake linux-yocto -c kernel_configme -f $ bitbake
@@ -1089,17 +1089,17 @@ which the OpenEmbedded build system can draw to create the final
To create a ``defconfig``, start with a complete, working Linux kernel
``.config`` file. Copy that file to the appropriate
-``${``\ ```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__\ ``}`` directory in
+``${``\ :term:`PN`\ ``}`` directory in
your layer's ``recipes-kernel/linux`` directory, and rename the copied
file to "defconfig" (e.g.
``~/meta-mylayer/recipes-kernel/linux/linux-yocto/defconfig``). Then,
add the following lines to the linux-yocto ``.bbappend`` file in your
layer: FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" SRC_URI +=
"file://defconfig" The
-```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ tells the build
+:term:`SRC_URI` tells the build
system how to search for the file, while the
-```FILESEXTRAPATHS`` <&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS>`__
-extends the ```FILESPATH`` <&YOCTO_DOCS_REF_URL;#var-FILESPATH>`__
+:term:`FILESEXTRAPATHS`
+extends the :term:`FILESPATH`
variable (search directories) to include the ``${PN}`` directory you
created to hold the configuration changes.
@@ -1179,7 +1179,7 @@ steps:
3. *Create the Configuration Fragment:* Run the ``diffconfig`` command
to prepare a configuration fragment. The resulting file
``fragment.cfg`` is placed in the
- ``${``\ ```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__\ ``}``
+ ``${``\ :term:`WORKDIR`\ ``}``
directory: $ bitbake linux-yocto -c diffconfig
The ``diffconfig`` command creates a file that is a list of Linux kernel
@@ -1196,7 +1196,7 @@ information on how to use the output as a configuration fragment.
Where do you put your configuration fragment files? You can place these
files in an area pointed to by
-```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ as directed by your
+:term:`SRC_URI` as directed by your
``bblayers.conf`` file, which is located in your layer. The OpenEmbedded
build system picks up the configuration and adds it to the kernel's
configuration. For example, suppose you had a set of configuration
@@ -1219,7 +1219,7 @@ Validating Configuration
------------------------
You can use the
-```do_kernel_configcheck`` <&YOCTO_DOCS_REF_URL;#ref-tasks-kernel_configcheck>`__
+:ref:`ref-tasks-kernel_configcheck`
task to provide configuration validation: $ bitbake linux-yocto -c
kernel_configcheck -f Running this task produces warnings for when a
requested configuration does not appear in the final ``.config`` file or
@@ -1268,9 +1268,9 @@ The output describes the various problems that you can encounter along
with where to find the offending configuration items. You can use the
information in the logs to adjust your configuration files and then
repeat the
-```do_kernel_configme`` <&YOCTO_DOCS_REF_URL;#ref-tasks-kernel_configme>`__
+:ref:`ref-tasks-kernel_configme`
and
-```do_kernel_configcheck`` <&YOCTO_DOCS_REF_URL;#ref-tasks-kernel_configcheck>`__
+:ref:`ref-tasks-kernel_configcheck`
tasks until they produce no warnings.
For more information on how to use the ``menuconfig`` tool, see the
@@ -1395,7 +1395,7 @@ If you cannot work with one of the Linux kernel versions supported by
existing linux-yocto recipes, you can still make use of the Yocto
Project Linux kernel tooling by working with your own sources. When you
use your own sources, you will not be able to leverage the existing
-kernel `Metadata <&YOCTO_DOCS_REF_URL;#metadata>`__ and stabilization
+kernel :term:`Metadata` and stabilization
work of the linux-yocto sources. However, you will be able to manage
your own Metadata in the same format as the linux-yocto sources.
Maintaining format compatibility facilitates converging with linux-yocto
@@ -1428,7 +1428,7 @@ Here are some basic steps you can use to work with your own sources:
the following: $ make defconfig After running the command, copy the
resulting ``.config`` file to the ``files`` directory in your layer
as "defconfig" and then add it to the
- ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ variable in the
+ :term:`SRC_URI` variable in the
recipe.
Running the ``make defconfig`` command results in the default
@@ -1445,7 +1445,7 @@ Here are some basic steps you can use to work with your own sources:
4. *Edit the Recipe:* Edit the following variables in your recipe as
appropriate for your project:
- - ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__: The
+ - :term:`SRC_URI`: The
``SRC_URI`` should specify a Git repository that uses one of the
supported Git fetcher protocols (i.e. ``file``, ``git``, ``http``,
and so forth). The ``SRC_URI`` variable should also specify either
@@ -1453,32 +1453,32 @@ Here are some basic steps you can use to work with your own sources:
skeleton recipe provides an example ``SRC_URI`` as a syntax
reference.
- - ```LINUX_VERSION`` <&YOCTO_DOCS_REF_URL;#var-LINUX_VERSION>`__:
+ - :term:`LINUX_VERSION`:
The Linux kernel version you are using (e.g. "4.12").
- - ```LINUX_VERSION_EXTENSION`` <&YOCTO_DOCS_REF_URL;#var-LINUX_VERSION_EXTENSION>`__:
+ - :term:`LINUX_VERSION_EXTENSION`:
The Linux kernel ``CONFIG_LOCALVERSION`` that is compiled into the
resulting kernel and visible through the ``uname`` command.
- - ```SRCREV`` <&YOCTO_DOCS_REF_URL;#var-SRCREV>`__: The commit ID
+ - :term:`SRCREV`: The commit ID
from which you want to build.
- - ```PR`` <&YOCTO_DOCS_REF_URL;#var-PR>`__: Treat this variable the
+ - :term:`PR`: Treat this variable the
same as you would in any other recipe. Increment the variable to
indicate to the OpenEmbedded build system that the recipe has
changed.
- - ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__: The default ``PV``
+ - :term:`PV`: The default ``PV``
assignment is typically adequate. It combines the
``LINUX_VERSION`` with the Source Control Manager (SCM) revision
- as derived from the ```SRCPV`` <&YOCTO_DOCS_REF_URL;#var-SRCPV>`__
+ as derived from the :term:`SRCPV`
variable. The combined results are a string with the following
form:
3.19.11+git1+68a635bf8dfb64b02263c1ac80c948647cc76d5f_1+218bd8d2022b9852c60d32f0d770931e3cf343e2
While lengthy, the extra verbosity in ``PV`` helps ensure you are
using the exact sources from which you intend to build.
- - ```COMPATIBLE_MACHINE`` <&YOCTO_DOCS_REF_URL;#var-COMPATIBLE_MACHINE>`__:
+ - :term:`COMPATIBLE_MACHINE`:
A list of the machines supported by your new recipe. This variable
in the example recipe is set by default to a regular expression
that matches only the empty string, "(^$)". This default setting
@@ -1546,13 +1546,13 @@ or other files necessary for building the module that do not come with
the sources. Finally, update the recipe as needed for the module.
Typically, you will need to set the following variables:
-- ```DESCRIPTION`` <&YOCTO_DOCS_REF_URL;#var-DESCRIPTION>`__
+- :term:`DESCRIPTION`
- ```LICENSE*`` <&YOCTO_DOCS_REF_URL;#var-LICENSE>`__
-- ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__
+- :term:`SRC_URI`
-- ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__
+- :term:`PV`
Depending on the build system used by the module sources, you might need
to make some adjustments. For example, a typical module ``Makefile``
@@ -1561,14 +1561,14 @@ looks much like the one provided with the ``hello-mod`` template: obj-m
modules_install: $(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install ...
The important point to note here is the
-```KERNEL_SRC`` <&YOCTO_DOCS_REF_URL;#var-KERNEL_SRC>`__ variable. The
-```module`` <&YOCTO_DOCS_REF_URL;#ref-classes-module>`__ class sets this
+:term:`KERNEL_SRC` variable. The
+:ref:`module ` class sets this
variable and the
-```KERNEL_PATH`` <&YOCTO_DOCS_REF_URL;#var-KERNEL_PATH>`__ variable to
+:term:`KERNEL_PATH` variable to
``${STAGING_KERNEL_DIR}`` with the necessary Linux kernel build
information to build modules. If your module ``Makefile`` uses a
different variable, you might want to override the
-```do_compile`` <&YOCTO_DOCS_REF_URL;#ref-tasks-compile>`__ step, or
+:ref:`ref-tasks-compile` step, or
create a patch to the ``Makefile`` to work with the more typical
``KERNEL_SRC`` or ``KERNEL_PATH`` variables.
@@ -1577,13 +1577,13 @@ module in your images. To do this, see the documentation for the
following variables in the Yocto Project Reference Manual and set one of
them appropriately for your machine configuration file:
-- ```MACHINE_ESSENTIAL_EXTRA_RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS>`__
+- :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
-- ```MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS>`__
+- :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`
-- ```MACHINE_EXTRA_RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_EXTRA_RDEPENDS>`__
+- :term:`MACHINE_EXTRA_RDEPENDS`
-- ```MACHINE_EXTRA_RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_EXTRA_RRECOMMENDS>`__
+- :term:`MACHINE_EXTRA_RRECOMMENDS`
Modules are often not required for boot and can be excluded from certain
build configurations. The following allows for the most flexibility:
@@ -1592,8 +1592,8 @@ derived by appending the module filename without the ``.ko`` extension
to the string "kernel-module-".
Because the variable is
-```RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS>`__ and not a
-```RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-RDEPENDS>`__ variable, the build
+:term:`RRECOMMENDS` and not a
+:term:`RDEPENDS` variable, the build
will not fail if this module is not available to include in the image.
Inspecting Changes and Commits
@@ -1661,9 +1661,9 @@ Adding Recipe-Space Kernel Features
You can add kernel features in the
`recipe-space <#recipe-space-metadata>`__ by using the
-```KERNEL_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES>`__
+:term:`KERNEL_FEATURES`
variable and by specifying the feature's ``.scc`` file path in the
-```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ statement. When you
+:term:`SRC_URI` statement. When you
add features using this method, the OpenEmbedded build system checks to
be sure the features are present. If the features are not present, the
build stops. Kernel features are the last elements processed for
diff --git a/documentation/kernel-dev/kernel-dev-concepts-appx.rst b/documentation/kernel-dev/kernel-dev-concepts-appx.rst
index f3349a6be4..ed1486b65d 100644
--- a/documentation/kernel-dev/kernel-dev-concepts-appx.rst
+++ b/documentation/kernel-dev/kernel-dev-concepts-appx.rst
@@ -313,7 +313,7 @@ The temporary kernel source files resulting from a build using BitBake
have a particular hierarchy. When you build the kernel on your
development system, all files needed for the build are taken from the
source repositories pointed to by the
-```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ variable and gathered
+:term:`SRC_URI` variable and gathered
in a temporary work area where they are subsequently used to create the
unique kernel. Thus, in a sense, the process constructs a local source
tree specific to your kernel from which to generate the new kernel
diff --git a/documentation/kernel-dev/kernel-dev-faq.rst b/documentation/kernel-dev/kernel-dev-faq.rst
index 9ae93506e9..fd9f8ce33d 100644
--- a/documentation/kernel-dev/kernel-dev-faq.rst
+++ b/documentation/kernel-dev/kernel-dev-faq.rst
@@ -28,12 +28,12 @@ append file to override metadata. How do I install a specific kernel
module? Linux kernel modules are packaged individually. To ensure a
specific kernel module is included in an image, include it in the
appropriate machine
-```RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS>`__ variable.
+:term:`RRECOMMENDS` variable.
These other variables are useful for installing specific modules:
-```MACHINE_ESSENTIAL_EXTRA_RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS>`__
-```MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS>`__
-```MACHINE_EXTRA_RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_EXTRA_RDEPENDS>`__
-```MACHINE_EXTRA_RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_EXTRA_RRECOMMENDS>`__
+:term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
+:term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`
+:term:`MACHINE_EXTRA_RDEPENDS`
+:term:`MACHINE_EXTRA_RRECOMMENDS`
For example, set the following in the ``qemux86.conf`` file to include
the ``ab123`` kernel modules with images built for the ``qemux86``
machine: MACHINE_EXTRA_RRECOMMENDS += "kernel-module-ab123" For more
diff --git a/documentation/kernel-dev/kernel-dev-intro.rst b/documentation/kernel-dev/kernel-dev-intro.rst
index 82a77913b7..cb4ffcf13b 100644
--- a/documentation/kernel-dev/kernel-dev-intro.rst
+++ b/documentation/kernel-dev/kernel-dev-intro.rst
@@ -13,7 +13,7 @@ Regardless of how you intend to make use of the Yocto Project, chances
are you will work with the Linux kernel. This manual describes how to
set up your build host to support kernel development, introduces the
kernel development process, provides background information on the Yocto
-Linux kernel `Metadata <&YOCTO_DOCS_REF_URL;#metadata>`__, describes
+Linux kernel :term:`Metadata`, describes
common tasks you can perform using the kernel tools, shows you how to
use the kernel Metadata needed to work with the kernel inside the Yocto
Project, and provides insight into how the Yocto Project team develops
diff --git a/documentation/kernel-dev/kernel-dev-maint-appx.rst b/documentation/kernel-dev/kernel-dev-maint-appx.rst
index b4e5f199c9..d76e789d56 100644
--- a/documentation/kernel-dev/kernel-dev-maint-appx.rst
+++ b/documentation/kernel-dev/kernel-dev-maint-appx.rst
@@ -111,7 +111,7 @@ patch, or BSP:
4. *Append Extra Features:* Extra features are appended to the top-level
feature description. These features can come from the
- ```KERNEL_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES>`__
+ :term:`KERNEL_FEATURES`
variable in recipes.
5. *Locate, Expand, and Append Each Feature:* Each extra feature is
@@ -172,7 +172,7 @@ can consider the compilation phase of kernel development, which is
building a kernel image. Some prerequisites exist that are validated by
the build process before compilation starts:
-- The ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ points to the
+- The :term:`SRC_URI` points to the
kernel Git repository.
- A BSP build branch with Metadata exists in the ``yocto-kernel-cache``
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst
index 3f4aa4f4c4..59096fbebf 100644
--- a/documentation/overview-manual/overview-manual-concepts.rst
+++ b/documentation/overview-manual/overview-manual-concepts.rst
@@ -14,9 +14,9 @@ explained.
Yocto Project Components
========================
-The `BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__ task executor
+The :term:`BitBake` task executor
together with various types of configuration files form the
-`OpenEmbedded-Core <&YOCTO_DOCS_REF_URL;#oe-core>`__. This section
+:term:`OpenEmbedded-Core (OE-Core)`. This section
overviews these components by describing their use and how they
interact.
@@ -50,7 +50,7 @@ BitBake
BitBake is the tool at the heart of the `OpenEmbedded build
system <&YOCTO_DOCS_REF_URL;#build-system-term>`__ and is responsible
-for parsing the `Metadata <&YOCTO_DOCS_REF_URL;#metadata>`__, generating
+for parsing the :term:`Metadata`, generating
a list of tasks from it, and then executing those tasks.
This section briefly introduces BitBake. If you want more information on
@@ -107,7 +107,7 @@ Classes
Class files (``.bbclass``) contain information that is useful to share
between recipes files. An example is the
-```autotools`` <&YOCTO_DOCS_REF_URL;#ref-classes-autotools>`__ class,
+:ref:`autotools ` class,
which contains common settings for any application that Autotools uses.
The "`Classes <&YOCTO_DOCS_REF_URL;#ref-classes>`__" chapter in the
Yocto Project Reference Manual provides details about classes and how to
@@ -187,7 +187,7 @@ In general, the build's workflow consists of several functional areas:
- *Source Files:* Upstream releases, local projects, and SCMs.
- *Build System:* Processes under the control of
- `BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__. This block expands
+ :term:`BitBake`. This block expands
on how BitBake fetches source, applies patches, completes
compilation, analyzes output for package generation, creates and
tests packages, generates images, and generates cross-development
@@ -253,7 +253,7 @@ source the build environment setup script.
Because the Poky repository is fundamentally an aggregation of existing
repositories, some users might be familiar with running the ```` script
in the context of separate
-`OpenEmbedded-Core <&YOCTO_DOCS_REF_URL;#oe-core>`__ and BitBake
+:term:`OpenEmbedded-Core (OE-Core)` and BitBake
repositories rather than a single Poky repository. This discussion
assumes the script is executed from within a cloned or unpacked version
of Poky.
@@ -281,29 +281,29 @@ script, see the
in the ``meta-poky`` layer:
- *Target Machine Selection:* Controlled by the
- ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ variable.
+ :term:`MACHINE` variable.
- *Download Directory:* Controlled by the
- ```DL_DIR`` <&YOCTO_DOCS_REF_URL;#var-DL_DIR>`__ variable.
+ :term:`DL_DIR` variable.
- *Shared State Directory:* Controlled by the
- ```SSTATE_DIR`` <&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR>`__ variable.
+ :term:`SSTATE_DIR` variable.
- *Build Output:* Controlled by the
- ```TMPDIR`` <&YOCTO_DOCS_REF_URL;#var-TMPDIR>`__ variable.
+ :term:`TMPDIR` variable.
- *Distribution Policy:* Controlled by the
- ```DISTRO`` <&YOCTO_DOCS_REF_URL;#var-DISTRO>`__ variable.
+ :term:`DISTRO` variable.
- *Packaging Format:* Controlled by the
- ```PACKAGE_CLASSES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES>`__
+ :term:`PACKAGE_CLASSES`
variable.
- *SDK Target Architecture:* Controlled by the
- ```SDKMACHINE`` <&YOCTO_DOCS_REF_URL;#var-SDKMACHINE>`__ variable.
+ :term:`SDKMACHINE` variable.
- *Extra Image Packages:* Controlled by the
- ```EXTRA_IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES>`__
+ :term:`EXTRA_IMAGE_FEATURES`
variable.
.. note::
@@ -334,11 +334,11 @@ created by an autobuilder:
you had several build environments and they shared some common
features. You can set these default build properties here. A good
example is perhaps the packaging format to use through the
- ```PACKAGE_CLASSES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES>`__
+ :term:`PACKAGE_CLASSES`
variable.
One useful scenario for using the ``conf/site.conf`` file is to
- extend your ```BBPATH`` <&YOCTO_DOCS_REF_URL;#var-BBPATH>`__ variable
+ extend your :term:`BBPATH` variable
to include the path to a ``conf/site.conf``. Then, when BitBake looks
for Metadata using ``BBPATH``, it finds the ``conf/site.conf`` file
and applies your common configurations found in the file. To override
@@ -543,18 +543,18 @@ to build software. Finally, a combination of the two might exist, which
would give the consumer a choice when deciding where to get source
files.
-BitBake uses the ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__
+BitBake uses the :term:`SRC_URI`
variable to point to source files regardless of their location. Each
recipe must have a ``SRC_URI`` variable that points to the source.
Another area that plays a significant role in where source files come
from is pointed to by the
-```DL_DIR`` <&YOCTO_DOCS_REF_URL;#var-DL_DIR>`__ variable. This area is
+:term:`DL_DIR` variable. This area is
a cache that can hold previously downloaded source. You can also
instruct the OpenEmbedded build system to create tarballs from Git
repositories, which is not the default behavior, and store them in the
``DL_DIR`` by using the
-```BB_GENERATE_MIRROR_TARBALLS`` <&YOCTO_DOCS_REF_URL;#var-BB_GENERATE_MIRROR_TARBALLS>`__
+:term:`BB_GENERATE_MIRROR_TARBALLS`
variable.
Judicious use of a ``DL_DIR`` directory can save the build system a trip
@@ -588,7 +588,7 @@ user checks in items (e.g. a local directory containing a development
source tree used by the group).
The canonical method through which to include a local project is to use
-the ```externalsrc`` <&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc>`__
+the :ref:`externalsrc `
class to include that local project. You use either the ``local.conf``
or a recipe's append file to override or set the recipe to point to the
local directory on your disk to pull in the whole source tree.
@@ -602,8 +602,8 @@ Another place from which the build system can get source files is with
`fetchers <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ employing various Source
Control Managers (SCMs) such as Git or Subversion. In such cases, a
repository is cloned or checked out. The
-```do_fetch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-fetch>`__ task inside
-BitBake uses the ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__
+:ref:`ref-tasks-fetch` task inside
+BitBake uses the :term:`SRC_URI`
variable and the argument's prefix to determine the correct fetcher
module.
@@ -617,19 +617,19 @@ module.
variable in the Yocto Project Reference Manual.
When fetching a repository, BitBake uses the
-```SRCREV`` <&YOCTO_DOCS_REF_URL;#var-SRCREV>`__ variable to determine
+:term:`SRCREV` variable to determine
the specific revision from which to build.
Source Mirror(s)
~~~~~~~~~~~~~~~~
Two kinds of mirrors exist: pre-mirrors and regular mirrors. The
-```PREMIRRORS`` <&YOCTO_DOCS_REF_URL;#var-PREMIRRORS>`__ and
-```MIRRORS`` <&YOCTO_DOCS_REF_URL;#var-MIRRORS>`__ variables point to
+:term:`PREMIRRORS` and
+:term:`MIRRORS` variables point to
these, respectively. BitBake checks pre-mirrors before looking upstream
for any source files. Pre-mirrors are appropriate when you have a shared
directory that is not a directory defined by the
-```DL_DIR`` <&YOCTO_DOCS_REF_URL;#var-DL_DIR>`__ variable. A Pre-mirror
+:term:`DL_DIR` variable. A Pre-mirror
typically points to a shared directory that is local to your
organization.
@@ -657,10 +657,10 @@ the build system. Here is a more detailed look at the area:
Package feeds are an intermediary step in the build process. The
OpenEmbedded build system provides classes to generate different package
types, and you specify which classes to enable through the
-```PACKAGE_CLASSES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES>`__
+:term:`PACKAGE_CLASSES`
variable. Before placing the packages into package feeds, the build
process validates them with generated output quality assurance checks
-through the ```insane`` <&YOCTO_DOCS_REF_URL;#ref-classes-insane>`__
+through the :ref:`insane `
class.
The package feed area resides in the Build Directory. The directory the
@@ -670,19 +670,19 @@ the "Package Feeds" box in the illustration and note the information to
the right of that area. In particular, the following defines where
package files are kept:
-- ```DEPLOY_DIR`` <&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR>`__: Defined as
+- :term:`DEPLOY_DIR`: Defined as
``tmp/deploy`` in the Build Directory.
- ``DEPLOY_DIR_*``: Depending on the package manager used, the package
type sub-folder. Given RPM, IPK, or DEB packaging and tarball
creation, the
- ```DEPLOY_DIR_RPM`` <&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_RPM>`__,
- ```DEPLOY_DIR_IPK`` <&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_IPK>`__,
- ```DEPLOY_DIR_DEB`` <&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_DEB>`__, or
- ```DEPLOY_DIR_TAR`` <&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_TAR>`__,
+ :term:`DEPLOY_DIR_RPM`,
+ :term:`DEPLOY_DIR_IPK`,
+ :term:`DEPLOY_DIR_DEB`, or
+ :term:`DEPLOY_DIR_TAR`,
variables are used, respectively.
-- ```PACKAGE_ARCH`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH>`__: Defines
+- :term:`PACKAGE_ARCH`: Defines
architecture-specific sub-folders. For example, packages could exist
for the i586 or qemux86 architectures.
@@ -690,11 +690,11 @@ BitBake uses the
```do_package_write_*`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_deb>`__
tasks to generate packages and place them into the package holding area
(e.g. ``do_package_write_ipk`` for IPK packages). See the
-"```do_package_write_deb`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_deb>`__",
-"```do_package_write_ipk`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_ipk>`__",
-"```do_package_write_rpm`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_rpm>`__",
+":ref:`ref-tasks-package_write_deb`",
+":ref:`ref-tasks-package_write_ipk`",
+":ref:`ref-tasks-package_write_rpm`",
and
-"```do_package_write_tar`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_tar>`__"
+":ref:`ref-tasks-package_write_tar`"
sections in the Yocto Project Reference Manual for additional
information. As an example, consider a scenario where an IPK packaging
manager is being used and package architecture support for both i586 and
@@ -708,7 +708,7 @@ BitBake
-------
The OpenEmbedded build system uses
-`BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__ to produce images and
+:term:`BitBake` to produce images and
Software Development Kits (SDKs). You can see from the `general workflow
figure <#general-workflow-figure>`__, the BitBake area consists of
several functional areas. This section takes a closer look at each of
@@ -731,8 +731,8 @@ code:
.. image:: figures/source-fetching.png
:align: center
-The ```do_fetch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-fetch>`__ and
-```do_unpack`` <&YOCTO_DOCS_REF_URL;#ref-tasks-unpack>`__ tasks fetch
+The :ref:`ref-tasks-fetch` and
+:ref:`ref-tasks-unpack` tasks fetch
the source files and unpack them into the `Build
Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__.
@@ -756,17 +756,17 @@ Directory, see the
the Yocto Project Reference Manual.
Each recipe has an area in the Build Directory where the unpacked source
-code resides. The ```S`` <&YOCTO_DOCS_REF_URL;#var-S>`__ variable points
+code resides. The :term:`S` variable points
to this area for a recipe's unpacked source code. The name of that
directory for any given recipe is defined from several different
variables. The preceding figure and the following list describe the
Build Directory's hierarchy:
-- ```TMPDIR`` <&YOCTO_DOCS_REF_URL;#var-TMPDIR>`__: The base directory
+- :term:`TMPDIR`: The base directory
where the OpenEmbedded build system performs all its work during the
build. The default base directory is the ``tmp`` directory.
-- ```PACKAGE_ARCH`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH>`__: The
+- :term:`PACKAGE_ARCH`: The
architecture of the built package or packages. Depending on the
eventual destination of the package or packages (i.e. machine
architecture, `build
@@ -774,33 +774,33 @@ Build Directory's hierarchy:
specific machine), ``PACKAGE_ARCH`` varies. See the variable's
description for details.
-- ```TARGET_OS`` <&YOCTO_DOCS_REF_URL;#var-TARGET_OS>`__: The operating
+- :term:`TARGET_OS`: The operating
system of the target device. A typical value would be "linux" (e.g.
"qemux86-poky-linux").
-- ```PN`` <&YOCTO_DOCS_REF_URL;#var-PN>`__: The name of the recipe used
+- :term:`PN`: The name of the recipe used
to build the package. This variable can have multiple meanings.
However, when used in the context of input files, ``PN`` represents
the the name of the recipe.
-- ```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__: The location
+- :term:`WORKDIR`: The location
where the OpenEmbedded build system builds a recipe (i.e. does the
work to create the package).
- - ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__: The version of the
+ - :term:`PV`: The version of the
recipe used to build the package.
- - ```PR`` <&YOCTO_DOCS_REF_URL;#var-PR>`__: The revision of the
+ - :term:`PR`: The revision of the
recipe used to build the package.
-- ```S`` <&YOCTO_DOCS_REF_URL;#var-S>`__: Contains the unpacked source
+- :term:`S`: Contains the unpacked source
files for a given recipe.
- - ```BPN`` <&YOCTO_DOCS_REF_URL;#var-BPN>`__: The name of the recipe
+ - :term:`BPN`: The name of the recipe
used to build the package. The ``BPN`` variable is a version of
the ``PN`` variable but with common prefixes and suffixes removed.
- - ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__: The version of the
+ - :term:`PV`: The version of the
recipe used to build the package.
.. note::
@@ -825,15 +825,15 @@ and applies them to the source files:
.. image:: figures/patching.png
:align: center
-The ```do_patch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-patch>`__ task uses a
-recipe's ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ statements
-and the ```FILESPATH`` <&YOCTO_DOCS_REF_URL;#var-FILESPATH>`__ variable
+The :ref:`ref-tasks-patch` task uses a
+recipe's :term:`SRC_URI` statements
+and the :term:`FILESPATH` variable
to locate applicable patch files.
Default processing for patch files assumes the files have either
``*.patch`` or ``*.diff`` file types. You can use ``SRC_URI`` parameters
to change the way the build system recognizes patch files. See the
-```do_patch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-patch>`__ task for more
+:ref:`ref-tasks-patch` task for more
information.
BitBake finds and applies multiple patches for a single recipe in the
@@ -841,7 +841,7 @@ order in which it locates the patches. The ``FILESPATH`` variable
defines the default set of directories that the build system uses to
search for patch files. Once found, patches are applied to the recipe's
source files, which are located in the
-```S`` <&YOCTO_DOCS_REF_URL;#var-S>`__ directory.
+:term:`S` directory.
For more information on how the source directories are created, see the
"`Source Fetching <#source-fetching-dev-environment>`__" section. For
@@ -871,13 +871,13 @@ to a holding area (staged) in preparation for packaging:
This step in the build process consists of the following tasks:
-- ```do_prepare_recipe_sysroot`` <&YOCTO_DOCS_REF_URL;#ref-tasks-prepare_recipe_sysroot>`__:
+- :ref:`ref-tasks-prepare_recipe_sysroot`:
This task sets up the two sysroots in
- ``${``\ ```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__\ ``}``
+ ``${``\ :term:`WORKDIR`\ ``}``
(i.e. ``recipe-sysroot`` and ``recipe-sysroot-native``) so that
during the packaging phase the sysroots can contain the contents of
the
- ```do_populate_sysroot`` <&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sysroot>`__
+ :ref:`ref-tasks-populate_sysroot`
tasks of the recipes on which the recipe containing the tasks
depends. A sysroot exists for both the target and for the native
binaries, which run on the host system.
@@ -889,32 +889,32 @@ This step in the build process consists of the following tasks:
configure itself depending on the target for which it is being built.
The configurations handled by the
- ```do_configure`` <&YOCTO_DOCS_REF_URL;#ref-tasks-configure>`__ task
+ :ref:`ref-tasks-configure` task
are specific to configurations for the source code being built by the
recipe.
If you are using the
- ```autotools`` <&YOCTO_DOCS_REF_URL;#ref-classes-autotools>`__ class,
+ :ref:`autotools ` class,
you can add additional configuration options by using the
- ```EXTRA_OECONF`` <&YOCTO_DOCS_REF_URL;#var-EXTRA_OECONF>`__ or
- ```PACKAGECONFIG_CONFARGS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS>`__
+ :term:`EXTRA_OECONF` or
+ :term:`PACKAGECONFIG_CONFARGS`
variables. For information on how this variable works within that
class, see the
- ```autotools`` <&YOCTO_DOCS_REF_URL;#ref-classes-autotools>`__ class
+ :ref:`autotools ` class
`here <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/autotools.bbclass>`__.
- *``do_compile``*: Once a configuration task has been satisfied,
BitBake compiles the source using the
- ```do_compile`` <&YOCTO_DOCS_REF_URL;#ref-tasks-compile>`__ task.
+ :ref:`ref-tasks-compile` task.
Compilation occurs in the directory pointed to by the
- ```B`` <&YOCTO_DOCS_REF_URL;#var-B>`__ variable. Realize that the
+ :term:`B` variable. Realize that the
``B`` directory is, by default, the same as the
- ```S`` <&YOCTO_DOCS_REF_URL;#var-S>`__ directory.
+ :term:`S` directory.
- *``do_install``*: After compilation completes, BitBake executes the
- ```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__ task.
+ :ref:`ref-tasks-install` task.
This task copies files from the ``B`` directory and places them in a
- holding area pointed to by the ```D`` <&YOCTO_DOCS_REF_URL;#var-D>`__
+ holding area pointed to by the :term:`D`
variable. Packaging occurs later using files from this holding
directory.
@@ -929,10 +929,10 @@ analyzes the results and splits the output into packages:
.. image:: figures/analysis-for-package-splitting.png
:align: center
-The ```do_package`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package>`__ and
-```do_packagedata`` <&YOCTO_DOCS_REF_URL;#ref-tasks-packagedata>`__
+The :ref:`ref-tasks-package` and
+:ref:`ref-tasks-packagedata`
tasks combine to analyze the files found in the
-```D`` <&YOCTO_DOCS_REF_URL;#var-D>`__ directory and split them into
+:term:`D` directory and split them into
subsets based on available packages and files. Analysis involves the
following as well as other items: splitting out debugging symbols,
looking at shared library dependencies between packages, and looking at
@@ -940,46 +940,46 @@ package relationships.
The ``do_packagedata`` task creates package metadata based on the
analysis such that the build system can generate the final packages. The
-```do_populate_sysroot`` <&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sysroot>`__
+:ref:`ref-tasks-populate_sysroot`
task stages (copies) a subset of the files installed by the
-```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__ task into
+:ref:`ref-tasks-install` task into
the appropriate sysroot. Working, staged, and intermediate results of
the analysis and package splitting process use several areas:
-- ```PKGD`` <&YOCTO_DOCS_REF_URL;#var-PKGD>`__: The destination
+- :term:`PKGD`: The destination
directory (i.e. ``package``) for packages before they are split into
individual packages.
-- ```PKGDESTWORK`` <&YOCTO_DOCS_REF_URL;#var-PKGDESTWORK>`__: A
+- :term:`PKGDESTWORK`: A
temporary work area (i.e. ``pkgdata``) used by the ``do_package``
task to save package metadata.
-- ```PKGDEST`` <&YOCTO_DOCS_REF_URL;#var-PKGDEST>`__: The parent
+- :term:`PKGDEST`: The parent
directory (i.e. ``packages-split``) for packages after they have been
split.
-- ```PKGDATA_DIR`` <&YOCTO_DOCS_REF_URL;#var-PKGDATA_DIR>`__: A shared,
+- :term:`PKGDATA_DIR`: A shared,
global-state directory that holds packaging metadata generated during
the packaging process. The packaging process copies metadata from
``PKGDESTWORK`` to the ``PKGDATA_DIR`` area where it becomes globally
available.
-- ```STAGING_DIR_HOST`` <&YOCTO_DOCS_REF_URL;#var-STAGING_DIR_HOST>`__:
+- :term:`STAGING_DIR_HOST`:
The path for the sysroot for the system on which a component is built
to run (i.e. ``recipe-sysroot``).
-- ```STAGING_DIR_NATIVE`` <&YOCTO_DOCS_REF_URL;#var-STAGING_DIR_NATIVE>`__:
+- :term:`STAGING_DIR_NATIVE`:
The path for the sysroot used when building components for the build
host (i.e. ``recipe-sysroot-native``).
-- ```STAGING_DIR_TARGET`` <&YOCTO_DOCS_REF_URL;#var-STAGING_DIR_TARGET>`__:
+- :term:`STAGING_DIR_TARGET`:
The path for the sysroot used when a component that is built to
execute on a system and it generates code for yet another machine
(e.g. cross-canadian recipes).
-The ```FILES`` <&YOCTO_DOCS_REF_URL;#var-FILES>`__ variable defines the
+The :term:`FILES` variable defines the
files that go into each package in
-```PACKAGES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGES>`__. If you want
+:term:`PACKAGES`. If you want
details on how this is accomplished, you can look at
```package.bbclass`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/package.bbclass>`__.
@@ -1013,36 +1013,36 @@ system uses BitBake to generate the root filesystem image:
The image generation process consists of several stages and depends on
several tasks and variables. The
-```do_rootfs`` <&YOCTO_DOCS_REF_URL;#ref-tasks-rootfs>`__ task creates
+:ref:`ref-tasks-rootfs` task creates
the root filesystem (file and directory structure) for an image. This
task uses several key variables to help create the list of packages to
actually install:
-- ```IMAGE_INSTALL`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL>`__: Lists
+- :term:`IMAGE_INSTALL`: Lists
out the base set of packages from which to install from the Package
Feeds area.
-- ```PACKAGE_EXCLUDE`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_EXCLUDE>`__:
+- :term:`PACKAGE_EXCLUDE`:
Specifies packages that should not be installed into the image.
-- ```IMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES>`__:
+- :term:`IMAGE_FEATURES`:
Specifies features to include in the image. Most of these features
map to additional packages for installation.
-- ```PACKAGE_CLASSES`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES>`__:
+- :term:`PACKAGE_CLASSES`:
Specifies the package backend (e.g. RPM, DEB, or IPK) to use and
consequently helps determine where to locate packages within the
Package Feeds area.
-- ```IMAGE_LINGUAS`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_LINGUAS>`__:
+- :term:`IMAGE_LINGUAS`:
Determines the language(s) for which additional language support
packages are installed.
-- ```PACKAGE_INSTALL`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_INSTALL>`__:
+- :term:`PACKAGE_INSTALL`:
The final list of packages passed to the package manager for
installation into the image.
-With ```IMAGE_ROOTFS`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_ROOTFS>`__
+With :term:`IMAGE_ROOTFS`
pointing to the location of the filesystem under construction and the
``PACKAGE_INSTALL`` variable providing the final list of packages to
install, the root file system is created.
@@ -1069,27 +1069,27 @@ root filesystem image. This file lists out, line-by-line, the installed
packages. The manifest file is useful for the
```testimage`` <&YOCTO_DOCS_REF_URL;#ref-classes-testimage*>`__ class,
for example, to determine whether or not to run specific tests. See the
-```IMAGE_MANIFEST`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_MANIFEST>`__
+:term:`IMAGE_MANIFEST`
variable for additional information.
Optimizing processes that are run across the image include ``mklibs``,
``prelink``, and any other post-processing commands as defined by the
-```ROOTFS_POSTPROCESS_COMMAND`` <&YOCTO_DOCS_REF_URL;#var-ROOTFS_POSTPROCESS_COMMAND>`__
+:term:`ROOTFS_POSTPROCESS_COMMAND`
variable. The ``mklibs`` process optimizes the size of the libraries,
while the ``prelink`` process optimizes the dynamic linking of shared
libraries to reduce start up time of executables.
After the root filesystem is built, processing begins on the image
-through the ```do_image`` <&YOCTO_DOCS_REF_URL;#ref-tasks-image>`__
+through the :ref:`ref-tasks-image`
task. The build system runs any pre-processing commands as defined by
the
-```IMAGE_PREPROCESS_COMMAND`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_PREPROCESS_COMMAND>`__
+:term:`IMAGE_PREPROCESS_COMMAND`
variable. This variable specifies a list of functions to call before the
build system creates the final image output files.
The build system dynamically creates ``do_image_*`` tasks as needed,
based on the image types specified in the
-```IMAGE_FSTYPES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES>`__ variable.
+:term:`IMAGE_FSTYPES` variable.
The process turns everything into an image file or a set of image files
and can compress the root filesystem image to reduce the overall size of
the image. The formats used for the root filesystem depend on the
@@ -1105,7 +1105,7 @@ The final task involved in image creation is the
```do_image_complete`` <&YOCTO_DOCS_REF_URL;#ref-tasks-image-complete>`__
task. This task completes the image by applying any image post
processing as defined through the
-```IMAGE_POSTPROCESS_COMMAND`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_POSTPROCESS_COMMAND>`__
+:term:`IMAGE_POSTPROCESS_COMMAND`
variable. The variable specifies a list of functions to call once the
build system has created the final image output files.
@@ -1143,9 +1143,9 @@ the extensible SDK (eSDK):
Like image generation, the SDK script process consists of several stages
and depends on many variables. The
-```do_populate_sdk`` <&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sdk>`__
+:ref:`ref-tasks-populate_sdk`
and
-```do_populate_sdk_ext`` <&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sdk_ext>`__
+:ref:`ref-tasks-populate_sdk_ext`
tasks use these key variables to help create the list of packages to
actually install. For information on the variables listed in the figure,
see the "`Application Development SDK <#sdk-dev-environment>`__"
@@ -1155,7 +1155,7 @@ The ``do_populate_sdk`` task helps create the standard SDK and handles
two parts: a target part and a host part. The target part is the part
built for the target hardware and includes libraries and headers. The
host part is the part of the SDK that runs on the
-```SDKMACHINE`` <&YOCTO_DOCS_REF_URL;#var-SDKMACHINE>`__.
+:term:`SDKMACHINE`.
The ``do_populate_sdk_ext`` task helps create the extensible SDK and
handles host and target parts differently than its counter part does for
@@ -1173,9 +1173,9 @@ Stamp Files and the Rerunning of Tasks
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For each task that completes successfully, BitBake writes a stamp file
-into the ```STAMPS_DIR`` <&YOCTO_DOCS_REF_URL;#var-STAMPS_DIR>`__
+into the :term:`STAMPS_DIR`
directory. The beginning of the stamp file's filename is determined by
-the ```STAMP`` <&YOCTO_DOCS_REF_URL;#var-STAMP>`__ variable, and the end
+the :term:`STAMP` variable, and the end
of the name consists of the task's name and current `input
checksum <#overview-checksums>`__.
@@ -1202,8 +1202,8 @@ file does not exist, the task is rerun.
However, you should realize that stamp files only serve as a marker
that some work has been done and that these files do not record task
output. The actual task output would usually be somewhere in
- ```TMPDIR`` <&YOCTO_DOCS_REF_URL;#var-TMPDIR>`__ (e.g. in some
- recipe's ```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__.) What
+ :term:`TMPDIR` (e.g. in some
+ recipe's :term:`WORKDIR`.) What
the sstate cache mechanism adds is a way to cache task output that
can then be shared between build machines.
@@ -1244,16 +1244,16 @@ locations as needed. In some cases, it makes sense to have a setscene
task variant (e.g. generating package files in the
```do_package_write_*`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_deb>`__
task). In other cases, it does not make sense (e.g. a
-```do_patch`` <&YOCTO_DOCS_REF_URL;#ref-tasks-patch>`__ task or a
-```do_unpack`` <&YOCTO_DOCS_REF_URL;#ref-tasks-unpack>`__ task) since
+:ref:`ref-tasks-patch` task or a
+:ref:`ref-tasks-unpack` task) since
the work involved would be equal to or greater than the underlying task.
In the build system, the common tasks that have setscene variants are
-```do_package`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package>`__,
+:ref:`ref-tasks-package`,
``do_package_write_*``,
-```do_deploy`` <&YOCTO_DOCS_REF_URL;#ref-tasks-deploy>`__,
-```do_packagedata`` <&YOCTO_DOCS_REF_URL;#ref-tasks-packagedata>`__, and
-```do_populate_sysroot`` <&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sysroot>`__.
+:ref:`ref-tasks-deploy`,
+:ref:`ref-tasks-packagedata`, and
+:ref:`ref-tasks-populate_sysroot`.
Notice that these tasks represent most of the tasks whose output is an
end result.
@@ -1321,14 +1321,14 @@ The build process writes images out to the `Build
Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ inside the
``tmp/deploy/images/machine/`` folder as shown in the figure. This
folder contains any files expected to be loaded on the target device.
-The ```DEPLOY_DIR`` <&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR>`__ variable
+The :term:`DEPLOY_DIR` variable
points to the ``deploy`` directory, while the
-```DEPLOY_DIR_IMAGE`` <&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_IMAGE>`__
+:term:`DEPLOY_DIR_IMAGE`
variable points to the appropriate directory containing images for the
current configuration.
- kernel-image: A kernel binary file. The
- ```KERNEL_IMAGETYPE`` <&YOCTO_DOCS_REF_URL;#var-KERNEL_IMAGETYPE>`__
+ :term:`KERNEL_IMAGETYPE`
variable determines the naming scheme for the kernel image file.
Depending on this variable, the file could begin with a variety of
naming strings. The ``deploy/images/``\ machine directory can contain
@@ -1336,7 +1336,7 @@ current configuration.
- root-filesystem-image: Root filesystems for the target device (e.g.
``*.ext3`` or ``*.bz2`` files). The
- ```IMAGE_FSTYPES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES>`__
+ :term:`IMAGE_FSTYPES`
variable determines the root filesystem image type. The
``deploy/images/``\ machine directory can contain multiple root
filesystems for the machine.
@@ -1344,7 +1344,7 @@ current configuration.
- kernel-modules: Tarballs that contain all the modules built for the
kernel. Kernel module tarballs exist for legacy purposes and can be
suppressed by setting the
- ```MODULE_TARBALL_DEPLOY`` <&YOCTO_DOCS_REF_URL;#var-MODULE_TARBALL_DEPLOY>`__
+ :term:`MODULE_TARBALL_DEPLOY`
variable to "0". The ``deploy/images/``\ machine directory can
contain multiple kernel module tarballs for the machine.
@@ -1401,72 +1401,72 @@ can initialize the environment before using the tools.
Software Development Kit (eSDK) <&YOCTO_DOCS_SDK_URL;>`__ manual.
All the output files for an SDK are written to the ``deploy/sdk`` folder
-inside the `Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ as
+inside the :term:`Build Directory` as
shown in the previous figure. Depending on the type of SDK, several
variables exist that help configure these files. The following list
shows the variables associated with an extensible SDK:
-- ```DEPLOY_DIR`` <&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR>`__: Points to
+- :term:`DEPLOY_DIR`: Points to
the ``deploy`` directory.
-- ```SDK_EXT_TYPE`` <&YOCTO_DOCS_REF_URL;#var-SDK_EXT_TYPE>`__:
+- :term:`SDK_EXT_TYPE`:
Controls whether or not shared state artifacts are copied into the
extensible SDK. By default, all required shared state artifacts are
copied into the SDK.
-- ```SDK_INCLUDE_PKGDATA`` <&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_PKGDATA>`__:
+- :term:`SDK_INCLUDE_PKGDATA`:
Specifies whether or not packagedata is included in the extensible
SDK for all recipes in the "world" target.
-- ```SDK_INCLUDE_TOOLCHAIN`` <&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_TOOLCHAIN>`__:
+- :term:`SDK_INCLUDE_TOOLCHAIN`:
Specifies whether or not the toolchain is included when building the
extensible SDK.
-- ```SDK_LOCAL_CONF_WHITELIST`` <&YOCTO_DOCS_REF_URL;#var-SDK_LOCAL_CONF_WHITELIST>`__:
+- :term:`SDK_LOCAL_CONF_WHITELIST`:
A list of variables allowed through from the build system
configuration into the extensible SDK configuration.
-- ```SDK_LOCAL_CONF_BLACKLIST`` <&YOCTO_DOCS_REF_URL;#var-SDK_LOCAL_CONF_BLACKLIST>`__:
+- :term:`SDK_LOCAL_CONF_BLACKLIST`:
A list of variables not allowed through from the build system
configuration into the extensible SDK configuration.
-- ```SDK_INHERIT_BLACKLIST`` <&YOCTO_DOCS_REF_URL;#var-SDK_INHERIT_BLACKLIST>`__:
+- :term:`SDK_INHERIT_BLACKLIST`:
A list of classes to remove from the
- ```INHERIT`` <&YOCTO_DOCS_REF_URL;#var-INHERIT>`__ value globally
+ :term:`INHERIT` value globally
within the extensible SDK configuration.
This next list, shows the variables associated with a standard SDK:
-- ```DEPLOY_DIR`` <&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR>`__: Points to
+- :term:`DEPLOY_DIR`: Points to
the ``deploy`` directory.
-- ```SDKMACHINE`` <&YOCTO_DOCS_REF_URL;#var-SDKMACHINE>`__: Specifies
+- :term:`SDKMACHINE`: Specifies
the architecture of the machine on which the cross-development tools
are run to create packages for the target hardware.
-- ```SDKIMAGE_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-SDKIMAGE_FEATURES>`__:
+- :term:`SDKIMAGE_FEATURES`:
Lists the features to include in the "target" part of the SDK.
-- ```TOOLCHAIN_HOST_TASK`` <&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_HOST_TASK>`__:
+- :term:`TOOLCHAIN_HOST_TASK`:
Lists packages that make up the host part of the SDK (i.e. the part
that runs on the ``SDKMACHINE``). When you use
``bitbake -c populate_sdk imagename`` to create the SDK, a set of
default packages apply. This variable allows you to add more
packages.
-- ```TOOLCHAIN_TARGET_TASK`` <&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK>`__:
+- :term:`TOOLCHAIN_TARGET_TASK`:
Lists packages that make up the target part of the SDK (i.e. the part
built for the target hardware).
-- ```SDKPATH`` <&YOCTO_DOCS_REF_URL;#var-SDKPATH>`__: Defines the
+- :term:`SDKPATH`: Defines the
default SDK installation path offered by the installation script.
-- ```SDK_HOST_MANIFEST`` <&YOCTO_DOCS_REF_URL;#var-SDK_HOST_MANIFEST>`__:
+- :term:`SDK_HOST_MANIFEST`:
Lists all the installed packages that make up the host part of the
SDK. This variable also plays a minor role for extensible SDK
development as well. However, it is mainly used for the standard SDK.
-- ```SDK_TARGET_MANIFEST`` <&YOCTO_DOCS_REF_URL;#var-SDK_TARGET_MANIFEST>`__:
+- :term:`SDK_TARGET_MANIFEST`:
Lists all the installed packages that make up the target part of the
SDK. This variable also plays a minor role for extensible SDK
development as well. However, it is mainly used for the standard SDK.
@@ -1497,7 +1497,7 @@ toolchain construction and use.
Most of the work occurs on the Build Host. This is the machine used to
build images and generally work within the the Yocto Project
environment. When you run
-`BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__ to create an image, the
+:term:`BitBake` to create an image, the
OpenEmbedded build system uses the host ``gcc`` compiler to bootstrap a
cross-compiler named ``gcc-cross``. The ``gcc-cross`` compiler is what
BitBake uses to compile source files when creating the target image. You
@@ -1558,11 +1558,11 @@ relocatable SDK used to develop applications. When you run the
installer, it installs the toolchain, which contains the development
tools (e.g., ``gcc-cross-canadian``, ``binutils-cross-canadian``, and
other ``nativesdk-*`` tools), which are tools native to the SDK (i.e.
-native to ```SDK_ARCH`` <&YOCTO_DOCS_REF_URL;#var-SDK_ARCH>`__), you
+native to :term:`SDK_ARCH`), you
need to cross-compile and test your software. The figure shows the
commands you use to easily build out this toolchain. This
cross-development toolchain is built to execute on the
-```SDKMACHINE`` <&YOCTO_DOCS_REF_URL;#var-SDKMACHINE>`__, which might or
+:term:`SDKMACHINE`, which might or
might not be the same machine as the Build Host.
.. note::
@@ -1603,7 +1603,7 @@ glibc-initial -> nativesdk-glibc -> gcc-crosssdk -> gcc-cross-canadian
(i.e. it is designed to run on the build host).
- ``gcc-cross-canadian``: The final relocatable cross-compiler. When
- run on the ```SDKMACHINE`` <&YOCTO_DOCS_REF_URL;#var-SDKMACHINE>`__,
+ run on the :term:`SDKMACHINE`,
this tool produces executable code that runs on the target device.
Only one cross-canadian compiler is produced per architecture since
they can be targeted at different processor optimizations using
@@ -1623,7 +1623,7 @@ Shared State Cache
==================
By design, the OpenEmbedded build system builds everything from scratch
-unless `BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__ can determine
+unless :term:`BitBake` can determine
that parts do not need to be rebuilt. Fundamentally, building from
scratch is attractive as it means all parts are built fresh and no
possibility of stale data exists that can cause problems. When
@@ -1664,7 +1664,7 @@ them if they are deemed to be valid.
.. note::
- The build system does not maintain
- ```PR`` <&YOCTO_DOCS_REF_URL;#var-PR>`__ information as part of
+ :term:`PR` information as part of
the shared state packages. Consequently, considerations exist that
affect maintaining shared state feeds. For information on how the
build system works with packages and can track incrementing ``PR``
@@ -1695,8 +1695,8 @@ works on a per-task basis rather than a per-recipe basis. You might
wonder why using a per-task basis is preferred over a per-recipe basis.
To help explain, consider having the IPK packaging backend enabled and
then switching to DEB. In this case, the
-```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__ and
-```do_package`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package>`__ task outputs
+:ref:`ref-tasks-install` and
+:ref:`ref-tasks-package` task outputs
are still valid. However, with a per-recipe approach, the build would
not include the ``.deb`` files. Consequently, you would have to
invalidate the whole build and rerun it. Rerunning everything is not the
@@ -1720,7 +1720,7 @@ you a good idea of when the task's data changes.
To complicate the problem, there are things that should not be included
in the checksum. First, there is the actual specific build path of a
-given task - the ```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__. It
+given task - the :term:`WORKDIR`. It
does not matter if the work directory changes because it should not
affect the output for target packages. Also, the build process has the
objective of making native or cross packages relocatable.
@@ -1755,9 +1755,9 @@ Like the ``WORKDIR`` case, situations exist where dependencies should be
ignored. For these situations, 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
-```PACKAGE_ARCHS`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCHS>`__ variable
+:term:`PACKAGE_ARCHS` variable
does not depend on the value of
-```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__, even if it does
+:term:`MACHINE`, even if it does
reference it.
Equally, there are cases where you need to add dependencies BitBake is
@@ -1795,9 +1795,9 @@ 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
-```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__ since that variable
+:term:`WORKDIR` since that variable
is actually constructed as a path within
-```TMPDIR`` <&YOCTO_DOCS_REF_URL;#var-TMPDIR>`__, which is on the
+:term:`TMPDIR`, which is on the
whitelist.
The rules for deciding which hashes of dependent tasks to include
@@ -1806,7 +1806,7 @@ accomplished with a Python function. The code in
``meta/lib/oe/sstatesig.py`` shows two examples of this and also
illustrates how you can insert your own policy into the system if so
desired. This file defines the two basic signature generators
-`OE-Core <&YOCTO_DOCS_REF_URL;#oe-core>`__ uses: "OEBasic" and
+:term:`OpenEmbedded-Core (OE-Core)` uses: "OEBasic" and
"OEBasicHash". By default, a dummy "noop" signature handler is enabled
in BitBake. This means that behavior is unchanged from previous
versions. OE-Core uses the "OEBasicHash" signature handler by default
@@ -1816,7 +1816,7 @@ as the "OEBasic" version but adds the task hash to the `stamp
files <#stamp-files-and-the-rerunning-of-tasks>`__. 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
-```PR`` <&YOCTO_DOCS_REF_URL;#var-PR>`__ values, and changes to metadata
+:term:`PR` values, and changes to metadata
automatically ripple across the build.
It is also worth noting that the end result of these signature
@@ -1842,7 +1842,7 @@ half the problem of supporting a shared state. The other half of the
problem is being able to use checksum information during the build and
being able to reuse or rebuild specific components.
-The ```sstate`` <&YOCTO_DOCS_REF_URL;#ref-classes-sstate>`__ class is a
+The :ref:`sstate ` class is a
relatively generic implementation of how to "capture" a snapshot of a
given task. The idea is that the build process does not care about the
source of a task's output. Output could be freshly built or it could be
@@ -1850,18 +1850,18 @@ downloaded and unpacked from somewhere. In other words, the build
process does not need to worry about its origin.
Two types of output exist. One type is just about creating a directory
-in ```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__. A good example is
+in :term:`WORKDIR`. A good example is
the output of either
-```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__ or
-```do_package`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package>`__. The other
+:ref:`ref-tasks-install` or
+:ref:`ref-tasks-package`. The other
type of output occurs when a set of data is merged into a shared
directory tree such as the sysroot.
The Yocto Project team has tried to keep the details of the
implementation hidden in ``sstate`` class. From a user's perspective,
adding shared state wrapping to a task is as simple as this
-```do_deploy`` <&YOCTO_DOCS_REF_URL;#ref-tasks-deploy>`__ example taken
-from the ```deploy`` <&YOCTO_DOCS_REF_URL;#ref-classes-deploy>`__ class:
+:ref:`ref-tasks-deploy` example taken
+from the :ref:`deploy ` class:
DEPLOYDIR = "${WORKDIR}/deploy-${PN}" SSTATETASKS += "do_deploy"
do_deploy[sstate-inputdirs] = "${DEPLOYDIR}"
do_deploy[sstate-outputdirs] = "${DEPLOY_DIR_IMAGE}" python
@@ -1871,9 +1871,9 @@ do_deploy[dirs] = "${DEPLOYDIR} ${B}" do_deploy[stamp-extra-info] =
- Adding "do_deploy" to ``SSTATETASKS`` adds some required
sstate-related processing, which is implemented in the
- ```sstate`` <&YOCTO_DOCS_REF_URL;#ref-classes-sstate>`__ class, to
+ :ref:`sstate ` class, to
before and after the
- ```do_deploy`` <&YOCTO_DOCS_REF_URL;#ref-tasks-deploy>`__ task.
+ :ref:`ref-tasks-deploy` task.
- The ``do_deploy[sstate-inputdirs] = "${DEPLOYDIR}"`` declares that
``do_deploy`` places its output in ``${DEPLOYDIR}`` when run normally
@@ -1965,8 +1965,8 @@ do_deploy[dirs] = "${DEPLOYDIR} ${B}" do_deploy[stamp-extra-info] =
"${PACKAGELOCK}"
Behind the scenes, the shared state code works by looking in
-```SSTATE_DIR`` <&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR>`__ and
-```SSTATE_MIRRORS`` <&YOCTO_DOCS_REF_URL;#var-SSTATE_MIRRORS>`__ for
+:term:`SSTATE_DIR` and
+:term:`SSTATE_MIRRORS` for
shared state files. Here is an example: SSTATE_MIRRORS ?= "\\ file://.\*
http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \\n \\
file://.\* file:///some/local/dir/sstate/PATH"
@@ -1998,7 +1998,7 @@ tasks on which it is dependent are not executed.
As a real world example, the aim is when building an IPK-based image,
only the
-```do_package_write_ipk`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_ipk>`__
+:ref:`ref-tasks-package_write_ipk`
tasks would have their shared state packages fetched and extracted.
Since the sysroot is not used, it would never get extracted. This is
another reason why a task-based approach is preferred over a
@@ -2011,22 +2011,22 @@ Automatically Added Runtime Dependencies
The OpenEmbedded build system automatically adds common types of runtime
dependencies between packages, which means that you do not need to
explicitly declare the packages using
-```RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-RDEPENDS>`__. Three automatic
+:term:`RDEPENDS`. Three automatic
mechanisms exist (``shlibdeps``, ``pcdeps``, and ``depchains``) that
handle shared libraries, package configuration (pkg-config) modules, and
``-dev`` and ``-dbg`` packages, respectively. For other types of runtime
dependencies, you must manually declare the dependencies.
- ``shlibdeps``: During the
- ```do_package`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package>`__ task of
+ :ref:`ref-tasks-package` task of
each recipe, all shared libraries installed by the recipe are
located. For each shared library, the package that contains the
shared library is registered as providing the shared library. More
specifically, the package is registered as providing the
`soname `__ of the library. The
resulting shared-library-to-package mapping is saved globally in
- ```PKGDATA_DIR`` <&YOCTO_DOCS_REF_URL;#var-PKGDATA_DIR>`__ by the
- ```do_packagedata`` <&YOCTO_DOCS_REF_URL;#ref-tasks-packagedata>`__
+ :term:`PKGDATA_DIR` by the
+ :ref:`ref-tasks-packagedata`
task.
Simultaneously, all executables and shared libraries installed by the
@@ -2047,7 +2047,7 @@ dependencies, you must manually declare the dependencies.
If you want to avoid a package being registered as providing a
particular shared library (e.g. because the library is for internal
use only), then add the library to
- ```PRIVATE_LIBS`` <&YOCTO_DOCS_REF_URL;#var-PRIVATE_LIBS>`__ inside
+ :term:`PRIVATE_LIBS` inside
the package's recipe.
- ``pcdeps``: During the ``do_package`` task of each recipe, all
@@ -2082,7 +2082,7 @@ dependencies, you must manually declare the dependencies.
need for a dependency between the packages.
The dependencies added by ``depchains`` are in the form of
- ```RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS>`__.
+ :term:`RRECOMMENDS`.
.. note::
@@ -2101,11 +2101,11 @@ dependencies, you must manually declare the dependencies.
To ensure that the dependency chain is never broken, ``-dev`` and
``-dbg`` packages are always generated by default, even if the
packages turn out to be empty. See the
- ```ALLOW_EMPTY`` <&YOCTO_DOCS_REF_URL;#var-ALLOW_EMPTY>`__ variable
+ :term:`ALLOW_EMPTY` variable
for more information.
The ``do_package`` task depends on the ``do_packagedata`` task of each
-recipe in ```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__ through use
+recipe in :term:`DEPENDS` through use
of a ``[``\ ```deptask`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]``
declaration, which guarantees that the required
shared-library/module-to-package mapping information will be available
@@ -2116,15 +2116,15 @@ Fakeroot and Pseudo
Some tasks are easier to implement when allowed to perform certain
operations that are normally reserved for the root user (e.g.
-```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__,
+:ref:`ref-tasks-install`,
```do_package_write*`` <&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_deb>`__,
-```do_rootfs`` <&YOCTO_DOCS_REF_URL;#ref-tasks-rootfs>`__, and
+:ref:`ref-tasks-rootfs`, and
```do_image*`` <&YOCTO_DOCS_REF_URL;#ref-tasks-image>`__). For example,
the ``do_install`` task benefits from being able to set the UID and GID
of installed files to arbitrary values.
One approach to allowing tasks to perform root-only operations would be
-to require `BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__ to run as
+to require :term:`BitBake` to run as
root. However, this method is cumbersome and has security issues. The
approach that is actually used is to run tasks that benefit from root
privileges in a "fake" root environment. Within this environment, the
@@ -2148,7 +2148,7 @@ which results in the illusion of running as root. To keep track of
"fake" file ownership and permissions resulting from operations that
require root permissions, Pseudo uses an SQLite 3 database. This
database is stored in
-``${``\ ```WORKDIR`` <&YOCTO_DOCS_REF_URL;#var-WORKDIR>`__\ ``}/pseudo/files.db``
+``${``\ :term:`WORKDIR`\ ``}/pseudo/files.db``
for individual recipes. Storing the database in a file as opposed to in
memory gives persistence between tasks and builds, which is not
accomplished using fakeroot.
diff --git a/documentation/overview-manual/overview-manual-development-environment.rst b/documentation/overview-manual/overview-manual-development-environment.rst
index d59e52c488..745d2ecf91 100644
--- a/documentation/overview-manual/overview-manual-development-environment.rst
+++ b/documentation/overview-manual/overview-manual-development-environment.rst
@@ -149,7 +149,7 @@ Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. From the
interface, you can click on any particular item in the "Name" column and
see the URL at the bottom of the page that you need to clone a Git
repository for that particular item. Having a local Git repository of
-the `Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__, which
+the :term:`Source Directory`, which
is usually named "poky", allows you to make changes, contribute to the
history, and ultimately enhance the Yocto Project's tools, Board Support
Packages, and so forth.
@@ -636,7 +636,7 @@ find information on the GNU GPL
When you build an image using the Yocto Project, the build process uses
a known list of licenses to ensure compliance. You can find this list in
-the `Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ at
+the :term:`Source Directory` at
``meta/files/common-licenses``. Once the build completes, the list of
all licenses found and used during that build are kept in the `Build
Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ at
@@ -660,7 +660,7 @@ that conform to the Open Source Definition (OSD).
You can find a list of the combined SPDX and OSI licenses that the Yocto
Project uses in the ``meta/files/common-licenses`` directory in your
-`Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__.
+:term:`Source Directory`.
For information that can help you maintain compliance with various open
source licensing during the lifecycle of a product created using the
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst
index 3f845731a0..b27412cb25 100644
--- a/documentation/overview-manual/overview-manual-yp-intro.rst
+++ b/documentation/overview-manual/overview-manual-yp-intro.rst
@@ -260,7 +260,7 @@ accomplish this through a recipe that is a BitBake append
Yocto Project Board Support Packages (BSP) Developer's Guide
.
-The `Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__
+The :term:`Source Directory`
contains both general layers and BSP layers right out of the box. You
can easily identify layers that ship with a Yocto Project release in the
Source Directory by their names. Layers typically have names that begin
@@ -461,7 +461,7 @@ Open-Embedded Build System Components
-------------------------------------
The following list consists of components associated with the
-`OpenEmbedded build system <&YOCTO_DOCS_REF_URL;#build-system-term>`__:
+:term:`OpenEmbedded Build System`:
- *BitBake:* BitBake is a core component of the Yocto Project and is
used by the OpenEmbedded build system to build images. While BitBake
@@ -508,7 +508,7 @@ Reference Distribution (Poky)
-----------------------------
Poky is the Yocto Project reference distribution. It contains the
-`Open-Embedded build system <&YOCTO_DOCS_REF_URL;#build-system-term>`__
+:term:`OpenEmbedded Build System`
(BitBake and OE-Core) as well as a set of metadata to get you started
building your own distribution. See the
`figure <#what-is-the-yocto-project>`__ in "What is the Yocto Project?"
@@ -618,7 +618,7 @@ Project.
- *Native Linux Host:* By far the best option for a Build Host. A
system running Linux as its native operating system allows you to
develop software by directly using the
- `BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__ tool. You can
+ :term:`BitBake` tool. You can
accomplish all aspects of development from a familiar shell of a
supported Linux distribution.
@@ -684,9 +684,9 @@ Reference Embedded Distribution (Poky)
"Poky", which is pronounced *Pock*-ee, is the name of the Yocto
Project's reference distribution or Reference OS Kit. Poky contains the
-`OpenEmbedded Build System <&YOCTO_DOCS_REF_URL;#build-system-term>`__
-(`BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__ and
-`OpenEmbedded-Core <&YOCTO_DOCS_REF_URL;#oe-core>`__) as well as a set
+:term:`OpenEmbedded Build System`
+(:term:`BitBake` and
+:term:`OpenEmbedded-Core (OE-Core)`) as well as a set
of `metadata <&YOCTO_DOCS_REF_URL;#metadata>`__ to get you started
building your own distro. In other words, Poky is a base specification
of the functionality needed for a typical embedded system as well as the
@@ -923,9 +923,9 @@ helpful for getting started:
Another point worth noting is that historically within the Yocto
Project, recipes were referred to as packages - thus, the existence
of several BitBake variables that are seemingly mis-named, (e.g.
- ```PR`` <&YOCTO_DOCS_REF_URL;#var-PR>`__,
- ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__, and
- ```PE`` <&YOCTO_DOCS_REF_URL;#var-PE>`__).
+ :term:`PR`,
+ :term:`PV`, and
+ :term:`PE`).
- *Poky:* Poky is a reference embedded distribution and a reference
test configuration. Poky provides the following:
diff --git a/documentation/profile-manual/profile-manual-intro.rst b/documentation/profile-manual/profile-manual-intro.rst
index d4d0ba4dc8..5d51df74dc 100644
--- a/documentation/profile-manual/profile-manual-intro.rst
+++ b/documentation/profile-manual/profile-manual-intro.rst
@@ -51,7 +51,7 @@ well e.g.: $ bitbake core-image-sato
it packages, which makes it difficult to use some of the tools.
You can prevent that by setting the
- ```INHIBIT_PACKAGE_STRIP`` <&YOCTO_DOCS_REF_URL;#var-INHIBIT_PACKAGE_STRIP>`__
+ :term:`INHIBIT_PACKAGE_STRIP`
variable to "1" in your ``local.conf`` when you build the image:
INHIBIT_PACKAGE_STRIP = "1" The above setting will noticeably increase
@@ -64,6 +64,6 @@ To generate debug info for packages, you can add dbg-pkgs to
EXTRA_IMAGE_FEATURES in local.conf. For example: EXTRA_IMAGE_FEATURES =
"debug-tweaks tools-profile dbg-pkgs" Additionally, in order to generate
the right type of debuginfo, we also need to set
-```PACKAGE_DEBUG_SPLIT_STYLE`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_DEBUG_SPLIT_STYLE>`__
+:term:`PACKAGE_DEBUG_SPLIT_STYLE`
in the ``local.conf`` file: PACKAGE_DEBUG_SPLIT_STYLE =
'debug-file-directory'
diff --git a/documentation/profile-manual/profile-manual-usage.rst b/documentation/profile-manual/profile-manual-usage.rst
index a2206cc829..b97a1c6e96 100644
--- a/documentation/profile-manual/profile-manual-usage.rst
+++ b/documentation/profile-manual/profile-manual-usage.rst
@@ -50,7 +50,7 @@ outlined in the General Setup section.
In particular, you'll get the most mileage out of perf if you profile an
image built with the following in your ``local.conf`` file:
-`INHIBIT_PACKAGE_STRIP <&YOCTO_DOCS_REF_URL;#var-INHIBIT_PACKAGE_STRIP>`__
+:term:`INHIBIT_PACKAGE_STRIP`
= "1"
perf runs on the target system for the most part. You can archive
@@ -246,7 +246,7 @@ system.
One way around that is to put the following in your ``local.conf`` file
when you build the image:
-`INHIBIT_PACKAGE_STRIP <&YOCTO_DOCS_REF_URL;#var-INHIBIT_PACKAGE_STRIP>`__
+:term:`INHIBIT_PACKAGE_STRIP`
= "1" However, we already have an image with the binaries stripped, so
what can we do to get perf to resolve the symbols? Basically we need to
install the debuginfo for the busybox package.
@@ -256,7 +256,7 @@ dbg-pkgs to EXTRA_IMAGE_FEATURES in local.conf. For example:
EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile dbg-pkgs"
Additionally, in order to generate the type of debuginfo that perf
understands, we also need to set
-```PACKAGE_DEBUG_SPLIT_STYLE`` <&YOCTO_DOCS_REF_URL;#var-PACKAGE_DEBUG_SPLIT_STYLE>`__
+:term:`PACKAGE_DEBUG_SPLIT_STYLE`
in the ``local.conf`` file: PACKAGE_DEBUG_SPLIT_STYLE =
'debug-file-directory' Once we've done that, we can install the
debuginfo for busybox. The debug packages once built can be found in
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index d3dac28b0f..07244a0311 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -8,7 +8,7 @@ FAQ
**A:** The term "`Poky <#>`__" refers to the specific reference build
system that the Yocto Project provides. Poky is based on
-`OE-Core <#oe-core>`__ and `BitBake <#bitbake-term>`__. Thus, the
+:term:`OpenEmbedded-Core (OE-Core)` and :term:`BitBake`. Thus, the
generic term used here for the build system is the "OpenEmbedded build
system." Development in the Yocto Project using Poky is closely tied to
OpenEmbedded, with changes always being merged to OE-Core or BitBake
@@ -29,7 +29,7 @@ steps on how to update your build tools.
**A:** There are three areas that help with stability;
-- The Yocto Project team keeps `OE-Core <#oe-core>`__ small and
+- The Yocto Project team keeps :term:`OpenEmbedded-Core (OE-Core)` small and
focused, containing around 830 recipes as opposed to the thousands
available in other OpenEmbedded community layers. Keeping it small
makes it easy to test and maintain.
@@ -227,19 +227,19 @@ meta-MACHINE/recipes-bsp/netbase/netbase_5.0.bbappend
size, you need to set various configurations:
- *Image Size:* The OpenEmbedded build system uses the
- ```IMAGE_ROOTFS_SIZE`` <#var-IMAGE_ROOTFS_SIZE>`__ variable to define
+ :term:`IMAGE_ROOTFS_SIZE` variable to define
the size of the image in Kbytes. The build system determines the size
by taking into account the initial root filesystem size before any
modifications such as requested size for the image and any requested
additional free disk space to be added to the image.
- *Overhead:* Use the
- ```IMAGE_OVERHEAD_FACTOR`` <#var-IMAGE_OVERHEAD_FACTOR>`__ variable
+ :term:`IMAGE_OVERHEAD_FACTOR` variable
to define the multiplier that the build system applies to the initial
image size, which is 1.3 by default.
- *Additional Free Space:* Use the
- ```IMAGE_ROOTFS_EXTRA_SPACE`` <#var-IMAGE_ROOTFS_EXTRA_SPACE>`__
+ :term:`IMAGE_ROOTFS_EXTRA_SPACE`
variable to add additional free space to the image. The build system
adds this space to the image after it determines its
``IMAGE_ROOTFS_SIZE``.
@@ -281,8 +281,8 @@ environments if HTTP transport is available.
When the build system searches for source code, it first tries the local
download directory. If that location fails, Poky tries
-```PREMIRRORS`` <#var-PREMIRRORS>`__, the upstream source, and then
-```MIRRORS`` <#var-MIRRORS>`__ in that order.
+:term:`PREMIRRORS`, the upstream source, and then
+:term:`MIRRORS` in that order.
Assuming your distribution is "poky", the OpenEmbedded build system uses
the Yocto Project source ``PREMIRRORS`` by default for SCM-based
@@ -409,7 +409,7 @@ my recipe is installing to the wrong place, or I am getting permissions
errors during the do_install task in my recipe! What is wrong?
**A:** This situation results when a build system does not recognize the
-environment variables supplied to it by `BitBake <#bitbake-term>`__. The
+environment variables supplied to it by :term:`BitBake`. The
incident that prompted this FAQ entry involved a Makefile that used an
environment variable named ``BINDIR`` instead of the more standard
variable ``bindir``. The makefile's hardcoded default value of
diff --git a/documentation/ref-manual/migration.rst b/documentation/ref-manual/migration.rst
index 8a309d003b..b8d27f3325 100644
--- a/documentation/ref-manual/migration.rst
+++ b/documentation/ref-manual/migration.rst
@@ -68,7 +68,7 @@ Local Configuration
-------------------
Differences include changes for
-```SSTATE_MIRRORS`` <#var-SSTATE_MIRRORS>`__ and ``bblayers.conf``.
+:term:`SSTATE_MIRRORS` and ``bblayers.conf``.
.. _migration-1.3-sstate-mirrors:
@@ -76,13 +76,13 @@ SSTATE_MIRRORS
~~~~~~~~~~~~~~
The shared state cache (sstate-cache), as pointed to by
-```SSTATE_DIR`` <#var-SSTATE_DIR>`__, by default now has two-character
+:term:`SSTATE_DIR`, by default now has two-character
subdirectories to prevent issues arising from too many files in the same
directory. Also, native sstate-cache packages, which are built to run on
the host system, will go into a subdirectory named using the distro ID
string. If you copy the newly structured sstate-cache to a mirror
location (either local or remote) and then point to it in
-```SSTATE_MIRRORS`` <#var-SSTATE_MIRRORS>`__, you need to append "PATH"
+:term:`SSTATE_MIRRORS`, you need to append "PATH"
to the end of the mirror URL so that the path used by BitBake before the
mirror substitution is appended to the path used to access the mirror.
Here is an example: SSTATE_MIRRORS = "file://.\*
@@ -138,7 +138,7 @@ four-space indentation.
proto= in SRC_URI
~~~~~~~~~~~~~~~~~
-Any use of ``proto=`` in ```SRC_URI`` <#var-SRC_URI>`__ needs to be
+Any use of ``proto=`` in :term:`SRC_URI` needs to be
changed to ``protocol=``. In particular, this applies to the following
URIs:
@@ -161,7 +161,7 @@ nativesdk
The suffix ``nativesdk`` is now implemented as a prefix, which
simplifies a lot of the packaging code for ``nativesdk`` recipes. All
custom ``nativesdk`` recipes, which are relocatable packages that are
-native to ```SDK_ARCH`` <#var-SDK_ARCH>`__, and any references need to
+native to :term:`SDK_ARCH`, and any references need to
be updated to use ``nativesdk-*`` instead of ``*-nativesdk``.
.. _migration-1.3-task-recipes:
@@ -179,8 +179,8 @@ recipes to ``packagegroup-*``, and change them to inherit
``packagegroup`` instead of ``task``, as well as taking the opportunity
to remove anything now handled by ``packagegroup.bbclass``, such as
providing ``-dev`` and ``-dbg`` packages, setting
-```LIC_FILES_CHKSUM`` <#var-LIC_FILES_CHKSUM>`__, and so forth. See the
-"```packagegroup.bbclass`` <#ref-classes-packagegroup>`__" section for
+:term:`LIC_FILES_CHKSUM`, and so forth. See the
+":ref:`packagegroup.bbclass `" section for
further details.
.. _migration-1.3-image-features:
@@ -189,7 +189,7 @@ IMAGE_FEATURES
~~~~~~~~~~~~~~
Image recipes that previously included "apps-console-core" in
-```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ should now include "splash"
+:term:`IMAGE_FEATURES` should now include "splash"
instead to enable the boot-up splash screen. Retaining
"apps-console-core" will still include the splash screen but generates a
warning. The "apps-x11-core" and "apps-x11-games" ``IMAGE_FEATURES``
@@ -202,7 +202,7 @@ Removed Recipes
The following recipes have been removed. For most of them, it is
unlikely that you would have any references to them in your own
-`Metadata <#metadata>`__. However, you should check your metadata
+:term:`Metadata`. However, you should check your metadata
against this list to be sure:
- *``libx11-trim``*: Replaced by ``libx11``, which has a negligible
@@ -247,7 +247,7 @@ Linux Kernel Naming
-------------------
The naming scheme for kernel output binaries has been changed to now
-include ```PE`` <#var-PE>`__ as part of the filename:
+include :term:`PE` as part of the filename:
KERNEL_IMAGE_BASE_NAME ?=
"${KERNEL_IMAGETYPE}-${PE}-${PV}-${PR}-${MACHINE}-${DATETIME}"
@@ -276,13 +276,13 @@ Differences include the following:
a comment.
- *Package Name Overrides:* The runtime package specific variables
- ```RDEPENDS`` <#var-RDEPENDS>`__,
- ```RRECOMMENDS`` <#var-RRECOMMENDS>`__,
- ```RSUGGESTS`` <#var-RSUGGESTS>`__,
- ```RPROVIDES`` <#var-RPROVIDES>`__,
- ```RCONFLICTS`` <#var-RCONFLICTS>`__,
- ```RREPLACES`` <#var-RREPLACES>`__, ```FILES`` <#var-FILES>`__,
- ```ALLOW_EMPTY`` <#var-ALLOW_EMPTY>`__, and the pre, post, install,
+ :term:`RDEPENDS`,
+ :term:`RRECOMMENDS`,
+ :term:`RSUGGESTS`,
+ :term:`RPROVIDES`,
+ :term:`RCONFLICTS`,
+ :term:`RREPLACES`, :term:`FILES`,
+ :term:`ALLOW_EMPTY`, and the pre, post, install,
and uninstall script functions ``pkg_preinst``, ``pkg_postinst``,
``pkg_prerm``, and ``pkg_postrm`` should always have a package name
override. For example, use ``RDEPENDS_${PN}`` for the main package
@@ -305,15 +305,15 @@ Differences include the following:
you have missing declared dependencies.
- *Scanning Directory Names:* When scanning for files in
- ```SRC_URI`` <#var-SRC_URI>`__, the build system now uses
- ```FILESOVERRIDES`` <#var-FILESOVERRIDES>`__ instead of
- ```OVERRIDES`` <#var-OVERRIDES>`__ for the directory names. In
+ :term:`SRC_URI`, the build system now uses
+ :term:`FILESOVERRIDES` instead of
+ :term:`OVERRIDES` for the directory names. In
general, the values previously in ``OVERRIDES`` are now in
``FILESOVERRIDES`` as well. However, if you relied upon an additional
value you previously added to ``OVERRIDES``, you might now need to
add it to ``FILESOVERRIDES`` unless you are already adding it through
- the ```MACHINEOVERRIDES`` <#var-MACHINEOVERRIDES>`__ or
- ```DISTROOVERRIDES`` <#var-DISTROOVERRIDES>`__ variables, as
+ the :term:`MACHINEOVERRIDES` or
+ :term:`DISTROOVERRIDES` variables, as
appropriate. For more related changes, see the
"`Variables <#migration-1.4-variables>`__" section.
@@ -335,7 +335,7 @@ Custom Interfaces File (netbase change)
If you have created your own custom ``etc/network/interfaces`` file by
creating an append file for the ``netbase`` recipe, you now need to
create an append file for the ``init-ifupdown`` recipe instead, which
-you can find in the `Source Directory <#source-directory>`__ at
+you can find in the :term:`Source Directory` at
``meta/recipes-core/init-ifupdown``. For information on how to use
append files, see the "`Using .bbappend
Files <&YOCTO_DOCS_DEV_URL;#using-bbappend-files>`__" section in the
@@ -363,24 +363,24 @@ The following variables have changed:
- *``SANITY_TESTED_DISTROS``:* This variable now uses a distribution
ID, which is composed of the host distributor ID followed by the
release. Previously,
- ```SANITY_TESTED_DISTROS`` <#var-SANITY_TESTED_DISTROS>`__ was
+ :term:`SANITY_TESTED_DISTROS` was
composed of the description field. For example, "Ubuntu 12.10"
becomes "Ubuntu-12.10". You do not need to worry about this change if
you are not specifically setting this variable, or if you are
specifically setting it to "".
-- *``SRC_URI``:* The ``${``\ ```PN`` <#var-PN>`__\ ``}``,
- ``${``\ ```PF`` <#var-PF>`__\ ``}``,
- ``${``\ ```P`` <#var-P>`__\ ``}``, and ``FILE_DIRNAME`` directories
+- *``SRC_URI``:* The ``${``\ :term:`PN`\ ``}``,
+ ``${``\ :term:`PF`\ ``}``,
+ ``${``\ :term:`P`\ ``}``, and ``FILE_DIRNAME`` directories
have been dropped from the default value of the
- ```FILESPATH`` <#var-FILESPATH>`__ variable, which is used as the
+ :term:`FILESPATH` variable, which is used as the
search path for finding files referred to in
- ```SRC_URI`` <#var-SRC_URI>`__. If you have a recipe that relied upon
+ :term:`SRC_URI`. If you have a recipe that relied upon
these directories, which would be unusual, then you will need to add
the appropriate paths within the recipe or, alternatively, rearrange
the files. The most common locations are still covered by ``${BP}``,
``${BPN}``, and "files", which all remain in the default value of
- ```FILESPATH`` <#var-FILESPATH>`__.
+ :term:`FILESPATH`.
.. _migration-target-package-management-with-rpm:
@@ -554,9 +554,9 @@ The following changes have been made that relate to BitBake:
- The ``bitbake-runtask`` script has been removed.
-- ``${``\ ```P`` <#var-P>`__\ ``}`` and
- ``${``\ ```PF`` <#var-PF>`__\ ``}`` are no longer added to
- ```PROVIDES`` <#var-PROVIDES>`__ by default in ``bitbake.conf``.
+- ``${``\ :term:`P`\ ``}`` and
+ ``${``\ :term:`PF`\ ``}`` are no longer added to
+ :term:`PROVIDES` by default in ``bitbake.conf``.
These version-specific ``PROVIDES`` items were seldom used.
Attempting to use them could result in two versions being built
simultaneously rather than just one version due to the way BitBake
@@ -569,19 +569,19 @@ QA Warnings
The following changes have been made to the package QA checks:
-- If you have customized ```ERROR_QA`` <#var-ERROR_QA>`__ or
- ```WARN_QA`` <#var-WARN_QA>`__ values in your configuration, check
+- If you have customized :term:`ERROR_QA` or
+ :term:`WARN_QA` values in your configuration, check
that they contain all of the issues that you wish to be reported.
Previous Yocto Project versions contained a bug that meant that any
item not mentioned in ``ERROR_QA`` or ``WARN_QA`` would be treated as
a warning. Consequently, several important items were not already in
the default value of ``WARN_QA``. All of the possible QA checks are
- now documented in the "```insane.bbclass`` <#ref-classes-insane>`__"
+ now documented in the ":ref:`insane.bbclass `"
section.
- An additional QA check has been added to check if
``/usr/share/info/dir`` is being installed. Your recipe should delete
- this file within ```do_install`` <#ref-tasks-install>`__ if "make
+ this file within :ref:`ref-tasks-install` if "make
install" is installing it.
- If you are using the buildhistory class, the check for the package
@@ -591,7 +591,7 @@ The following changes have been made to the package QA checks:
"version-going-backwards" to your value for one or the other
variables depending on how you wish it to be handled. See the
documented QA checks in the
- "```insane.bbclass`` <#ref-classes-insane>`__" section.
+ ":ref:`insane.bbclass `" section.
.. _migration-1.5-directory-layout-changes:
@@ -601,25 +601,25 @@ Directory Layout Changes
The following directory changes exist:
- Output SDK installer files are now named to include the image name
- and tuning architecture through the ```SDK_NAME`` <#var-SDK_NAME>`__
+ and tuning architecture through the :term:`SDK_NAME`
variable.
- Images and related files are now installed into a directory that is
specific to the machine, instead of a parent directory containing
output files for multiple machines. The
- ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__ variable continues
+ :term:`DEPLOY_DIR_IMAGE` variable continues
to point to the directory containing images for the current
- ```MACHINE`` <#var-MACHINE>`__ and should be used anywhere there is a
+ :term:`MACHINE` and should be used anywhere there is a
need to refer to this directory. The ``runqemu`` script now uses this
variable to find images and kernel binaries and will use BitBake to
determine the directory. Alternatively, you can set the
``DEPLOY_DIR_IMAGE`` variable in the external environment.
- When buildhistory is enabled, its output is now written under the
- `Build Directory <#build-directory>`__ rather than
- ```TMPDIR`` <#var-TMPDIR>`__. Doing so makes it easier to delete
+ :term:`Build Directory` rather than
+ :term:`TMPDIR`. Doing so makes it easier to delete
``TMPDIR`` and preserve the build history. Additionally, data for
- produced SDKs is now split by ```IMAGE_NAME`` <#var-IMAGE_NAME>`__.
+ produced SDKs is now split by :term:`IMAGE_NAME`.
- The ``pkgdata`` directory produced as part of the packaging process
has been collapsed into a single machine-specific directory. This
@@ -632,7 +632,7 @@ Shortened Git ``SRCREV`` Values
-------------------------------
BitBake will now shorten revisions from Git repositories from the normal
-40 characters down to 10 characters within ```SRCPV`` <#var-SRCPV>`__
+40 characters down to 10 characters within :term:`SRCPV`
for improved usability in path and file names. This change should be
safe within contexts where these revisions are used because the chances
of spatially close collisions is very low. Distant collisions are not a
@@ -644,16 +644,16 @@ major issue in the way the values are used.
------------------
The following changes have been made that relate to
-```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__:
+:term:`IMAGE_FEATURES`:
- The value of ``IMAGE_FEATURES`` is now validated to ensure invalid
feature items are not added. Some users mistakenly add package names
to this variable instead of using
- ```IMAGE_INSTALL`` <#var-IMAGE_INSTALL>`__ in order to have the
+ :term:`IMAGE_INSTALL` in order to have the
package added to the image, which does not work. This change is
intended to catch those kinds of situations. Valid ``IMAGE_FEATURES``
are drawn from ``PACKAGE_GROUP`` definitions,
- ```COMPLEMENTARY_GLOB`` <#var-COMPLEMENTARY_GLOB>`__ and a new
+ :term:`COMPLEMENTARY_GLOB` and a new
"validitems" varflag on ``IMAGE_FEATURES``. The "validitems" varflag
change allows additional features to be added if they are not
provided using the previous two mechanisms.
@@ -682,9 +682,9 @@ Removal of Package Manager Database Within Image Recipes
The image ``core-image-minimal`` no longer adds
``remove_packaging_data_files`` to
-```ROOTFS_POSTPROCESS_COMMAND`` <#var-ROOTFS_POSTPROCESS_COMMAND>`__.
+:term:`ROOTFS_POSTPROCESS_COMMAND`.
This addition is now handled automatically when "package-management" is
-not in ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__. If you have custom
+not in :term:`IMAGE_FEATURES`. If you have custom
image recipes that make this addition, you should remove the lines, as
they are not needed and might interfere with correct operation of
postinstall scripts.
@@ -694,7 +694,7 @@ postinstall scripts.
Images Now Rebuild Only on Changes Instead of Every Time
--------------------------------------------------------
-The ```do_rootfs`` <#ref-tasks-rootfs>`__ and other related image
+The :ref:`ref-tasks-rootfs` and other related image
construction tasks are no longer marked as "nostamp". Consequently, they
will only be re-executed when their inputs have changed. Previous
versions of the OpenEmbedded build system always rebuilt the image when
@@ -711,7 +711,7 @@ them from ``task-*`` to ``packagegroup-*`` and inherit packagegroup
instead.
For more information, see the
-"```packagegroup.bbclass`` <#ref-classes-packagegroup>`__" section.
+":ref:`packagegroup.bbclass `" section.
.. _migration-1.5-busybox:
@@ -723,7 +723,7 @@ root for those components that need it, and another for the rest of the
components. Splitting BusyBox allows for optimization that eliminates
the ``tinylogin`` recipe as recommended by upstream. You can disable
this split by setting
-```BUSYBOX_SPLIT_SUID`` <#var-BUSYBOX_SPLIT_SUID>`__ to "0".
+:term:`BUSYBOX_SPLIT_SUID` to "0".
.. _migration-1.5-automated-image-testing:
@@ -771,7 +771,7 @@ section in the Yocto Project Development Tasks Manual.
Following are changes to ``udev``:
- ``udev`` no longer brings in ``udev-extraconf`` automatically through
- ```RRECOMMENDS`` <#var-RRECOMMENDS>`__, since this was originally
+ :term:`RRECOMMENDS`, since this was originally
intended to be optional. If you need the extra rules, then add
``udev-extraconf`` to your image.
@@ -821,13 +821,13 @@ Following is a list of short entries describing other changes:
- ``alsa-state``: Provide an empty ``asound.conf`` by default.
- ``classes/image``: Ensure
- ```BAD_RECOMMENDATIONS`` <#var-BAD_RECOMMENDATIONS>`__ supports
+ :term:`BAD_RECOMMENDATIONS` supports
pre-renamed package names.
- ``classes/rootfs_rpm``: Implement ``BAD_RECOMMENDATIONS`` for RPM.
- ``systemd``: Remove ``systemd_unitdir`` if ``systemd`` is not in
- ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__.
+ :term:`DISTRO_FEATURES`.
- ``systemd``: Remove ``init.d`` dir if ``systemd`` unit file is
present and ``sysvinit`` is not a distro feature.
@@ -854,7 +854,7 @@ Project 1.6 Release from the prior release.
``archiver`` Class
------------------
-The ```archiver`` <#ref-classes-archiver>`__ class has been rewritten
+The :ref:`archiver ` class has been rewritten
and its configuration has been simplified. For more details on the
source archiver, see the "`Maintaining Open Source License Compliance
During Your Product's
@@ -889,7 +889,7 @@ The following packaging changes have been made:
BitBake
-------
-The following changes have been made to `BitBake <#bitbake-term>`__.
+The following changes have been made to :term:`BitBake`.
.. _migration-1.6-matching-branch-requirement-for-git-fetching:
@@ -897,8 +897,8 @@ Matching Branch Requirement for Git Fetching
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When fetching source from a Git repository using
-```SRC_URI`` <#var-SRC_URI>`__, BitBake will now validate the
-```SRCREV`` <#var-SRCREV>`__ value against the branch. You can specify
+:term:`SRC_URI`, BitBake will now validate the
+:term:`SRCREV` value against the branch. You can specify
the branch using the following form: SRC_URI =
"git://server.name/repository;branch=branchname" If you do not specify a
branch, BitBake looks in the default "master" branch.
@@ -960,7 +960,7 @@ will need to add ``2>&1`` (or something similar) to the end of your
``task-``\ taskname overrides have been adjusted so that tasks whose
names contain underscores have the underscores replaced by hyphens for
the override so that they now function properly. For example, the task
-override for ```do_populate_sdk`` <#ref-tasks-populate_sdk>`__ is
+override for :ref:`ref-tasks-populate_sdk` is
``task-populate-sdk``.
.. _migration-1.6-variable-changes:
@@ -977,7 +977,7 @@ Glossary <#ref-variables-glos>`__" Chapter.
``TMPDIR``
~~~~~~~~~~
-```TMPDIR`` <#var-TMPDIR>`__ can no longer be on an NFS mount. NFS does
+:term:`TMPDIR` can no longer be on an NFS mount. NFS does
not offer full POSIX locking and inode consistency and can cause
unexpected issues if used to store ``TMPDIR``.
@@ -990,7 +990,7 @@ NFS mount, an error occurs.
~~~~~~~~~
The ``PRINC`` variable has been deprecated and triggers a warning if
-detected during a build. For ```PR`` <#var-PR>`__ increments on changes,
+detected during a build. For :term:`PR` increments on changes,
use the PR service instead. You can find out more about this service in
the "`Working With a PR
Service <&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service>`__" section in
@@ -1001,7 +1001,7 @@ the Yocto Project Development Tasks Manual.
``IMAGE_TYPES``
~~~~~~~~~~~~~~~
-The "sum.jffs2" option for ```IMAGE_TYPES`` <#var-IMAGE_TYPES>`__ has
+The "sum.jffs2" option for :term:`IMAGE_TYPES` has
been replaced by the "jffs2.sum" option, which fits the processing
order.
@@ -1010,7 +1010,7 @@ order.
``COPY_LIC_MANIFEST``
~~~~~~~~~~~~~~~~~~~~~
-The ```COPY_LIC_MANIFEST`` <#var-COPY_LIC_MANIFEST>`__ variable must now
+The :term:`COPY_LIC_MANIFEST` variable must now
be set to "1" rather than any value in order to enable it.
.. _migration-1.6-variable-changes-COPY_LIC_DIRS:
@@ -1018,7 +1018,7 @@ be set to "1" rather than any value in order to enable it.
``COPY_LIC_DIRS``
~~~~~~~~~~~~~~~~~
-The ```COPY_LIC_DIRS`` <#var-COPY_LIC_DIRS>`__ variable must now be set
+The :term:`COPY_LIC_DIRS` variable must now be set
to "1" rather than any value in order to enable it.
.. _migration-1.6-variable-changes-PACKAGE_GROUP:
@@ -1027,7 +1027,7 @@ to "1" rather than any value in order to enable it.
~~~~~~~~~~~~~~~~~
The ``PACKAGE_GROUP`` variable has been renamed to
-```FEATURE_PACKAGES`` <#var-FEATURE_PACKAGES>`__ to more accurately
+:term:`FEATURE_PACKAGES` to more accurately
reflect its purpose. You can still use ``PACKAGE_GROUP`` but the
OpenEmbedded build system produces a warning message when it encounters
the variable.
@@ -1039,15 +1039,15 @@ Preprocess and Post Process Command Variable Behavior
The following variables now expect a semicolon separated list of
functions to call and not arbitrary shell commands:
-`ROOTFS_PREPROCESS_COMMAND <#var-ROOTFS_PREPROCESS_COMMAND>`__
-`ROOTFS_POSTPROCESS_COMMAND <#var-ROOTFS_POSTPROCESS_COMMAND>`__
-`SDK_POSTPROCESS_COMMAND <#var-SDK_POSTPROCESS_COMMAND>`__
-`POPULATE_SDK_POST_TARGET_COMMAND <#var-POPULATE_SDK_POST_TARGET_COMMAND>`__
-`POPULATE_SDK_POST_HOST_COMMAND <#var-POPULATE_SDK_POST_HOST_COMMAND>`__
-`IMAGE_POSTPROCESS_COMMAND <#var-IMAGE_POSTPROCESS_COMMAND>`__
-`IMAGE_PREPROCESS_COMMAND <#var-IMAGE_PREPROCESS_COMMAND>`__
-`ROOTFS_POSTUNINSTALL_COMMAND <#var-ROOTFS_POSTUNINSTALL_COMMAND>`__
-`ROOTFS_POSTINSTALL_COMMAND <#var-ROOTFS_POSTINSTALL_COMMAND>`__ For
+:term:`ROOTFS_PREPROCESS_COMMAND`
+:term:`ROOTFS_POSTPROCESS_COMMAND`
+:term:`SDK_POSTPROCESS_COMMAND`
+:term:`POPULATE_SDK_POST_TARGET_COMMAND`
+:term:`POPULATE_SDK_POST_HOST_COMMAND`
+:term:`IMAGE_POSTPROCESS_COMMAND`
+:term:`IMAGE_PREPROCESS_COMMAND`
+:term:`ROOTFS_POSTUNINSTALL_COMMAND`
+:term:`ROOTFS_POSTINSTALL_COMMAND` For
migration purposes, you can simply wrap shell commands in a shell
function and then call the function. Here is an example:
my_postprocess_function() { echo "hello" > ${IMAGE_ROOTFS}/hello.txt }
@@ -1062,7 +1062,7 @@ Package Tests (ptest) are built but not installed by default. For
information on using Package Tests, see the "`Testing Packages with
ptest <&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest>`__" section in
the Yocto Project Development Tasks Manual. For information on the
-``ptest`` class, see the "```ptest.bbclass`` <#ref-classes-ptest>`__"
+``ptest`` class, see the ":ref:`ptest.bbclass `"
section.
.. _migration-1.6-build-changes:
@@ -1072,8 +1072,8 @@ Build Changes
Separate build and source directories have been enabled by default for
selected recipes where it is known to work (a whitelist) and for all
-recipes that inherit the ```cmake`` <#ref-classes-cmake>`__ class. In
-future releases the ```autotools`` <#ref-classes-autotools>`__ class
+recipes that inherit the :ref:`cmake ` class. In
+future releases the :ref:`autotools ` class
will enable a separate build directory by default as well. Recipes
building Autotools-based software that fails to build with a separate
build directory should be changed to inherit from the
@@ -1116,12 +1116,12 @@ Licensing
---------
The top-level ``LICENSE`` file has been changed to better describe the
-license of the various components of `OE-Core <#oe-core>`__. However,
+license of the various components of :term:`OpenEmbedded-Core (OE-Core)`. However,
the licensing itself remains unchanged.
Normally, this change would not cause any side-effects. However, some
recipes point to this file within
-```LIC_FILES_CHKSUM`` <#var-LIC_FILES_CHKSUM>`__ (as
+:term:`LIC_FILES_CHKSUM` (as
``${COREBASE}/LICENSE``) and thus the accompanying checksum must be
changed from 3f40d7994397109285ec7b81fdeb3b58 to
4d92cd373abda3937c2bc47fbc49d690. A better alternative is to have
@@ -1135,7 +1135,7 @@ rather than pointing to ``${COREBASE}/LICENSE``.
------------------
The "-fpermissive" option has been removed from the default
-```CFLAGS`` <#var-CFLAGS>`__ value. You need to take action on
+:term:`CFLAGS` value. You need to take action on
individual recipes that fail when building with this option. You need to
either patch the recipes to fix the issues reported by the compiler, or
you need to add "-fpermissive" to ``CFLAGS`` in the recipes.
@@ -1146,9 +1146,9 @@ Custom Image Output Types
-------------------------
Custom image output types, as selected using
-```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__, must declare their
+:term:`IMAGE_FSTYPES`, must declare their
dependencies on other image types (if any) using a new
-```IMAGE_TYPEDEP`` <#var-IMAGE_TYPEDEP>`__ variable.
+:term:`IMAGE_TYPEDEP` variable.
.. _migration-1.6-do-package-write-task:
@@ -1264,7 +1264,7 @@ Changes to Setting QEMU ``PACKAGECONFIG`` Options in ``local.conf``
-------------------------------------------------------------------
The QEMU recipe now uses a number of
-```PACKAGECONFIG`` <#var-PACKAGECONFIG>`__ options to enable various
+:term:`PACKAGECONFIG` options to enable various
optional features. The method used to set defaults for these options
means that existing ``local.conf`` files will need to be be modified to
append to ``PACKAGECONFIG`` for ``qemu-native`` and ``nativesdk-qemu``
@@ -1291,13 +1291,13 @@ for more information.
Autotools Class Changes
-----------------------
-The following ```autotools`` <#ref-classes-autotools>`__ class changes
+The following :ref:`autotools ` class changes
occurred:
- *A separate build directory is now used by default:* The
``autotools`` class has been changed to use a directory for building
- (```B`` <#var-B>`__), which is separate from the source directory
- (```S`` <#var-S>`__). This is commonly referred to as ``B != S``, or
+ (:term:`B`), which is separate from the source directory
+ (:term:`S`). This is commonly referred to as ``B != S``, or
an out-of-tree build.
If the software being built is already capable of building in a
@@ -1368,10 +1368,10 @@ Kernel Module Autoloading
The ```module_autoload_*`` <#var-module_autoload>`__ variable is now
deprecated and a new
-```KERNEL_MODULE_AUTOLOAD`` <#var-KERNEL_MODULE_AUTOLOAD>`__ variable
+:term:`KERNEL_MODULE_AUTOLOAD` variable
should be used instead. Also, ```module_conf_*`` <#var-module_conf>`__
must now be used in conjunction with a new
-```KERNEL_MODULE_PROBECONF`` <#var-KERNEL_MODULE_PROBECONF>`__ variable.
+:term:`KERNEL_MODULE_PROBECONF` variable.
The new variables no longer require you to specify the module name as
part of the variable name. This change not only simplifies usage but
also allows the values of these variables to be appropriately
@@ -1395,15 +1395,15 @@ The following changes have occurred to the QA check process:
see the "`QA Error and Warning Messages <#ref-qa-checks>`__" chapter.
- Package QA checks are now performed during a new
- ```do_package_qa`` <#ref-tasks-package_qa>`__ task rather than being
- part of the ```do_package`` <#ref-tasks-package>`__ task. This allows
+ :ref:`ref-tasks-package_qa` task rather than being
+ part of the :ref:`ref-tasks-package` task. This allows
more parallel execution. This change is unlikely to be an issue
except for highly customized recipes that disable packaging tasks
themselves by marking them as ``noexec``. For those packages, you
will need to disable the ``do_package_qa`` task as well.
- Files being overwritten during the
- ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task now
+ :ref:`ref-tasks-populate_sysroot` task now
trigger an error instead of a warning. Recipes should not be
overwriting files written to the sysroot by other recipes. If you
have these types of recipes, you need to alter them so that they do
@@ -1412,7 +1412,7 @@ The following changes have occurred to the QA check process:
You might now receive this error after changes in configuration or
metadata resulting in orphaned files being left in the sysroot. If
you do receive this error, the way to resolve the issue is to delete
- your ```TMPDIR`` <#var-TMPDIR>`__ or to move it out of the way and
+ your :term:`TMPDIR` or to move it out of the way and
then re-start the build. Anything that has been fully built up to
that point and does not need rebuilding will be restored from the
shared state cache and the rest of the build will be able to proceed
@@ -1508,7 +1508,7 @@ BlueZ 4.x / 5.x Selection
Proper built-in support for selecting BlueZ 5.x in preference to the
default of 4.x now exists. To use BlueZ 5.x, simply add "bluez5" to your
-```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ value. If you had
+:term:`DISTRO_FEATURES` value. If you had
previously added append files (``*.bbappend``) to make this selection,
you can now remove them.
@@ -1532,8 +1532,8 @@ code tree. In theory, migration paths have been provided for most common
usages in kernel recipes but this might not work in all cases. In
particular, users need to ensure that ``${S}`` (source files) and
``${B}`` (build artifacts) are used correctly in functions such as
-```do_configure`` <#ref-tasks-configure>`__ and
-```do_install`` <#ref-tasks-install>`__. For kernel recipes that do not
+:ref:`ref-tasks-configure` and
+:ref:`ref-tasks-install`. For kernel recipes that do not
inherit from ``kernel-yocto`` or include ``linux-yocto.inc``, you might
wish to refer to the ``linux.inc`` file in the ``meta-oe`` layer for the
kinds of changes you need to make. For reference, here is the
@@ -1554,7 +1554,7 @@ SSL 3.0 is now disabled when building OpenSSL. Disabling SSL 3.0 avoids
any lingering instances of the POODLE vulnerability. If you feel you
must re-enable SSL 3.0, then you can add an append file (``*.bbappend``)
for the ``openssl`` recipe to remove "-no-ssl3" from
-```EXTRA_OECONF`` <#var-EXTRA_OECONF>`__.
+:term:`EXTRA_OECONF`.
.. _migration-1.8-default-sysroot-poisoning:
@@ -1578,17 +1578,17 @@ need to take corrective steps.
Rebuild Improvements
--------------------
-Changes have been made to the ```base`` <#ref-classes-base>`__,
-```autotools`` <#ref-classes-autotools>`__, and
-```cmake`` <#ref-classes-cmake>`__ classes to clean out generated files
-when the ```do_configure`` <#ref-tasks-configure>`__ task needs to be
+Changes have been made to the :ref:`base `,
+:ref:`autotools `, and
+:ref:`cmake ` classes to clean out generated files
+when the :ref:`ref-tasks-configure` task needs to be
re-executed.
One of the improvements is to attempt to run "make clean" during the
``do_configure`` task if a ``Makefile`` exists. Some software packages
do not provide a working clean target within their make files. If you
have such recipes, you need to set
-```CLEANBROKEN`` <#var-CLEANBROKEN>`__ to "1" within the recipe, for
+:term:`CLEANBROKEN` to "1" within the recipe, for
example: CLEANBROKEN = "1"
.. _migration-1.8-qa-check-and-validation-changes:
@@ -1603,18 +1603,18 @@ The following QA Check and Validation Changes have occurred:
recipe or append file.
- An additional QA check has been added to detect usage of ``${D}`` in
- ```FILES`` <#var-FILES>`__ values where ```D`` <#var-D>`__ values
+ :term:`FILES` values where :term:`D` values
should not be used at all. The same check ensures that ``$D`` is used
in ``pkg_preinst/pkg_postinst/pkg_prerm/pkg_postrm`` functions
instead of ``${D}``.
-- ```S`` <#var-S>`__ now needs to be set to a valid value within a
+- :term:`S` now needs to be set to a valid value within a
recipe. If ``S`` is not set in the recipe, the directory is not
automatically created. If ``S`` does not point to a directory that
- exists at the time the ```do_unpack`` <#ref-tasks-unpack>`__ task
+ exists at the time the :ref:`ref-tasks-unpack` task
finishes, a warning will be shown.
-- ```LICENSE`` <#var-LICENSE>`__ is now validated for correct
+- :term:`LICENSE` is now validated for correct
formatting of multiple licenses. If the format is invalid (e.g.
multiple licenses are specified with no operators to specify how the
multiple licenses interact), then a warning will be shown.
@@ -1633,7 +1633,7 @@ The following miscellaneous changes have occurred:
- The ``oe-pkgdata-util`` script now expects a "-p" option to be
specified before the ``pkgdata`` directory, which is now optional. If
the ``pkgdata`` directory is not specified, the script will run
- BitBake to query ```PKGDATA_DIR`` <#var-PKGDATA_DIR>`__ from the
+ BitBake to query :term:`PKGDATA_DIR` from the
build environment.
Moving to the Yocto Project 2.0 Release
@@ -1811,7 +1811,7 @@ Recipe Maintenance Tracking Data Moved to OE-Core
-------------------------------------------------
Maintenance tracking data for recipes that was previously part of
-``meta-yocto`` has been moved to `OE-Core <#oe-core>`__. The change
+``meta-yocto`` has been moved to :term:`OpenEmbedded-Core (OE-Core)`. The change
includes ``package_regex.inc`` and ``distro_alias.inc``, which are
typically enabled when using the ``distrodata`` class. Additionally, the
contents of ``upstream_tracking.inc`` has now been split out to the
@@ -1827,7 +1827,7 @@ configuration are now automatically removed from sysroot as well as
removed from any other place managed by shared state. This automatic
cleanup means that the build system now properly handles situations such
as renaming the build system side of recipes, removal of layers from
-``bblayers.conf``, and ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__
+``bblayers.conf``, and :term:`DISTRO_FEATURES`
changes.
Additionally, work directories for old versions of recipes are now
@@ -1847,7 +1847,7 @@ modifications synchronized, it is not always obvious to developers how
to manipulate the Metadata as compared to the source.
Metadata processing has now been removed from the
-```kernel-yocto`` <#ref-classes-kernel-yocto>`__ class and the external
+:ref:`kernel-yocto ` class and the external
Metadata repository ``yocto-kernel-cache``, which has always been used
to seed the ``linux-yocto`` "meta" branch. This separate ``linux-yocto``
cache repository is now the primary location for this data. Due to this
@@ -1870,13 +1870,13 @@ The following QA checks have been added:
- Added an "invalid-chars" check for invalid (non-UTF8) characters in
recipe metadata variable values (i.e.
- ```DESCRIPTION`` <#var-DESCRIPTION>`__,
- ```SUMMARY`` <#var-SUMMARY>`__, ```LICENSE`` <#var-LICENSE>`__, and
- ```SECTION`` <#var-SECTION>`__). Some package managers do not support
+ :term:`DESCRIPTION`,
+ :term:`SUMMARY`, :term:`LICENSE`, and
+ :term:`SECTION`). Some package managers do not support
these characters.
- Added an "invalid-packageconfig" check for any options specified in
- ```PACKAGECONFIG`` <#var-PACKAGECONFIG>`__ that do not match any
+ :term:`PACKAGECONFIG` that do not match any
``PACKAGECONFIG`` option defined for the recipe.
.. _migration-2.0-miscellaneous:
@@ -1888,7 +1888,7 @@ These additional changes exist:
- ``gtk-update-icon-cache`` has been renamed to ``gtk-icon-utils``.
-- The ``tools-profile`` ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__
+- The ``tools-profile`` :term:`IMAGE_FEATURES`
item as well as its corresponding packagegroup and
``packagegroup-core-tools-profile`` no longer bring in ``oprofile``.
Bringing in ``oprofile`` was originally added to aid compilation on
@@ -1897,7 +1897,7 @@ These additional changes exist:
powerful target platforms and the existence of better
cross-compilation tools.
-- The ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable's default
+- The :term:`IMAGE_FSTYPES` variable's default
value now specifies ``ext4`` instead of ``ext3``.
- All support for the ``PRINC`` variable has been removed.
@@ -1937,7 +1937,7 @@ The convention for overrides has always been for them to be lower-case
characters. This practice is now a requirement as BitBake's datastore
now assumes lower-case characters in order to give a slight performance
boost during parsing. In practical terms, this requirement means that
-anything that ends up in ```OVERRIDES`` <#var-OVERRIDES>`__ must now
+anything that ends up in :term:`OVERRIDES` must now
appear in lower-case characters (e.g. values for ``MACHINE``,
``TARGET_ARCH``, ``DISTRO``, and also recipe names if
``_pn-``\ recipename overrides are to be effective).
@@ -1970,7 +1970,7 @@ layer to make this change: sed -e 's:\(\.getVar([^,()]*\)):\1, False):g'
Makefile Environment Changes
----------------------------
-```EXTRA_OEMAKE`` <#var-EXTRA_OEMAKE>`__ now defaults to "" instead of
+:term:`EXTRA_OEMAKE` now defaults to "" instead of
"-e MAKEFLAGS=". Setting ``EXTRA_OEMAKE`` to "-e MAKEFLAGS=" by default
was a historical accident that has required many classes (e.g.
``autotools``, ``module``) and recipes to override this default in order
@@ -2007,14 +2007,14 @@ breaking FHS.
``ac_cv_sizeof_off_t`` is No Longer Cached in Site Files
--------------------------------------------------------
-For recipes inheriting the ```autotools`` <#ref-classes-autotools>`__
+For recipes inheriting the :ref:`autotools `
class, ``ac_cv_sizeof_off_t`` is no longer cached in the site files for
``autoconf``. The reason for this change is because the
``ac_cv_sizeof_off_t`` value is not necessarily static per architecture
as was previously assumed. Rather, the value changes based on whether
large file support is enabled. For most software that uses ``autoconf``,
this change should not be a problem. However, if you have a recipe that
-bypasses the standard ```do_configure`` <#ref-tasks-configure>`__ task
+bypasses the standard :ref:`ref-tasks-configure` task
from the ``autotools`` class and the software the recipe is building
uses a very old version of ``autoconf``, the recipe might be incapable
of determining the correct size of ``off_t`` during ``do_configure``.
@@ -2030,7 +2030,7 @@ implementation does get used.
Image Generation is Now Split Out from Filesystem Generation
------------------------------------------------------------
-Previously, for image recipes the ```do_rootfs`` <#ref-tasks-rootfs>`__
+Previously, for image recipes the :ref:`ref-tasks-rootfs`
task assembled the filesystem and then from that filesystem generated
images. With this Yocto Project release, image generation is split into
separate ```do_image_*`` <#ref-tasks-image>`__ tasks for clarity both in
@@ -2047,7 +2047,7 @@ time.
A minor part of this restructuring is that the post-processing
definitions and functions have been moved from the
-```image`` <#ref-classes-image>`__ class to the
+:ref:`image ` class to the
```rootfs-postcommands`` <#ref-classes-rootfs*>`__ class. Functionally,
however, they remain unchanged.
@@ -2099,7 +2099,7 @@ Class Changes
The following classes have changed:
- ``autotools_stage``: Removed because the
- ```autotools`` <#ref-classes-autotools>`__ class now provides its
+ :ref:`autotools ` class now provides its
functionality. Recipes that inherited from ``autotools_stage`` should
now inherit from ``autotools`` instead.
@@ -2108,7 +2108,7 @@ The following classes have changed:
this change should not cause any issues.
- ``bootimg``: Merged into the
- ```image-live`` <#ref-classes-image-live>`__ class. The ``bootimg``
+ :ref:`image-live ` class. The ``bootimg``
class was rarely directly used. Consequently, this change should not
cause any issues.
@@ -2166,7 +2166,7 @@ The following changes have been made for the Poky distribution:
not need to change anything unless you are relying on this naming
elsewhere.
-- The ```uninative`` <#ref-classes-uninative>`__ class is now enabled
+- The :ref:`uninative ` class is now enabled
by default in Poky. This class attempts to isolate the build system
from the host distribution's C library and makes re-use of native
shared state artifacts across different host distributions practical.
@@ -2278,7 +2278,7 @@ These additional changes exist:
- Previously, the following list of packages were removed if
package-management was not in
- ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__, regardless of any
+ :term:`IMAGE_FEATURES`, regardless of any
dependencies: update-rc.d base-passwd shadow update-alternatives
run-postinsts With the Yocto Project 2.1 release, these packages are
only removed if "read-only-rootfs" is in ``IMAGE_FEATURES``, since
@@ -2362,9 +2362,9 @@ Staging Directories in Sysroot Has Been Simplified
--------------------------------------------------
The way directories are staged in sysroot has been simplified and
-introduces the new ```SYSROOT_DIRS`` <#var-SYSROOT_DIRS>`__,
-```SYSROOT_DIRS_NATIVE`` <#var-SYSROOT_DIRS_NATIVE>`__, and
-```SYSROOT_DIRS_BLACKLIST`` <#var-SYSROOT_DIRS_BLACKLIST>`__. See the
+introduces the new :term:`SYSROOT_DIRS`,
+:term:`SYSROOT_DIRS_NATIVE`, and
+:term:`SYSROOT_DIRS_BLACKLIST`. See the
`v2 patch series on the OE-Core Mailing
List `__
for additional information.
@@ -2408,7 +2408,7 @@ Metadata Must Now Use Python 3 Syntax
The metadata is now required to use Python 3 syntax. For help preparing
metadata, see any of the many Python 3 porting guides available.
Alternatively, you can reference the conversion commits for Bitbake and
-you can use `OE-Core <#oe-core>`__ as a guide for changes. Following are
+you can use :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes. Following are
particular areas of interest: \* subprocess command-line pipes needing
locale decoding \* the syntax for octal values changed \* the
``iter*()`` functions changed name \* iterators now return views, not
@@ -2449,7 +2449,7 @@ compared to uClibc.
``${B}`` No Longer Default Working Directory for Tasks
------------------------------------------------------
-``${``\ ```B`` <#var-B>`__\ ``}`` is no longer the default working
+``${``\ :term:`B`\ ``}`` is no longer the default working
directory for tasks. Consequently, any custom tasks you define now need
to either have the
``[``\ ```dirs`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` flag
@@ -2479,7 +2479,7 @@ enables fine-grained tuning of options passed to QEMU without the
``runqemu`` script hard-coding any knowledge about different machines.
Using a configuration file is particularly convenient when trying to use
QEMU with machines other than the ``qemu*`` machines in
-`OE-Core <#oe-core>`__. The ``qemuboot.conf`` file is generated by the
+:term:`OpenEmbedded-Core (OE-Core)`. The ``qemuboot.conf`` file is generated by the
``qemuboot`` class when the root filesystem is being build (i.e. build
rootfs). QEMU boot arguments can be set in BSP's configuration file and
the ``qemuboot`` class will save them to ``qemuboot.conf``.
@@ -2527,7 +2527,7 @@ socket,id=virtcon,port=@PORT@,host=127.0.0.1 -device
virtconsole,chardev=virtcon" runqemu will replace "@PORT@" with the port
number which is used.
-To use ``runqemu``, set ```IMAGE_CLASSES`` <#var-IMAGE_CLASSES>`__ as
+To use ``runqemu``, set :term:`IMAGE_CLASSES` as
follows and run ``runqemu``:
.. note::
@@ -2545,7 +2545,7 @@ Default Linker Hash Style Changed
The default linker hash style for ``gcc-cross`` is now "sysv" in order
to catch recipes that are building software without using the
-OpenEmbedded ```LDFLAGS`` <#var-LDFLAGS>`__. This change could result in
+OpenEmbedded :term:`LDFLAGS`. This change could result in
seeing some "No GNU_HASH in the elf binary" QA issues when building such
recipes. You need to fix these recipes so that they use the expected
``LDFLAGS``. Depending on how the software is built, the build system
@@ -2559,7 +2559,7 @@ to the recipe: TARGET_CC_ARCH += "${LDFLAGS}"
--------------------------------------------------------------
The ``KERNEL_IMAGE_BASE_NAME`` variable no longer uses the
-```KERNEL_IMAGETYPE`` <#var-KERNEL_IMAGETYPE>`__ variable to create the
+:term:`KERNEL_IMAGETYPE` variable to create the
image's base name. Because the OpenEmbedded build system can now build
multiple kernel image types, this part of the kernel image base name as
been removed leaving only the following: KERNEL_IMAGE_BASE_NAME ?=
@@ -2577,11 +2577,11 @@ The following changes took place for BitBake:
- The "goggle" UI and standalone image-writer tool have been removed as
they both require GTK+ 2.0 and were not being maintained.
-- The Perforce fetcher now supports ```SRCREV`` <#var-SRCREV>`__ for
+- The Perforce fetcher now supports :term:`SRCREV` for
specifying the source revision to use, be it
- ``${``\ ```AUTOREV`` <#var-AUTOREV>`__\ ``}``, changelist number,
+ ``${``\ :term:`AUTOREV`\ ``}``, changelist number,
p4date, or label, in preference to separate
- ```SRC_URI`` <#var-SRC_URI>`__ parameters to specify these. This
+ :term:`SRC_URI` parameters to specify these. This
change is more in-line with how the other fetchers work for source
control systems. Recipes that fetch from Perforce will need to be
updated to use ``SRCREV`` in place of specifying the source revision
@@ -2687,8 +2687,8 @@ The following classes have been removed:
- ``distutils3-native-base``: No longer needed.
-- ``sdl``: Only set ```DEPENDS`` <#var-DEPENDS>`__ and
- ```SECTION`` <#var-SECTION>`__, which are better set within the
+- ``sdl``: Only set :term:`DEPENDS` and
+ :term:`SECTION`, which are better set within the
recipe instead.
- ``sip``: Mostly unused.
@@ -2723,9 +2723,9 @@ The following miscellaneous changes have occurred:
respective recipes.
- Both ``devtool add`` and ``recipetool create`` now use a fixed
- ```SRCREV`` <#var-SRCREV>`__ by default when fetching from a Git
+ :term:`SRCREV` by default when fetching from a Git
repository. You can override this in either case to use
- ``${``\ ```AUTOREV`` <#var-AUTOREV>`__\ ``}`` instead by using the
+ ``${``\ :term:`AUTOREV`\ ``}`` instead by using the
``-a`` or ``DASHDASHautorev`` command-line option
- ``distcc``: GTK+ UI is now disabled by default.
@@ -2776,14 +2776,14 @@ Consider the following:
- *Specify Pre-Installation and Post-Installation Native Tool
Dependencies:* You must specifically specify any special native tool
dependencies of ``pkg_preinst`` and ``pkg_postinst`` scripts by using
- the ```PACKAGE_WRITE_DEPS`` <#var-PACKAGE_WRITE_DEPS>`__ variable.
+ the :term:`PACKAGE_WRITE_DEPS` variable.
Specifying these dependencies ensures that these tools are available
if these scripts need to be run on the build host during the
- ```do_rootfs`` <#ref-tasks-rootfs>`__ task.
+ :ref:`ref-tasks-rootfs` task.
As an example, see the ``dbus`` recipe. You will see that this recipe
has a ``pkg_postinst`` that calls ``systemctl`` if "systemd" is in
- ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__. In the example,
+ :term:`DISTRO_FEATURES`. In the example,
``systemd-systemctl-native`` is added to ``PACKAGE_WRITE_DEPS``,
which is also conditional on "systemd" being in ``DISTRO_FEATURES``.
@@ -2797,7 +2797,7 @@ Consider the following:
functions being called through ``SSTATEPOSTINSTFUNCS`` are doing
relocation, then you will need to change these to use a
post-installation script that is installed by a function added to
- ```SYSROOT_PREPROCESS_FUNCS`` <#var-SYSROOT_PREPROCESS_FUNCS>`__.
+ :term:`SYSROOT_PREPROCESS_FUNCS`.
For an example, see the ``pixbufcache`` class in ``meta/classes/`` in
the Yocto Project `Source
@@ -2821,7 +2821,7 @@ Consider the following:
the shared sysroot is now gone, the scripts
``oe-find-native-sysroot`` and ``oe-run-native`` have been changed
such that you need to specify which recipe's
- ```STAGING_DIR_NATIVE`` <#var-STAGING_DIR_NATIVE>`__ is used.
+ :term:`STAGING_DIR_NATIVE` is used.
.. note::
@@ -2839,8 +2839,8 @@ Within the environment used to run build tasks, the environment variable
``PATH`` is now sanitized such that the normal native binary paths
(``/bin``, ``/sbin``, ``/usr/bin`` and so forth) are removed and a
directory containing symbolic links linking only to the binaries from
-the host mentioned in the ```HOSTTOOLS`` <#var-HOSTTOOLS>`__ and
-```HOSTTOOLS_NONFATAL`` <#var-HOSTTOOLS_NONFATAL>`__ variables is added
+the host mentioned in the :term:`HOSTTOOLS` and
+:term:`HOSTTOOLS_NONFATAL` variables is added
to ``PATH``.
Consequently, any native binaries provided by the host that you need to
@@ -2848,7 +2848,7 @@ call needs to be in one of these two variables at the configuration
level.
Alternatively, you can add a native recipe (i.e. ``-native``) that
-provides the binary to the recipe's ```DEPENDS`` <#var-DEPENDS>`__
+provides the binary to the recipe's :term:`DEPENDS`
value.
.. note::
@@ -2881,7 +2881,7 @@ The following changes to scripts took place:
- *``cleanup-workdir``:* The ``cleanup-workdir`` script has been
removed because the script was found to be deleting files it should
not have, which lead to broken build trees. Rather than trying to
- delete portions of ```TMPDIR`` <#var-TMPDIR>`__ and getting it wrong,
+ delete portions of :term:`TMPDIR` and getting it wrong,
it is recommended that you delete ``TMPDIR`` and have it restored
from shared state (sstate) on subsequent builds.
@@ -2927,8 +2927,8 @@ The following changes took place for BitBake:
between recipes, which could be misleading.
- *Mirror Variable Splitting Changes:* Mirror variables including
- ```MIRRORS`` <#var-MIRRORS>`__, ```PREMIRRORS`` <#var-PREMIRRORS>`__,
- and ```SSTATE_MIRRORS`` <#var-SSTATE_MIRRORS>`__ can now separate
+ :term:`MIRRORS`, :term:`PREMIRRORS`,
+ and :term:`SSTATE_MIRRORS` can now separate
values entirely with spaces. Consequently, you no longer need "\\n".
BitBake looks for pairs of values, which simplifies usage. There
should be no change required to existing mirror variable values
@@ -2940,7 +2940,7 @@ The following changes took place for BitBake:
when the "protocol" parameter is set to "svn+ssh". You can only use
the new parameter to specify the ``ssh`` program used by SVN. The SVN
fetcher passes the new parameter through the ``SVN_SSH`` environment
- variable during the ```do_fetch`` <#ref-tasks-fetch>`__ task.
+ variable during the :ref:`ref-tasks-fetch` task.
See the "`Subversion (SVN) Fetcher
(svn://) <&YOCTO_DOCS_BB_URL;#svn-fetcher>`__" section in the BitBake
@@ -2974,8 +2974,8 @@ GPLv2 Versions of GPLv3 Recipes Moved
Older GPLv2 versions of GPLv3 recipes have moved to a separate
``meta-gplv2`` layer.
-If you use ```INCOMPATIBLE_LICENSE`` <#var-INCOMPATIBLE_LICENSE>`__ to
-exclude GPLv3 or set ```PREFERRED_VERSION`` <#var-PREFERRED_VERSION>`__
+If you use :term:`INCOMPATIBLE_LICENSE` to
+exclude GPLv3 or set :term:`PREFERRED_VERSION`
to substitute a GPLv2 version of a GPLv3 recipe, then you must add the
``meta-gplv2`` layer to your configuration.
@@ -3052,7 +3052,7 @@ The following package management changes took place:
This change was made because too many places in DNF/RPM4 stack
already make that assumption. Only the filenames and the architecture
tag has changed. Nothing else has changed in OE-core system,
- particularly in the ```allarch.bbclass`` <#ref-classes-allarch>`__
+ particularly in the :ref:`allarch.bbclass `
class.
- Signing of remote package feeds using ``PACKAGE_FEED_SIGN`` is not
@@ -3100,7 +3100,7 @@ The following recipes have been removed:
- *``tremor:``* Moved to ``meta-multimedia``. Fixed-integer Vorbis
decoding is not needed by current hardware. Thus, GStreamer's ivorbis
plugin has been disabled by default eliminating the need for the
- ``tremor`` recipe in `OE-Core <#oe-core>`__.
+ ``tremor`` recipe in :term:`OpenEmbedded-Core (OE-Core)`.
- *``gummiboot:``* Replaced by ``systemd-boot``.
@@ -3151,7 +3151,7 @@ The following QA checks have changed:
warning, you need to address missing runtime dependencies.
For additional information, see the
- ```insane`` <#ref-classes-insane>`__ class and the "`Errors and
+ :ref:`insane ` class and the "`Errors and
Warnings <#qa-errors-and-warnings>`__" section.
.. _migration-2.3-miscellaneous-changes:
@@ -3162,7 +3162,7 @@ Miscellaneous Changes
The following miscellaneous changes have occurred:
- In this release, a number of recipes have been changed to ignore the
- ``largefile`` ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ item,
+ ``largefile`` :term:`DISTRO_FEATURES` item,
enabling large file support unconditionally. This feature has always
been enabled by default. Disabling the feature has not been widely
tested.
@@ -3174,8 +3174,8 @@ The following miscellaneous changes have occurred:
largefile
feature, which would make it unconditionally enabled everywhere.
-- If the ```DISTRO_VERSION`` <#var-DISTRO_VERSION>`__ value contains
- the value of the ```DATE`` <#var-DATE>`__ variable, which is the
+- If the :term:`DISTRO_VERSION` value contains
+ the value of the :term:`DATE` variable, which is the
default between Poky releases, the ``DATE`` value is explicitly
excluded from ``/etc/issue`` and ``/etc/issue.net``, which is
displayed at the login prompt, in order to avoid conflicts with
@@ -3186,7 +3186,7 @@ The following miscellaneous changes have occurred:
If you need the build date recorded in ``/etc/issue*`` or anywhere
else in your image, a better method is to define a post-processing
function to do it and have the function called from
- ```ROOTFS_POSTPROCESS_COMMAND`` <#var-ROOTFS_POSTPROCESS_COMMAND>`__.
+ :term:`ROOTFS_POSTPROCESS_COMMAND`.
Doing so ensures the value is always up-to-date with the created
image.
@@ -3195,7 +3195,7 @@ The following miscellaneous changes have occurred:
RSA keys only, and with recent versions of OpenSSH, which deprecates
DSA host keys.
-- The ```buildhistory`` <#ref-classes-buildhistory>`__ class now
+- The :ref:`buildhistory ` class now
correctly uses tabs as separators between all columns in
``installed-package-sizes.txt`` in order to aid import into other
tools.
@@ -3206,7 +3206,7 @@ The following miscellaneous changes have occurred:
DISTRO_FEATURES_BACKFILL_CONSIDERED_append = " ldconfig"
- The default value of
- ```COPYLEFT_LICENSE_INCLUDE`` <#var-COPYLEFT_LICENSE_INCLUDE>`__ now
+ :term:`COPYLEFT_LICENSE_INCLUDE` now
includes all versions of AGPL licenses in addition to GPL and LGPL.
.. note::
@@ -3227,14 +3227,14 @@ The following miscellaneous changes have occurred:
If you need to preserve these ``.la`` files (e.g. in a custom
distribution), you must change
- ```INHERIT_DISTRO`` <#var-INHERIT_DISTRO>`__ such that
+ :term:`INHERIT_DISTRO` such that
"remove-libtool" is not included in the value.
- Extensible SDKs built for GCC 5+ now refuse to install on a
distribution where the host GCC version is 4.8 or 4.9. This change
resulted from the fact that the installation is known to fail due to
the way the ``uninative`` shared state (sstate) package is built. See
- the ```uninative`` <#ref-classes-uninative>`__ class for additional
+ the :ref:`uninative ` class for additional
information.
- All native and nativesdk recipes now use a separate
@@ -3242,18 +3242,18 @@ The following miscellaneous changes have occurred:
recipes for the target, in order to avoid unnecessary rebuilds.
The ``DISTRO_FEATURES`` for ``native`` recipes is
- ```DISTRO_FEATURES_NATIVE`` <#var-DISTRO_FEATURES_NATIVE>`__ added to
+ :term:`DISTRO_FEATURES_NATIVE` added to
an intersection of ``DISTRO_FEATURES`` and
- ```DISTRO_FEATURES_FILTER_NATIVE`` <#var-DISTRO_FEATURES_FILTER_NATIVE>`__.
+ :term:`DISTRO_FEATURES_FILTER_NATIVE`.
For nativesdk recipes, the corresponding variables are
- ```DISTRO_FEATURES_NATIVESDK`` <#var-DISTRO_FEATURES_NATIVESDK>`__
+ :term:`DISTRO_FEATURES_NATIVESDK`
and
- ```DISTRO_FEATURES_FILTER_NATIVESDK`` <#var-DISTRO_FEATURES_FILTER_NATIVESDK>`__.
+ :term:`DISTRO_FEATURES_FILTER_NATIVESDK`.
- The ``FILESDIR`` variable, which was previously deprecated and rarely
used, has now been removed. You should change any recipes that set
- ``FILESDIR`` to set ```FILESPATH`` <#var-FILESPATH>`__ instead.
+ ``FILESDIR`` to set :term:`FILESPATH` instead.
- The ``MULTIMACH_HOST_SYS`` variable has been removed as it is no
longer needed with recipe-specific sysroots.
@@ -3272,7 +3272,7 @@ Memory Resident Mode
A persistent mode is now available in BitBake's default operation,
replacing its previous "memory resident mode" (i.e.
``oe-init-build-env-memres``). Now you only need to set
-```BB_SERVER_TIMEOUT`` <#var-BB_SERVER_TIMEOUT>`__ to a timeout (in
+:term:`BB_SERVER_TIMEOUT` to a timeout (in
seconds) and BitBake's server stays resident for that amount of time
between invocations. The ``oe-init-build-env-memres`` script has been
removed since a separate environment setup script is no longer needed.
@@ -3306,11 +3306,11 @@ occurred:
- The ``su`` program is now packaged in a separate "util-linux-su"
package, which is only built when "pam" is listed in the
- ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ variable.
+ :term:`DISTRO_FEATURES` variable.
``util-linux`` should not be installed unless it is needed because
``su`` is normally provided through the shadow file format. The
main ``util-linux`` package has runtime dependencies (i.e.
- ```RDEPENDS`` <#var-RDEPENDS>`__) on the ``util-linux-su`` package
+ :term:`RDEPENDS`) on the ``util-linux-su`` package
when "pam" is in ``DISTRO_FEATURES``.
- The ``switch_root`` program is now packaged in a separate
@@ -3318,7 +3318,7 @@ occurred:
do not need the whole ``util-linux`` package or the busybox
binary, which are both much larger than ``switch_root``. The main
``util-linux`` package has a recommended runtime dependency (i.e.
- ```RRECOMMENDS`` <#var-RRECOMMENDS>`__) on the
+ :term:`RRECOMMENDS`) on the
``util-linux-switch-root`` package.
- The ``ionice`` program is now packaged in a separate
@@ -3338,7 +3338,7 @@ occurred:
runtime dependency (i.e. ``RRECOMMENDS``) on the ``shared-mime-info``
package, since large portions of GIO are not useful without the MIME
database. You can remove the dependency by using the
- ```BAD_RECOMMENDATIONS`` <#var-BAD_RECOMMENDATIONS>`__ variable if
+ :term:`BAD_RECOMMENDATIONS` variable if
``shared-mime-info`` is too large and is not required.
- *Go Standard Runtime:* The Go standard runtime has been split out
@@ -3456,10 +3456,10 @@ Kernel Device Tree Move
Kernel Device Tree support is now easier to enable in a kernel recipe.
The Device Tree code has moved to a
-```kernel-devicetree`` <#ref-classes-kernel-devicetree>`__ class.
+:ref:`kernel-devicetree ` class.
Functionality is automatically enabled for any recipe that inherits the
-```kernel`` <#ref-classes-kernel>`__ class and sets the
-```KERNEL_DEVICETREE`` <#var-KERNEL_DEVICETREE>`__ variable. The
+:ref:`kernel ` class and sets the
+:term:`KERNEL_DEVICETREE` variable. The
previous mechanism for doing this,
``meta/recipes-kernel/linux/linux-dtb.inc``, is still available to avoid
breakage, but triggers a deprecation warning. Future releases of the
@@ -3478,7 +3478,7 @@ The following package QA changes took place:
- The "unsafe-references-in-scripts" QA check has been removed.
- If you refer to ``${COREBASE}/LICENSE`` within
- ```LIC_FILES_CHKSUM`` <#var-LIC_FILES_CHKSUM>`__ you receive a
+ :term:`LIC_FILES_CHKSUM` you receive a
warning because this file is a description of the license for
OE-Core. Use ``${COMMON_LICENSE_DIR}/MIT`` if your recipe is
MIT-licensed and you cannot use the preferred method of referring to
@@ -3529,10 +3529,10 @@ The following are additional changes:
from ``meta-poky`` to OE-Core (i.e. from
``meta-poky/conf/distro/include`` to ``meta/conf/distro/include``).
-- The ```buildhistory`` <#ref-classes-buildhistory>`__ class now makes
+- The :ref:`buildhistory ` class now makes
a single commit per build rather than one commit per subdirectory in
the repository. This behavior assumes the commits are enabled with
- ```BUILDHISTORY_COMMIT`` <#var-BUILDHISTORY_COMMIT>`__ = "1", which
+ :term:`BUILDHISTORY_COMMIT` = "1", which
is typical. Previously, the ``buildhistory`` class made one commit
per subdirectory in the repository in order to make it easier to see
the changes for a particular subdirectory. To view a particular
@@ -3540,7 +3540,7 @@ The following are additional changes:
``git show`` or ``git diff`` commands.
- The ``x86-base.inc`` file, which is included by all x86-based machine
- configurations, now sets ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__
+ configurations, now sets :term:`IMAGE_FSTYPES`
using ``?=`` to "live" rather than appending with ``+=``. This change
makes the default easier to override.
@@ -3550,7 +3550,7 @@ The following are additional changes:
Manual.
- By default, the ``security_flags.inc`` file sets a
- ```GCCPIE`` <#var-GCCPIE>`__ variable with an option to enable
+ :term:`GCCPIE` variable with an option to enable
Position Independent Executables (PIE) within ``gcc``. Enabling PIE
in the GNU C Compiler (GCC), makes Return Oriented Programming (ROP)
attacks much more difficult to execute.
@@ -3570,12 +3570,12 @@ The following are additional changes:
you need to update them.
- OpenSSL 1.1 has been introduced. However, the default is still 1.0.x
- through the ```PREFERRED_VERSION`` <#var-PREFERRED_VERSION>`__
+ through the :term:`PREFERRED_VERSION`
variable. This preference is set is due to the remaining
compatibility issues with other software. The
- ```PROVIDES`` <#var-PROVIDES>`__ variable in the openssl 1.0 recipe
+ :term:`PROVIDES` variable in the openssl 1.0 recipe
now includes "openssl10" as a marker that can be used in
- ```DEPENDS`` <#var-DEPENDS>`__ within recipes that build software
+ :term:`DEPENDS` within recipes that build software
that still depend on OpenSSL 1.0.
- To ensure consistent behavior, BitBake's "-r" and "-R" options (i.e.
@@ -3747,7 +3747,7 @@ One particular change to note is that the Python recipes no longer have
build-time provides for their packages. This assumes ``python-foo`` is
one of the packages provided by the Python recipe. You can no longer run
``bitbake python-foo`` or have a
-```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__ on ``python-foo``,
+:term:`DEPENDS` on ``python-foo``,
but doing either of the following causes the package to work as
expected: IMAGE_INSTALL_append = " python-foo" or RDEPENDS_${PN} =
"python-foo" The earlier build-time provides behavior was a quirk of the
@@ -3787,7 +3787,7 @@ The following are additional changes:
``sysklogd`` recipe no longer uses ``update-alternatives`` because it
is incompatible with other implementations.
-- By default, the ```cmake`` <#ref-classes-cmake>`__ class uses
+- By default, the :ref:`cmake ` class uses
``ninja`` instead of ``make`` for building. This improves build
performance. If a recipe is broken with ``ninja``, then the recipe
can set ``OECMAKE_GENERATOR = "Unix Makefiles"`` to change back to
@@ -3878,7 +3878,7 @@ release, see ` `__.
If you still need to compile with version 7.x, GCC 7.3 is also provided.
You can select this version by setting the and can be selected by
-setting the ```GCCVERSION`` <#var-GCCVERSION>`__ variable to "7.%" in
+setting the :term:`GCCVERSION` variable to "7.%" in
your configuration.
.. _migration-2.6-removed-recipes:
@@ -3972,12 +3972,12 @@ For names of recipes removed because of this repository change, see the
---------------------------------------------------------------------------------------------------
Previously, it was possible for Python recipes that inherited the
-```distutils`` <#ref-classes-distutils>`__ and
+:ref:`distutils ` and
```distutils3`` <#ref-classes-distutils3>`__ classes to fetch code
-during the ```do_configure`` <#ref-tasks-configure>`__ task to satisfy
+during the :ref:`ref-tasks-configure` task to satisfy
dependencies mentioned in ``setup.py`` if those dependencies were not
provided in the sysroot (i.e. recipes providing the dependencies were
-missing from ```DEPENDS`` <#var-DEPENDS>`__).
+missing from :term:`DEPENDS`).
.. note::
@@ -4018,9 +4018,9 @@ Image/Kernel Artifact Naming Changes
The following changes have been made:
-- Name variables (e.g. ```IMAGE_NAME`` <#var-IMAGE_NAME>`__) use a new
+- Name variables (e.g. :term:`IMAGE_NAME`) use a new
``IMAGE_VERSION_SUFFIX`` variable instead of
- ```DATETIME`` <#var-DATETIME>`__. Using ``IMAGE_VERSION_SUFFIX``
+ :term:`DATETIME`. Using ``IMAGE_VERSION_SUFFIX``
allows easier and more direct changes.
The ``IMAGE_VERSION_SUFFIX`` variable is set in the ``bitbake.conf``
@@ -4029,40 +4029,40 @@ The following changes have been made:
- Several variables have changed names for consistency: Old Variable
Name New Variable Name
========================================================
- KERNEL_IMAGE_BASE_NAME `KERNEL_IMAGE_NAME <#var-KERNEL_IMAGE_NAME>`__
+ KERNEL_IMAGE_BASE_NAME :term:`KERNEL_IMAGE_NAME`
KERNEL_IMAGE_SYMLINK_NAME
- `KERNEL_IMAGE_LINK_NAME <#var-KERNEL_IMAGE_LINK_NAME>`__
+ :term:`KERNEL_IMAGE_LINK_NAME`
MODULE_TARBALL_BASE_NAME
- `MODULE_TARBALL_NAME <#var-MODULE_TARBALL_NAME>`__
+ :term:`MODULE_TARBALL_NAME`
MODULE_TARBALL_SYMLINK_NAME
- `MODULE_TARBALL_LINK_NAME <#var-MODULE_TARBALL_LINK_NAME>`__
- INITRAMFS_BASE_NAME `INITRAMFS_NAME <#var-INITRAMFS_NAME>`__
+ :term:`MODULE_TARBALL_LINK_NAME`
+ INITRAMFS_BASE_NAME :term:`INITRAMFS_NAME`
- The ``MODULE_IMAGE_BASE_NAME`` variable has been removed. The module
tarball name is now controlled directly with the
- ```MODULE_TARBALL_NAME`` <#var-MODULE_TARBALL_NAME>`__ variable.
+ :term:`MODULE_TARBALL_NAME` variable.
-- The ```KERNEL_DTB_NAME`` <#var-KERNEL_DTB_NAME>`__ and
- ```KERNEL_DTB_LINK_NAME`` <#var-KERNEL_DTB_LINK_NAME>`__ variables
+- The :term:`KERNEL_DTB_NAME` and
+ :term:`KERNEL_DTB_LINK_NAME` variables
have been introduced to control kernel Device Tree Binary (DTB)
artifact names instead of mangling ``KERNEL_IMAGE_*`` variables.
-- The ```KERNEL_FIT_NAME`` <#var-KERNEL_FIT_NAME>`__ and
- ```KERNEL_FIT_LINK_NAME`` <#var-KERNEL_FIT_LINK_NAME>`__ variables
+- The :term:`KERNEL_FIT_NAME` and
+ :term:`KERNEL_FIT_LINK_NAME` variables
have been introduced to specify the name of flattened image tree
(FIT) kernel images similar to other deployed artifacts.
-- The ```MODULE_TARBALL_NAME`` <#var-MODULE_TARBALL_NAME>`__ and
- ```MODULE_TARBALL_LINK_NAME`` <#var-MODULE_TARBALL_LINK_NAME>`__
+- The :term:`MODULE_TARBALL_NAME` and
+ :term:`MODULE_TARBALL_LINK_NAME`
variable values no longer include the "module-" prefix or ".tgz"
suffix. These parts are now hardcoded so that the values are
consistent with other artifact naming variables.
-- Added the ```INITRAMFS_LINK_NAME`` <#var-INITRAMFS_LINK_NAME>`__
+- Added the :term:`INITRAMFS_LINK_NAME`
variable so that the symlink can be controlled similarly to other
artifact types.
-- ```INITRAMFS_NAME`` <#var-INITRAMFS_NAME>`__ now uses
+- :term:`INITRAMFS_NAME` now uses
"${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" instead
of "${PV}-${PR}-${MACHINE}-${DATETIME}", which makes it consistent
with other variables.
@@ -4072,9 +4072,9 @@ The following changes have been made:
``SERIAL_CONSOLE`` Deprecated
-----------------------------
-The ```SERIAL_CONSOLE`` <#var-SERIAL_CONSOLE>`__ variable has been
+The :term:`SERIAL_CONSOLE` variable has been
functionally replaced by the
-```SERIAL_CONSOLES`` <#var-SERIAL_CONSOLES>`__ variable for some time.
+:term:`SERIAL_CONSOLES` variable for some time.
With the Yocto Project 2.6 release, ``SERIAL_CONSOLE`` has been
officially deprecated.
@@ -4122,7 +4122,7 @@ The following changes have occurred:
- *The ``forcevariable`` Override Now Has a Higher Priority Than
``libc`` Overrides:* The ``forcevariable`` override is documented to
be the highest priority override. However, due to a long-standing
- quirk of how ```OVERRIDES`` <#var-OVERRIDES>`__ is set, the ``libc``
+ quirk of how :term:`OVERRIDES` is set, the ``libc``
overrides (e.g. ``libc-glibc``, ``libc-musl``, and so forth)
erroneously had a higher priority. This issue is now corrected.
@@ -4177,14 +4177,14 @@ This section provides information about automatic testing changes:
``TEST_IMAGE`` variable to "1" to enable automatic testing for
successfully built images. The ``TEST_IMAGE`` variable no longer
exists and has been replaced by the
- ```TESTIMAGE_AUTO`` <#var-TESTIMAGE_AUTO>`__ variable.
+ :term:`TESTIMAGE_AUTO` variable.
- *Inheriting the ``testimage`` and ``testsdk`` Classes:* Best
practices now dictate that you use the
- ```IMAGE_CLASSES`` <#var-IMAGE_CLASSES>`__ variable rather than the
- ```INHERIT`` <#var-INHERIT>`__ variable when you inherit the
+ :term:`IMAGE_CLASSES` variable rather than the
+ :term:`INHERIT` variable when you inherit the
```testimage`` <#ref-classes-testimage*>`__ and
- ```testsdk`` <#ref-classes-testsdk>`__ classes used for automatic
+ :ref:`testsdk ` classes used for automatic
testing.
.. _migration-2.6-openssl-changes:
@@ -4207,7 +4207,7 @@ BitBake Changes
---------------
The server logfile ``bitbake-cookerdaemon.log`` is now always placed in
-the `Build Directory <#build-directory>`__ instead of the current
+the :term:`Build Directory` instead of the current
directory.
.. _migration-2.6-security-changes:
@@ -4229,7 +4229,7 @@ want to explicitly defer a postinstall to first boot on the target
rather than at rootfs creation time, use ``pkg_postinst_ontarget()`` or
call ``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``.
Any failure of a ``pkg_postinst()`` script (including exit 1) triggers
-an error during the ```do_rootfs`` <#ref-tasks-rootfs>`__ task.
+an error during the :ref:`ref-tasks-rootfs` task.
For more information on post-installation behavior, see the
"`Post-Installation
@@ -4245,14 +4245,14 @@ The ``python3`` recipe now enables profile-guided optimization. Using
this optimization requires a little extra build time in exchange for
improved performance on the target at runtime. Additionally, the
optimization is only enabled if the current
-```MACHINE`` <#var-MACHINE>`__ has support for user-mode emulation in
+:term:`MACHINE` has support for user-mode emulation in
QEMU (i.e. "qemu-usermode" is in
-```MACHINE_FEATURES`` <#var-MACHINE_FEATURES>`__, which it is by
+:term:`MACHINE_FEATURES`, which it is by
default).
If you wish to disable Python profile-guided optimization regardless of
the value of ``MACHINE_FEATURES``, then ensure that
-```PACKAGECONFIG`` <#var-PACKAGECONFIG>`__ for the ``python3`` recipe
+:term:`PACKAGECONFIG` for the ``python3`` recipe
does not contain "pgo". You could accomplish the latter using the
following at the configuration level: PACKAGECONFIG_remove_pn-python3 =
"pgo" Alternatively, you can set ``PACKAGECONFIG`` using an append file
@@ -4276,13 +4276,13 @@ The following miscellaneous changes occurred:
- The ``NOISO`` and ``NOHDD`` variables are no longer used. You now
control building ``*.iso`` and ``*.hddimg`` image types directly by
- using the ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable.
+ using the :term:`IMAGE_FSTYPES` variable.
- The ``scripts/contrib/mkefidisk.sh`` has been removed in favor of
Wic.
- ``kernel-modules`` has been removed from
- ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ for ``qemumips`` and
+ :term:`RRECOMMENDS` for ``qemumips`` and
``qemumips64`` machines. Removal also impacts the ``x86-base.inc``
file.
@@ -4302,7 +4302,7 @@ The following miscellaneous changes occurred:
the ``WHITELIST_GPL-3.0`` variable instead.
- ``${ASNEEDED}`` is now included in the
- ```TARGET_LDFLAGS`` <#var-TARGET_LDFLAGS>`__ variable directly. The
+ :term:`TARGET_LDFLAGS` variable directly. The
remaining definitions from ``meta/conf/distro/include/as-needed.inc``
have been moved to corresponding recipes.
@@ -4332,7 +4332,7 @@ The following changes have been made to BitBake:
indentation. If found, BitBake produces a warning.
- Bitbake now checks
- ```BBFILE_COLLECTIONS`` <#var-BBFILE_COLLECTIONS>`__ for duplicate
+ :term:`BBFILE_COLLECTIONS` for duplicate
entries and triggers an error if any are found.
.. _migration-2.7-eclipse-support-dropped:
@@ -4386,7 +4386,7 @@ License Value Corrections
-------------------------
The following corrections have been made to the
-```LICENSE`` <#var-LICENSE>`__ values set by recipes: *socat*: Corrected
+:term:`LICENSE` values set by recipes: *socat*: Corrected
``LICENSE`` to be "GPLv2" rather than "GPLv2+". *libgfortran*: Set
license to "GPL-3.0-with-GCC-exception". *elfutils*: Removed
"Elfutils-Exception" and set to "GPLv2" for shared libraries
@@ -4404,11 +4404,11 @@ This section provides information about packaging changes.
- Debug split: The default debug split has been changed to create
separate source packages (i.e. package_name\ ``-dbg`` and
package_name\ ``-src``). If you are currently using ``dbg-pkgs`` in
- ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ to bring in debug
+ :term:`IMAGE_FEATURES` to bring in debug
symbols and you still need the sources, you must now also add
``src-pkgs`` to ``IMAGE_FEATURES``. Source packages remain in the
target portion of the SDK by default, unless you have set your own
- value for ```SDKIMAGE_FEATURES`` <#var-SDKIMAGE_FEATURES>`__ that
+ value for :term:`SDKIMAGE_FEATURES` that
does not include ``src-pkgs``.
- Mount all using ``util-linux``: ``/etc/default/mountall`` has moved
@@ -4417,10 +4417,10 @@ This section provides information about packaging changes.
- Splitting binaries using ``util-linux``: ``util-linux`` now splits
each binary into its own package for fine-grained control. The main
``util-linux`` package pulls in the individual binary packages using
- the ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ and
- ```RDEPENDS`` <#var-RDEPENDS>`__ variables. As a result, existing
+ the :term:`RRECOMMENDS` and
+ :term:`RDEPENDS` variables. As a result, existing
images should not see any changes assuming
- ```NO_RECOMMENDATIONS`` <#var-NO_RECOMMENDATIONS>`__ is not set.
+ :term:`NO_RECOMMENDATIONS` is not set.
- ``netbase/base-files``: ``/etc/hosts`` has moved from ``netbase`` to
``base-files``.
@@ -4480,13 +4480,13 @@ The following miscellaneous changes occurred:
- ``arm-tunes``: Removed the "-march" option if mcpu is already added.
- ``update-alternatives``: Convert file renames to
- ```PACKAGE_PREPROCESS_FUNCS`` <#var-PACKAGE_PREPROCESS_FUNCS>`__
+ :term:`PACKAGE_PREPROCESS_FUNCS`
- ``base/pixbufcache``: Obsolete ``sstatecompletions`` code has been
removed.
-- ```native`` <#ref-classes-native>`__ class:
- ```RDEPENDS`` <#var-RDEPENDS>`__ handling has been enabled.
+- :ref:`native ` class:
+ :term:`RDEPENDS` handling has been enabled.
- ``inetutils``: This recipe has rsh disabled.
@@ -4707,7 +4707,7 @@ Sanity Checks
The following sanity check changes occurred.
-- ```SRC_URI`` <#var-SRC_URI>`__ is now checked for usage of two
+- :term:`SRC_URI` is now checked for usage of two
problematic items:
- "${PN}" prefix/suffix use - Warnings always appear if ${PN} is
@@ -4722,10 +4722,10 @@ The following sanity check changes occurred.
Either one of these items now trigger a warning by default. If you
wish to disable this check, remove ``src-uri-bad`` from
- ```WARN_QA`` <#var-WARN_QA>`__.
+ :term:`WARN_QA`.
- The ``file-rdeps`` runtime dependency check no longer expands
- ```RDEPENDS`` <#var-RDEPENDS>`__ recursively as there is no mechanism
+ :term:`RDEPENDS` recursively as there is no mechanism
to ensure they can be fully computed, and thus races sometimes result
in errors either showing up or not. Thus, you might now see errors
for missing runtime dependencies that were previously satisfied
@@ -4736,7 +4736,7 @@ The following sanity check changes occurred.
- Setting ``DEPENDS_${PN}`` anywhere (i.e. typically in a recipe) now
triggers an error. The error is triggered because
- ```DEPENDS`` <#var-DEPENDS>`__ is not a package-specific variable
+ :term:`DEPENDS` is not a package-specific variable
unlike RDEPENDS. You should set ``DEPENDS`` instead.
- systemd currently does not work well with the musl C library because
@@ -4757,14 +4757,14 @@ The following miscellaneous changes have occurred.
- The ``meta/recipes-kernel/linux/linux-dtb.inc`` file has been
removed. This file was previously deprecated in favor of setting
- ```KERNEL_DEVICETREE`` <#var-KERNEL_DEVICETREE>`__ in any kernel
+ :term:`KERNEL_DEVICETREE` in any kernel
recipe and only produced a warning. Remove any ``include`` or
``require`` statements pointing to this file.
-- ```TARGET_CFLAGS`` <#var-TARGET_CFLAGS>`__,
- ```TARGET_CPPFLAGS`` <#var-TARGET_CPPFLAGS>`__,
- ```TARGET_CXXFLAGS`` <#var-TARGET_CXXFLAGS>`__, and
- ```TARGET_LDFLAGS`` <#var-TARGET_LDFLAGS>`__ are no longer exported
+- :term:`TARGET_CFLAGS`,
+ :term:`TARGET_CPPFLAGS`,
+ :term:`TARGET_CXXFLAGS`, and
+ :term:`TARGET_LDFLAGS` are no longer exported
to the external environment. This change did not require any changes
to core recipes, which is a good indicator that no changes will be
required. However, if for some reason the software being built by one
@@ -4774,14 +4774,14 @@ The following miscellaneous changes have occurred.
exporting is not necessary.
- You must change the host distro identifier used in
- ```NATIVELSBSTRING`` <#var-NATIVELSBSTRING>`__ to use all lowercase
+ :term:`NATIVELSBSTRING` to use all lowercase
characters even if it does not contain a version number. This change
is necessary only if you are not using ``uninative`` and
- ```SANITY_TESTED_DISTROS`` <#var-SANITY_TESTED_DISTROS>`__.
+ :term:`SANITY_TESTED_DISTROS`.
- In the ``base-files`` recipe, writing the hostname into
``/etc/hosts`` and ``/etc/hostname`` is now done within the main
- ```do_install`` <#ref-tasks-install>`__ function rather than in the
+ :ref:`ref-tasks-install` function rather than in the
``do_install_basefilesissue`` function. The reason for the change is
because ``do_install_basefilesissue`` is more easily overridden
without having to duplicate the hostname functionality. If you have
@@ -4882,7 +4882,7 @@ significant increase in the number of components that will be built just
when building a simple image such as core-image-minimal. If you do not
need runtime tests enabled for core components, then it is recommended
that you remove "ptest" from
-```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ to save a significant
+:term:`DISTRO_FEATURES` to save a significant
amount of build time e.g. by adding the following in your configuration:
DISTRO_FEATURES_remove = "ptest"
@@ -4966,7 +4966,7 @@ SRC_URI checksum behaviour
--------------------------
Previously, recipes by tradition included both SHA256 and MD5 checksums
-for remotely fetched files in ```SRC_URI`` <#var-SRC_URI>`__, even
+for remotely fetched files in :term:`SRC_URI`, even
though only one is actually mandated. However, the MD5 checksum does not
add much given its inherent weakness; thus when a checksum fails only
the SHA256 sum will now be printed. The md5sum will still be verified if
@@ -4984,7 +4984,7 @@ fetches the shrinkwrap file and the dependencies. This removes the
slightly awkward ``NPM_LOCKDOWN`` and ``NPM_SHRINKWRAP`` variables which
pointed to local files; the lockdown file is no longer needed at all.
Additionally, the package name in ``npm://`` entries in
-```SRC_URI`` <#var-SRC_URI>`__ is now specified using a ``package``
+:term:`SRC_URI` is now specified using a ``package``
parameter instead of the earlier ``name`` which overlapped with the
generic ``name`` parameter. All recipes using the npm fetcher will need
to be changed as a result.
@@ -5019,9 +5019,9 @@ Packaging changes
- The ``ldconfig`` binary built as part of glibc has now been moved to
its own ``ldconfig`` package (note no ``glibc-`` prefix). This
- package is in the ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ of the main
+ package is in the :term:`RRECOMMENDS` of the main
``glibc`` package if ``ldconfig`` is present in
- ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__.
+ :term:`DISTRO_FEATURES`.
- ``libevent`` now splits each shared library into its own package (as
Debian does). Since these are shared libraries and will be pulled in
@@ -5058,7 +5058,7 @@ circumstances:
``conf/machine/include/x86-base.inc`` (inherited by most x86 machine
configurations) now specifies ``wic`` instead of ``live`` by default in
-```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__. The ``live`` image type will
+:term:`IMAGE_FSTYPES`. The ``live`` image type will
likely be removed in a future release so it is recommended that you use
``wic`` instead.
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst
index fdfd110ae7..1685483363 100644
--- a/documentation/ref-manual/ref-classes.rst
+++ b/documentation/ref-manual/ref-classes.rst
@@ -11,14 +11,14 @@ inherits a class it is enough to enable its features. There are cases,
however, where in the recipe you might need to set variables or override
some default behavior.
-Any `Metadata <#metadata>`__ usually found in a recipe can also be
+Any :term:`Metadata` usually found in a recipe can also be
placed in a class file. Class files are identified by the extension
``.bbclass`` and are usually placed in a ``classes/`` directory beneath
the ``meta*/`` directory found in the `Source
Directory <#source-directory>`__. Class files can also be pointed to by
-```BUILDDIR`` <#var-BUILDDIR>`__ (e.g. ``build/``) in the same way as
+:term:`BUILDDIR` (e.g. ``build/``) in the same way as
``.conf`` files in the ``conf`` directory. Class files are searched for
-in ```BBPATH`` <#var-BBPATH>`__ using the same method by which ``.conf``
+in :term:`BBPATH` using the same method by which ``.conf``
files are searched.
This chapter discusses only the most useful and important classes. Other
@@ -41,8 +41,8 @@ splitting out of debug symbols during packaging).
Unlike some distro recipes (e.g. Debian), OpenEmbedded recipes that
produce packages that depend on tunings through use of the
- ```RDEPENDS`` <#var-RDEPENDS>`__ and
- ```TUNE_PKGARCH`` <#var-TUNE_PKGARCH>`__ variables, should never be
+ :term:`RDEPENDS` and
+ :term:`TUNE_PKGARCH` variables, should never be
configured for all architectures using ``allarch``. This is the case
even if the recipes do not produce architecture-specific output.
@@ -52,8 +52,8 @@ splitting out of debug symbols during packaging).
Additionally, unnecessary rebuilds occur every time an image for a
different ``MACHINE`` is built even when the recipe never changes.
-By default, all recipes inherit the ```base`` <#ref-classes-base>`__ and
-```package`` <#ref-classes-package>`__ classes, which enable
+By default, all recipes inherit the :ref:`base ` and
+:ref:`package ` classes, which enable
functionality needed for recipes that produce executable output. If your
recipe, for example, only produces packages that contain configuration
files, media files, or scripts (e.g. Python and Perl), then it should
@@ -71,7 +71,7 @@ For more details on the source archiver, see the "`Maintaining Open
Source License Compliance During Your Product's
Lifecycle <&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle>`__"
section in the Yocto Project Development Tasks Manual. You can also see
-the ```ARCHIVER_MODE`` <#var-ARCHIVER_MODE>`__ variable for information
+the :term:`ARCHIVER_MODE` variable for information
about the variable flags (varflags) that help control archive creation.
.. _ref-classes-autotools:
@@ -96,8 +96,8 @@ By default, the ``autotools*`` classes use out-of-tree builds (i.e.
If the software being built by a recipe does not support using
out-of-tree builds, you should have the recipe inherit the
``autotools-brokensep`` class. The ``autotools-brokensep`` class behaves
-the same as the ``autotools`` class but builds with ```B`` <#var-B>`__
-== ```S`` <#var-S>`__. This method is useful when out-of-tree build
+the same as the ``autotools`` class but builds with :term:`B`
+== :term:`S`. This method is useful when out-of-tree build
support is either not present or is broken.
.. note::
@@ -108,19 +108,19 @@ support is either not present or is broken.
It's useful to have some idea of how the tasks defined by the
``autotools*`` classes work and what they do behind the scenes.
-- ```do_configure`` <#ref-tasks-configure>`__ - Regenerates the
+- :ref:`ref-tasks-configure` - Regenerates the
configure script (using ``autoreconf``) and then launches it with a
standard set of arguments used during cross-compilation. You can pass
additional parameters to ``configure`` through the ``EXTRA_OECONF``
- or ```PACKAGECONFIG_CONFARGS`` <#var-PACKAGECONFIG_CONFARGS>`__
+ or :term:`PACKAGECONFIG_CONFARGS`
variables.
-- ```do_compile`` <#ref-tasks-compile>`__ - Runs ``make`` with
+- :ref:`ref-tasks-compile` - Runs ``make`` with
arguments that specify the compiler and linker. You can pass
additional arguments through the ``EXTRA_OEMAKE`` variable.
-- ```do_install`` <#ref-tasks-install>`__ - Runs ``make install`` and
- passes in ``${``\ ```D`` <#var-D>`__\ ``}`` as ``DESTDIR``.
+- :ref:`ref-tasks-install` - Runs ``make install`` and
+ passes in ``${``\ :term:`D`\ ``}`` as ``DESTDIR``.
.. _ref-classes-base:
@@ -133,12 +133,12 @@ tasks such as fetching, unpacking, configuring (empty by default),
compiling (runs any ``Makefile`` present), installing (empty by default)
and packaging (empty by default). These classes are often overridden or
extended by other classes such as the
-```autotools`` <#ref-classes-autotools>`__ class or the
-```package`` <#ref-classes-package>`__ class.
+:ref:`autotools ` class or the
+:ref:`package ` class.
The class also contains some commonly used functions such as
``oe_runmake``, which runs ``make`` with the arguments specified in
-```EXTRA_OEMAKE`` <#var-EXTRA_OEMAKE>`__ variable as well as the
+:term:`EXTRA_OEMAKE` variable as well as the
arguments passed directly to ``oe_runmake``.
.. _ref-classes-bash-completion:
@@ -201,7 +201,7 @@ the ``sysroots/`` directory. Inheriting this class results in all paths
in these scripts being changed to point into the ``sysroots/`` directory
so that all builds that use the script use the correct directories for
the cross compiling layout. See the
-```BINCONFIG_GLOB`` <#var-BINCONFIG_GLOB>`__ variable for more
+:term:`BINCONFIG_GLOB` variable for more
information.
.. _ref-classes-binconfig-disabled:
@@ -209,11 +209,11 @@ information.
``binconfig-disabled.bbclass``
==============================
-An alternative version of the ```binconfig`` <#ref-classes-binconfig>`__
+An alternative version of the :ref:`binconfig `
class, which disables binary configuration scripts by making them return
an error in favor of using ``pkg-config`` to query the information. The
scripts to be disabled should be specified using the
-```BINCONFIG`` <#var-BINCONFIG>`__ variable within the recipe inheriting
+:term:`BINCONFIG` variable within the recipe inheriting
the class.
.. _ref-classes-blacklist:
@@ -223,8 +223,8 @@ the class.
The ``blacklist`` class prevents the OpenEmbedded build system from
building specific recipes (blacklists them). To use this class, inherit
-the class globally and set ```PNBLACKLIST`` <#var-PNBLACKLIST>`__ for
-each recipe you wish to blacklist. Specify the ```PN`` <#var-PN>`__
+the class globally and set :term:`PNBLACKLIST` for
+each recipe you wish to blacklist. Specify the :term:`PN`
value as a variable flag (varflag) and provide a reason, which is
reported, if the package is requested to be built as the value. For
example, if you want to blacklist a recipe called "exoticware", you add
@@ -253,14 +253,14 @@ The ``buildstats`` class records performance statistics about each task
executed during the build (e.g. elapsed time, CPU usage, and I/O usage).
When you use this class, the output goes into the
-```BUILDSTATS_BASE`` <#var-BUILDSTATS_BASE>`__ directory, which defaults
+:term:`BUILDSTATS_BASE` directory, which defaults
to ``${TMPDIR}/buildstats/``. You can analyze the elapsed time using
``scripts/pybootchartgui/pybootchartgui.py``, which produces a cascading
chart of the entire build process and can be useful for highlighting
bottlenecks.
Collecting build statistics is enabled by default through the
-```USER_CLASSES`` <#var-USER_CLASSES>`__ variable from your
+:term:`USER_CLASSES` variable from your
``local.conf`` file. Consequently, you do not have to do anything to
enable the class. However, if you want to disable the class, simply
remove "buildstats" from the ``USER_CLASSES`` list.
@@ -272,7 +272,7 @@ remove "buildstats" from the ``USER_CLASSES`` list.
When inherited globally, prints statistics at the end of the build on
sstate re-use. In order to function, this class requires the
-```buildstats`` <#ref-classes-buildstats>`__ class be enabled.
+:ref:`buildstats ` class be enabled.
.. _ref-classes-ccache:
@@ -318,7 +318,7 @@ and other common items used by Clutter and related recipes.
The ``cmake`` class allows for recipes that need to build software using
the `CMake `__ build system. You can use
-the ```EXTRA_OECMAKE`` <#var-EXTRA_OECMAKE>`__ variable to specify
+the :term:`EXTRA_OECMAKE` variable to specify
additional configuration options to be passed using the ``cmake``
command line.
@@ -326,7 +326,7 @@ On the occasion that you would be installing custom CMake toolchain
files supplied by the application being built, you should install them
to the preferred CMake Module directory: ``${D}${datadir}/cmake/``
Modules during
-```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__.
+:ref:`ref-tasks-install`.
.. _ref-classes-cml1:
@@ -344,7 +344,7 @@ build configuration system.
Enables compression for man pages and info pages. This class is intended
to be inherited globally. The default compression mechanism is gz (gzip)
but you can select an alternative mechanism by setting the
-```DOC_COMPRESS`` <#var-DOC_COMPRESS>`__ variable.
+:term:`DOC_COMPRESS` variable.
.. _ref-classes-copyleft_compliance:
@@ -354,15 +354,15 @@ but you can select an alternative mechanism by setting the
The ``copyleft_compliance`` class preserves source code for the purposes
of license compliance. This class is an alternative to the ``archiver``
class and is still used by some users even though it has been deprecated
-in favor of the ```archiver`` <#ref-classes-archiver>`__ class.
+in favor of the :ref:`archiver ` class.
.. _ref-classes-copyleft_filter:
``copyleft_filter.bbclass``
===========================
-A class used by the ```archiver`` <#ref-classes-archiver>`__ and
-```copyleft_compliance`` <#ref-classes-copyleft_compliance>`__ classes
+A class used by the :ref:`archiver ` and
+:ref:`copyleft_compliance ` classes
for filtering licenses. The ``copyleft_filter`` class is an internal
class and is not intended to be used directly.
@@ -373,7 +373,7 @@ class and is not intended to be used directly.
The ``core-image`` class provides common definitions for the
``core-image-*`` image recipes, such as support for additional
-```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__.
+:term:`IMAGE_FEATURES`.
.. _ref-classes-cpan:
@@ -439,7 +439,7 @@ Debian naming policy (i.e. ``glibc`` becomes ``libc6`` and
name and version as part of the package name.
If a recipe creates packages for multiple libraries (shared object files
-of ``.so`` type), use the ```LEAD_SONAME`` <#var-LEAD_SONAME>`__
+of ``.so`` type), use the :term:`LEAD_SONAME`
variable in the recipe to specify the library on which to apply the
naming scheme.
@@ -449,14 +449,14 @@ naming scheme.
==================
The ``deploy`` class handles deploying files to the
-```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__ directory. The main
+:term:`DEPLOY_DIR_IMAGE` directory. The main
function of this class is to allow the deploy step to be accelerated by
shared state. Recipes that inherit this class should define their own
-```do_deploy`` <#ref-tasks-deploy>`__ function to copy the files to be
-deployed to ```DEPLOYDIR`` <#var-DEPLOYDIR>`__, and use ``addtask`` to
+:ref:`ref-tasks-deploy` function to copy the files to be
+deployed to :term:`DEPLOYDIR`, and use ``addtask`` to
add the task at the appropriate place, which is usually after
-```do_compile`` <#ref-tasks-compile>`__ or
-```do_install`` <#ref-tasks-install>`__. The class then takes care of
+:ref:`ref-tasks-compile` or
+:ref:`ref-tasks-install`. The class then takes care of
staging the files from ``DEPLOYDIR`` to ``DEPLOY_DIR_IMAGE``.
.. _ref-classes-devshell:
@@ -476,13 +476,13 @@ information about using ``devshell``.
=======================
The ``devupstream`` class uses
-```BBCLASSEXTEND`` <#var-BBCLASSEXTEND>`__ to add a variant of the
+:term:`BBCLASSEXTEND` to add a variant of the
recipe that fetches from an alternative URI (e.g. Git) instead of a
tarball. Following is an example: BBCLASSEXTEND = "devupstream:target"
SRC_URI_class-devupstream = "git://git.example.com/example"
SRCREV_class-devupstream = "abcd1234" Adding the above statements to
your recipe creates a variant that has
-```DEFAULT_PREFERENCE`` <#var-DEFAULT_PREFERENCE>`__ set to "-1".
+:term:`DEFAULT_PREFERENCE` set to "-1".
Consequently, you need to select the variant of the recipe to use it.
Any development-specific adjustments can be done by using the
``class-devupstream`` override. Here is an example:
@@ -506,11 +506,11 @@ due to BitBake's automatic fetch dependencies (e.g.
The ``distro_features_check`` class allows individual recipes to check
for required and conflicting
-```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__.
+:term:`DISTRO_FEATURES`.
This class provides support for the
-```REQUIRED_DISTRO_FEATURES`` <#var-REQUIRED_DISTRO_FEATURES>`__ and
-```CONFLICT_DISTRO_FEATURES`` <#var-CONFLICT_DISTRO_FEATURES>`__
+:term:`REQUIRED_DISTRO_FEATURES` and
+:term:`CONFLICT_DISTRO_FEATURES`
variables. If any conditions specified in the recipe using the above
variables are not met, the recipe will be skipped.
@@ -532,7 +532,7 @@ used.
``distutils`` class in their recipes.
- Extensions that use build systems based on ``setuptools`` require the
- ```setuptools`` <#ref-classes-setuptools>`__ class in their recipes.
+ :ref:`setuptools ` class in their recipes.
The ``distutils-common-base`` class is required by some of the
``distutils*`` classes to provide common Python2 support.
@@ -574,22 +574,22 @@ that is external to the OpenEmbedded build system. Building software
from an external source tree means that the build system's normal fetch,
unpack, and patch process is not used.
-By default, the OpenEmbedded build system uses the ```S`` <#var-S>`__
-and ```B`` <#var-B>`__ variables to locate unpacked recipe source code
+By default, the OpenEmbedded build system uses the :term:`S`
+and :term:`B` variables to locate unpacked recipe source code
and to build it, respectively. When your recipe inherits the
``externalsrc`` class, you use the
-```EXTERNALSRC`` <#var-EXTERNALSRC>`__ and
-```EXTERNALSRC_BUILD`` <#var-EXTERNALSRC_BUILD>`__ variables to
+:term:`EXTERNALSRC` and
+:term:`EXTERNALSRC_BUILD` variables to
ultimately define ``S`` and ``B``.
By default, this class expects the source code to support recipe builds
-that use the ```B`` <#var-B>`__ variable to point to the directory in
+that use the :term:`B` variable to point to the directory in
which the OpenEmbedded build system places the generated objects built
from the recipes. By default, the ``B`` directory is set to the
following, which is separate from the source directory (``S``):
${WORKDIR}/${BPN}/{PV}/ See these variables for more information:
-```WORKDIR`` <#var-WORKDIR>`__, ```BPN`` <#var-BPN>`__, and
-```PV`` <#var-PV>`__,
+:term:`WORKDIR`, :term:`BPN`, and
+:term:`PV`,
For more information on the ``externalsrc`` class, see the comments in
``meta/classes/externalsrc.bbclass`` in the `Source
@@ -607,7 +607,7 @@ The ``extrausers`` class allows additional user and group configuration
to be applied at the image level. Inheriting this class either globally
or from an image recipe allows additional user and group operations to
be performed using the
-```EXTRA_USERS_PARAMS`` <#var-EXTRA_USERS_PARAMS>`__ variable.
+:term:`EXTRA_USERS_PARAMS` variable.
.. note::
@@ -642,7 +642,7 @@ architecture-specific, ``fc-cache`` runs using QEMU if the postinst
scriptlets need to be run on the build host during image creation.
If the fonts being installed are in packages other than the main
-package, set ```FONT_PACKAGES`` <#var-FONT_PACKAGES>`__ to specify the
+package, set :term:`FONT_PACKAGES` to specify the
packages containing the fonts.
.. _ref-classes-fs-uuid:
@@ -651,7 +651,7 @@ packages containing the fonts.
===================
The ``fs-uuid`` class extracts UUID from
-``${``\ ```ROOTFS`` <#var-ROOTFS>`__\ ``}``, which must have been built
+``${``\ :term:`ROOTFS`\ ``}``, which must have been built
by the time that this function gets called. The ``fs-uuid`` class only
works on ``ext`` file systems and depends on ``tune2fs``.
@@ -662,7 +662,7 @@ works on ``ext`` file systems and depends on ``tune2fs``.
The ``gconf`` class provides common functionality for recipes that need
to install GConf schemas. The schemas will be put into a separate
-package (``${``\ ```PN`` <#var-PN>`__\ ``}-gconf``) that is created
+package (``${``\ :term:`PN`\ ``}-gconf``) that is created
automatically when this class is inherited. This package uses the
appropriate post-install and post-remove (postinst/postrm) scriptlets to
register and unregister the schemas in the target image.
@@ -684,8 +684,8 @@ class.
The ``gnomebase`` class is the base class for recipes that build
software from the GNOME stack. This class sets
-```SRC_URI`` <#var-SRC_URI>`__ to download the source from the GNOME
-mirrors as well as extending ```FILES`` <#var-FILES>`__ with the typical
+:term:`SRC_URI` to download the source from the GNOME
+mirrors as well as extending :term:`FILES` with the typical
GNOME installation paths.
.. _ref-classes-gobject-introspection:
@@ -696,9 +696,9 @@ GNOME installation paths.
Provides support for recipes building software that supports GObject
introspection. This functionality is only enabled if the
"gobject-introspection-data" feature is in
-```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ as well as
+:term:`DISTRO_FEATURES` as well as
"qemu-usermode" being in
-```MACHINE_FEATURES`` <#var-MACHINE_FEATURES>`__.
+:term:`MACHINE_FEATURES`.
.. note::
@@ -719,26 +719,26 @@ building bootable images.
This class supports several variables:
-- ```INITRD`` <#var-INITRD>`__: Indicates list of filesystem images to
+- :term:`INITRD`: Indicates list of filesystem images to
concatenate and use as an initial RAM disk (initrd) (optional).
-- ```ROOTFS`` <#var-ROOTFS>`__: Indicates a filesystem image to include
+- :term:`ROOTFS`: Indicates a filesystem image to include
as the root filesystem (optional).
-- ```GRUB_GFXSERIAL`` <#var-GRUB_GFXSERIAL>`__: Set this to "1" to have
+- :term:`GRUB_GFXSERIAL`: Set this to "1" to have
graphics and serial in the boot menu.
-- ```LABELS`` <#var-LABELS>`__: A list of targets for the automatic
+- :term:`LABELS`: A list of targets for the automatic
configuration.
-- ```APPEND`` <#var-APPEND>`__: An override list of append strings for
+- :term:`APPEND`: An override list of append strings for
each ``LABEL``.
-- ```GRUB_OPTS`` <#var-GRUB_OPTS>`__: Additional options to add to the
+- :term:`GRUB_OPTS`: Additional options to add to the
configuration (optional). Options are delimited using semi-colon
characters (``;``).
-- ```GRUB_TIMEOUT`` <#var-GRUB_TIMEOUT>`__: Timeout before executing
+- :term:`GRUB_TIMEOUT`: Timeout before executing
the default ``LABEL`` (optional).
.. _ref-classes-gsettings:
@@ -788,7 +788,7 @@ need to be run on the build host during image creation.
If the input method modules being installed are in packages other than
the main package, set
-```GTKIMMODULES_PACKAGES`` <#var-GTKIMMODULES_PACKAGES>`__ to specify
+:term:`GTKIMMODULES_PACKAGES` to specify
the packages containing the modules.
.. _ref-classes-gzipnative:
@@ -826,9 +826,9 @@ The class handles all three different compile stages (i.e native
``tar.gz`` file to be used by the remote machines. The class also
supports SDK generation.
-If ```ICECC_PATH`` <#var-ICECC_PATH>`__ is not set in your
+If :term:`ICECC_PATH` is not set in your
``local.conf`` file, then the class tries to locate the ``icecc`` binary
-using ``which``. If ```ICECC_ENV_EXEC`` <#var-ICECC_ENV_EXEC>`__ is set
+using ``which``. If :term:`ICECC_ENV_EXEC` is set
in your ``local.conf`` file, the variable should point to the
``icecc-create-env`` script provided by the user. If you do not point to
a user-provided script, the build system uses the default script
@@ -843,15 +843,15 @@ provided by the recipe ``icecc-create-env-native.bb``.
If you do not want the Icecream distributed compile support to apply to
specific recipes or classes, you can effectively "blacklist" them by
listing the recipes and classes using the
-```ICECC_USER_PACKAGE_BL`` <#var-ICECC_USER_PACKAGE_BL>`__ and
-```ICECC_USER_CLASS_BL`` <#var-ICECC_USER_CLASS_BL>`__, variables,
+:term:`ICECC_USER_PACKAGE_BL` and
+:term:`ICECC_USER_CLASS_BL`, variables,
respectively, in your ``local.conf`` file. Doing so causes the
OpenEmbedded build system to handle these compilations locally.
Additionally, you can list recipes using the
-```ICECC_USER_PACKAGE_WL`` <#var-ICECC_USER_PACKAGE_WL>`__ variable in
+:term:`ICECC_USER_PACKAGE_WL` variable in
your ``local.conf`` file to force ``icecc`` to be enabled for recipes
-using an empty ```PARALLEL_MAKE`` <#var-PARALLEL_MAKE>`__ variable.
+using an empty :term:`PARALLEL_MAKE` variable.
Inheriting the ``icecc`` class changes all sstate signatures.
Consequently, if a development team has a dedicated build system that
@@ -862,7 +862,7 @@ system need to either inherit the ``icecc`` class or nobody should.
At the distribution level, you can inherit the ``icecc`` class to be
sure that all builders start with the same sstate signatures. After
inheriting the class, you can then disable the feature by setting the
-```ICECC_DISABLED`` <#var-ICECC_DISABLED>`__ variable to "1" as follows:
+:term:`ICECC_DISABLED` variable to "1" as follows:
INHERIT_DISTRO_append = " icecc" ICECC_DISABLED ??= "1" This practice
makes sure everyone is using the same signatures but also requires
individuals that do want to use Icecream to enable the feature
@@ -906,11 +906,11 @@ filesystem on ``/etc/build``.
The ``image_types`` class defines all of the standard image output types
that you can enable through the
-```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable. You can use this
+:term:`IMAGE_FSTYPES` variable. You can use this
class as a reference on how to add support for custom image output
types.
-By default, the ```image`` <#ref-classes-image>`__ class automatically
+By default, the :ref:`image ` class automatically
enables the ``image_types`` class. The ``image`` class uses the
``IMGCLASSES`` variable as follows: IMGCLASSES =
"rootfs_${IMAGE_PKGTYPE} image_types ${IMAGE_CLASSES}" IMGCLASSES +=
@@ -940,11 +940,11 @@ images.
This class controls building "live" (i.e. HDDIMG and ISO) images. Live
images contain syslinux for legacy booting, as well as the bootloader
-specified by ```EFI_PROVIDER`` <#var-EFI_PROVIDER>`__ if
-```MACHINE_FEATURES`` <#var-MACHINE_FEATURES>`__ contains "efi".
+specified by :term:`EFI_PROVIDER` if
+:term:`MACHINE_FEATURES` contains "efi".
Normally, you do not use this class directly. Instead, you add "live" to
-```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__.
+:term:`IMAGE_FSTYPES`.
.. _ref-classes-image-mklibs:
@@ -952,11 +952,11 @@ Normally, you do not use this class directly. Instead, you add "live" to
========================
The ``image-mklibs`` class enables the use of the ``mklibs`` utility
-during the ```do_rootfs`` <#ref-tasks-rootfs>`__ task, which optimizes
+during the :ref:`ref-tasks-rootfs` task, which optimizes
the size of libraries contained in the image.
By default, the class is enabled in the ``local.conf.template`` using
-the ```USER_CLASSES`` <#var-USER_CLASSES>`__ variable as follows:
+the :term:`USER_CLASSES` variable as follows:
USER_CLASSES ?= "buildstats image-mklibs image-prelink"
.. _ref-classes-image-prelink:
@@ -965,12 +965,12 @@ USER_CLASSES ?= "buildstats image-mklibs image-prelink"
=========================
The ``image-prelink`` class enables the use of the ``prelink`` utility
-during the ```do_rootfs`` <#ref-tasks-rootfs>`__ task, which optimizes
+during the :ref:`ref-tasks-rootfs` task, which optimizes
the dynamic linking of shared libraries to reduce executable startup
time.
By default, the class is enabled in the ``local.conf.template`` using
-the ```USER_CLASSES`` <#var-USER_CLASSES>`__ variable as follows:
+the :term:`USER_CLASSES` variable as follows:
USER_CLASSES ?= "buildstats image-mklibs image-prelink"
.. _ref-classes-insane:
@@ -992,11 +992,11 @@ condition. See the "`QA Error and Warning Messages <#ref-qa-checks>`__"
Chapter for a list of all the warning and error messages you might
encounter using a default configuration.
-Use the ```WARN_QA`` <#var-WARN_QA>`__ and
-```ERROR_QA`` <#var-ERROR_QA>`__ variables to control the behavior of
+Use the :term:`WARN_QA` and
+:term:`ERROR_QA` variables to control the behavior of
these checks at the global level (i.e. in your custom distro
configuration). However, to skip one or more checks in recipes, you
-should use ```INSANE_SKIP`` <#var-INSANE_SKIP>`__. For example, to skip
+should use :term:`INSANE_SKIP`. For example, to skip
the check for symbolic link ``.so`` files in the main package of a
recipe, add the following to the recipe. You need to realize that the
package name override, in this example ``${PN}``, must be used:
@@ -1026,17 +1026,17 @@ The following list shows the tests you can list with the ``WARN_QA`` and
positives and thus is not normally enabled.
- *``build-deps:``* Determines if a build-time dependency that is
- specified through ```DEPENDS`` <#var-DEPENDS>`__, explicit
- ```RDEPENDS`` <#var-RDEPENDS>`__, or task-level dependencies exists
+ specified through :term:`DEPENDS`, explicit
+ :term:`RDEPENDS`, or task-level dependencies exists
to match any runtime dependency. This determination is particularly
useful to discover where runtime dependencies are detected and added
during packaging. If no explicit dependency has been specified within
the metadata, at the packaging stage it is too late to ensure that
the dependency is built, and thus you can end up with an error when
the package is installed into the image during the
- ```do_rootfs`` <#ref-tasks-rootfs>`__ task because the auto-detected
+ :ref:`ref-tasks-rootfs` task because the auto-detected
dependency was not satisfied. An example of this would be where the
- ```update-rc.d`` <#ref-classes-update-rc.d>`__ class automatically
+ :ref:`update-rc.d ` class automatically
adds a dependency on the ``initscripts-functions`` package to
packages that install an initscript that refers to
``/etc/init.d/functions``. The recipe should really have an explicit
@@ -1046,7 +1046,7 @@ The following list shows the tests you can list with the ``WARN_QA`` and
``initscripts-functions`` package is made available.
- *``compile-host-path:``* Checks the
- ```do_compile`` <#ref-tasks-compile>`__ log for indications that
+ :ref:`ref-tasks-compile` log for indications that
paths to locations on the build host were used. Using such paths
might result in host contamination of the build output.
@@ -1060,12 +1060,12 @@ The following list shows the tests you can list with the ``WARN_QA`` and
- *``dep-cmp:``* Checks for invalid version comparison statements in
runtime dependency relationships between packages (i.e. in
- ```RDEPENDS`` <#var-RDEPENDS>`__,
- ```RRECOMMENDS`` <#var-RRECOMMENDS>`__,
- ```RSUGGESTS`` <#var-RSUGGESTS>`__,
- ```RPROVIDES`` <#var-RPROVIDES>`__,
- ```RREPLACES`` <#var-RREPLACES>`__, and
- ```RCONFLICTS`` <#var-RCONFLICTS>`__ variable values). Any invalid
+ :term:`RDEPENDS`,
+ :term:`RRECOMMENDS`,
+ :term:`RSUGGESTS`,
+ :term:`RPROVIDES`,
+ :term:`RREPLACES`, and
+ :term:`RCONFLICTS` variable values). Any invalid
comparisons might trigger failures or undesirable behavior when
passed to the package manager.
@@ -1094,10 +1094,10 @@ The following list shows the tests you can list with the ``WARN_QA`` and
However, the lack of that functionality in the other two package
managers does not mean the dependencies do not still need resolving.
This QA check attempts to ensure that explicitly declared
- ```RDEPENDS`` <#var-RDEPENDS>`__ exist to handle any file-level
+ :term:`RDEPENDS` exist to handle any file-level
dependency detected in packaged files.
-- *``files-invalid:``* Checks for ```FILES`` <#var-FILES>`__ variable
+- *``files-invalid:``* Checks for :term:`FILES` variable
values that contain "//", which is invalid.
- *``host-user-contaminated:``* Checks that no package produced by the
@@ -1106,33 +1106,33 @@ The following list shows the tests you can list with the ``WARN_QA`` and
that the files are being installed with an incorrect UID/GID, since
target IDs are independent from host IDs. For additional information,
see the section describing the
- ```do_install`` <#ref-tasks-install>`__ task.
+ :ref:`ref-tasks-install` task.
- *``incompatible-license:``* Report when packages are excluded from
being created due to being marked with a license that is in
- ```INCOMPATIBLE_LICENSE`` <#var-INCOMPATIBLE_LICENSE>`__.
+ :term:`INCOMPATIBLE_LICENSE`.
- *``install-host-path:``* Checks the
- ```do_install`` <#ref-tasks-install>`__ log for indications that
+ :ref:`ref-tasks-install` log for indications that
paths to locations on the build host were used. Using such paths
might result in host contamination of the build output.
- *``installed-vs-shipped:``* Reports when files have been installed
within ``do_install`` but have not been included in any package by
- way of the ```FILES`` <#var-FILES>`__ variable. Files that do not
+ way of the :term:`FILES` variable. Files that do not
appear in any package cannot be present in an image later on in the
build process. Ideally, all installed files should be packaged or not
installed at all. These files can be deleted at the end of
``do_install`` if the files are not needed in any package.
- *``invalid-chars:``* Checks that the recipe metadata variables
- ```DESCRIPTION`` <#var-DESCRIPTION>`__,
- ```SUMMARY`` <#var-SUMMARY>`__, ```LICENSE`` <#var-LICENSE>`__, and
- ```SECTION`` <#var-SECTION>`__ do not contain non-UTF-8 characters.
+ :term:`DESCRIPTION`,
+ :term:`SUMMARY`, :term:`LICENSE`, and
+ :term:`SECTION` do not contain non-UTF-8 characters.
Some package managers do not support such characters.
- *``invalid-packageconfig:``* Checks that no undefined features are
- being added to ```PACKAGECONFIG`` <#var-PACKAGECONFIG>`__. For
+ being added to :term:`PACKAGECONFIG`. For
example, any name "foo" for which the following form does not exist:
PACKAGECONFIG[foo] = "..."
@@ -1141,7 +1141,7 @@ The following list shows the tests you can list with the ``WARN_QA`` and
correct sysroot prefix when using the files automatically itself.
- *``ldflags:``* Ensures that the binaries were linked with the
- ```LDFLAGS`` <#var-LDFLAGS>`__ options provided by the build system.
+ :term:`LDFLAGS` options provided by the build system.
If this test fails, check that the ``LDFLAGS`` variable is being
passed to the linker command.
@@ -1156,7 +1156,7 @@ The following list shows the tests you can list with the ``WARN_QA`` and
variable has been set explicitly to ``/usr/libexec``.
- *``packages-list:``* Checks for the same package being listed
- multiple times through the ```PACKAGES`` <#var-PACKAGES>`__ variable
+ multiple times through the :term:`PACKAGES` variable
value. Installing the package in this manner can cause errors during
packaging.
@@ -1172,27 +1172,27 @@ The following list shows the tests you can list with the ``WARN_QA`` and
- *``perms:``* Currently, this check is unused but reserved.
- *``pkgconfig:``* Checks ``.pc`` files for any
- ```TMPDIR`` <#var-TMPDIR>`__/```WORKDIR`` <#var-WORKDIR>`__ paths.
+ :term:`TMPDIR`/:term:`WORKDIR` paths.
Any ``.pc`` file containing these paths is incorrect since
``pkg-config`` itself adds the correct sysroot prefix when the files
are accessed.
- *``pkgname:``* Checks that all packages in
- ```PACKAGES`` <#var-PACKAGES>`__ have names that do not contain
+ :term:`PACKAGES` have names that do not contain
invalid characters (i.e. characters other than 0-9, a-z, ., +, and
-).
- *``pkgv-undefined:``* Checks to see if the ``PKGV`` variable is
- undefined during ```do_package`` <#ref-tasks-package>`__.
+ undefined during :ref:`ref-tasks-package`.
- *``pkgvarcheck:``* Checks through the variables
- ```RDEPENDS`` <#var-RDEPENDS>`__,
- ```RRECOMMENDS`` <#var-RRECOMMENDS>`__,
- ```RSUGGESTS`` <#var-RSUGGESTS>`__,
- ```RCONFLICTS`` <#var-RCONFLICTS>`__,
- ```RPROVIDES`` <#var-RPROVIDES>`__,
- ```RREPLACES`` <#var-RREPLACES>`__, ```FILES`` <#var-FILES>`__,
- ```ALLOW_EMPTY`` <#var-ALLOW_EMPTY>`__, ``pkg_preinst``,
+ :term:`RDEPENDS`,
+ :term:`RRECOMMENDS`,
+ :term:`RSUGGESTS`,
+ :term:`RCONFLICTS`,
+ :term:`RPROVIDES`,
+ :term:`RREPLACES`, :term:`FILES`,
+ :term:`ALLOW_EMPTY`, ``pkg_preinst``,
``pkg_postinst``, ``pkg_prerm`` and ``pkg_postrm``, and reports if
there are variable sets that are not package-specific. Using these
variables without a package suffix is bad practice, and might
@@ -1200,11 +1200,11 @@ The following list shows the tests you can list with the ``WARN_QA`` and
same recipe or have other unintended consequences.
- *``pn-overrides:``* Checks that a recipe does not have a name
- (```PN`` <#var-PN>`__) value that appears in
- ```OVERRIDES`` <#var-OVERRIDES>`__. If a recipe is named such that
+ (:term:`PN`) value that appears in
+ :term:`OVERRIDES`. If a recipe is named such that
its ``PN`` value matches something already in ``OVERRIDES`` (e.g.
- ``PN`` happens to be the same as ```MACHINE`` <#var-MACHINE>`__ or
- ```DISTRO`` <#var-DISTRO>`__), it can have unexpected consequences.
+ ``PN`` happens to be the same as :term:`MACHINE` or
+ :term:`DISTRO`), it can have unexpected consequences.
For example, assignments such as ``FILES_${PN} = "xyz"`` effectively
turn into ``FILES = "xyz"``.
@@ -1220,7 +1220,7 @@ The following list shows the tests you can list with the ``WARN_QA`` and
non-``staticdev`` packages.
- *``symlink-to-sysroot:``* Checks for symlinks in packages that point
- into ```TMPDIR`` <#var-TMPDIR>`__ on the host. Such symlinks will
+ into :term:`TMPDIR` on the host. Such symlinks will
work on the host, but are clearly invalid when running on the target.
- *``textrel:``* Checks for ELF binaries that contain relocations in
@@ -1231,7 +1231,7 @@ The following list shows the tests you can list with the ``WARN_QA`` and
- *``unlisted-pkg-lics:``* Checks that all declared licenses applying
for a package are also declared on the recipe level (i.e. any license
- in ``LICENSE_*`` should appear in ```LICENSE`` <#var-LICENSE>`__).
+ in ``LICENSE_*`` should appear in :term:`LICENSE`).
- *``useless-rpaths:``* Checks for dynamic library load paths (rpaths)
in the binaries that by default on a standard system are searched by
@@ -1239,10 +1239,10 @@ The following list shows the tests you can list with the ``WARN_QA`` and
not cause any breakage, they do waste space and are unnecessary.
- *``var-undefined:``* Reports when variables fundamental to packaging
- (i.e. ```WORKDIR`` <#var-WORKDIR>`__,
- ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__, ```D`` <#var-D>`__,
- ```PN`` <#var-PN>`__, and ```PKGD`` <#var-PKGD>`__) are undefined
- during ```do_package`` <#ref-tasks-package>`__.
+ (i.e. :term:`WORKDIR`,
+ :term:`DEPLOY_DIR`, :term:`D`,
+ :term:`PN`, and :term:`PKGD`) are undefined
+ during :ref:`ref-tasks-package`.
- *``version-going-backwards:``* If Build History is enabled, reports
when a package being written out has a lower version than the
@@ -1283,7 +1283,7 @@ themselves.
The ``kernel`` class handles building Linux kernels. The class contains
code to build all kernel trees. All needed headers are staged into the
``STAGING_KERNEL_DIR`` directory to allow out-of-tree module builds
-using the ```module`` <#ref-classes-module>`__ class.
+using the :ref:`module ` class.
This means that each built kernel module is packaged separately and
inter-module dependencies are created by parsing the ``modinfo`` output.
@@ -1299,9 +1299,9 @@ Image <&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image>`__" section in
the Yocto Project Development Tasks Manual.
Various other classes are used by the ``kernel`` and ``module`` classes
-internally including the ```kernel-arch`` <#ref-classes-kernel-arch>`__,
-```module-base`` <#ref-classes-module-base>`__, and
-```linux-kernel-base`` <#ref-classes-linux-kernel-base>`__ classes.
+internally including the :ref:`kernel-arch `,
+:ref:`module-base `, and
+:ref:`linux-kernel-base ` classes.
.. _ref-classes-kernel-arch:
@@ -1317,7 +1317,7 @@ Linux kernel compilation (including modules).
=============================
The ``kernel-devicetree`` class, which is inherited by the
-```kernel`` <#ref-classes-kernel>`__ class, supports device tree
+:ref:`kernel ` class, supports device tree
generation.
.. _ref-classes-kernel-fitimage:
@@ -1422,7 +1422,7 @@ The ``kernelsrc`` class sets the Linux kernel source and version.
The ``lib_package`` class supports recipes that build libraries and
produce executable binaries, where those binaries should not be
installed by default along with the library. Instead, the binaries are
-added to a separate ``${``\ ```PN`` <#var-PN>`__\ ``}-bin`` package to
+added to a separate ``${``\ :term:`PN`\ ``}-bin`` package to
make their installation optional.
.. _ref-classes-libc*:
@@ -1445,7 +1445,7 @@ The ``libc*`` classes support recipes that build packages with ``libc``:
The ``license`` class provides license manifest creation and license
exclusion. This class is enabled by default using the default value for
-the ```INHERIT_DISTRO`` <#var-INHERIT_DISTRO>`__ variable.
+the :term:`INHERIT_DISTRO` variable.
.. _ref-classes-linux-kernel-base:
@@ -1495,7 +1495,7 @@ recipes.
The ``metadata_scm`` class provides functionality for querying the
branch and revision of a Source Code Manager (SCM) repository.
-The ```base`` <#ref-classes-base>`__ class uses this class to print the
+The :ref:`base ` class uses this class to print the
revisions of each layer before starting every build. The
``metadata_scm`` class is enabled by default because it is inherited by
the ``base`` class.
@@ -1524,12 +1524,12 @@ the shared database.
===================
The ``mirrors`` class sets up some standard
-```MIRRORS`` <#var-MIRRORS>`__ entries for source code mirrors. These
+:term:`MIRRORS` entries for source code mirrors. These
mirrors provide a fall-back path in case the upstream source specified
-in ```SRC_URI`` <#var-SRC_URI>`__ within recipes is unavailable.
+in :term:`SRC_URI` within recipes is unavailable.
This class is enabled by default since it is inherited by the
-```base`` <#ref-classes-base>`__ class.
+:ref:`base ` class.
.. _ref-classes-module:
@@ -1538,10 +1538,10 @@ This class is enabled by default since it is inherited by the
The ``module`` class provides support for building out-of-tree Linux
kernel modules. The class inherits the
-```module-base`` <#ref-classes-module-base>`__ and
-```kernel-module-split`` <#ref-classes-kernel-module-split>`__ classes,
-and implements the ```do_compile`` <#ref-tasks-compile>`__ and
-```do_install`` <#ref-tasks-install>`__ tasks. The class provides
+:ref:`module-base ` and
+:ref:`kernel-module-split ` classes,
+and implements the :ref:`ref-tasks-compile` and
+:ref:`ref-tasks-install` tasks. The class provides
everything needed to build and package a kernel module.
For general information on out-of-tree Linux kernel modules, see the
@@ -1558,7 +1558,7 @@ The ``module-base`` class provides the base functionality for building
Linux kernel modules. Typically, a recipe that builds software that
includes one or more kernel modules and has its own means of building
the module inherits this class as opposed to inheriting the
-```module`` <#ref-classes-module>`__ class.
+:ref:`module ` class.
.. _ref-classes-multilib*:
@@ -1604,7 +1604,7 @@ a couple different ways:
caused by existing code that depends on that naming convention.
- Create or modify a target recipe that contains the following:
- ```BBCLASSEXTEND`` <#var-BBCLASSEXTEND>`__ = "native" Inside the
+ :term:`BBCLASSEXTEND` = "native" Inside the
recipe, use ``_class-native`` and ``_class-target`` overrides to
specify any functionality specific to the respective native or target
case.
@@ -1621,7 +1621,7 @@ target. All common parts of the recipe are automatically shared.
The ``nativesdk`` class provides common functionality for recipes that
wish to build tools to run as part of an SDK (i.e. tools that run on
-```SDKMACHINE`` <#var-SDKMACHINE>`__).
+:term:`SDKMACHINE`).
You can create a recipe that builds tools that run on the SDK machine a
couple different ways:
@@ -1632,7 +1632,7 @@ couple different ways:
that the ``nativesdk`` class is inherited last.
- Create a ``nativesdk`` variant of any recipe by adding the following:
- ```BBCLASSEXTEND`` <#var-BBCLASSEXTEND>`__ = "nativesdk" Inside the
+ :term:`BBCLASSEXTEND` = "nativesdk" Inside the
recipe, use ``_class-nativesdk`` and ``_class-target`` overrides to
specify any functionality specific to the respective SDK machine or
target case.
@@ -1686,7 +1686,7 @@ section in the Yocto Project Development Tasks Manual.
==================
The ``oelint`` class is an obsolete lint checking tool that exists in
-``meta/classes`` in the `Source Directory <#source-directory>`__.
+``meta/classes`` in the :term:`Source Directory`.
A number of classes exist that could be generally useful in OE-Core but
are never actually used within OE-Core itself. The ``oelint`` class is
@@ -1700,12 +1700,12 @@ layers.
=======================
The ``own-mirrors`` class makes it easier to set up your own
-```PREMIRRORS`` <#var-PREMIRRORS>`__ from which to first fetch source
+:term:`PREMIRRORS` from which to first fetch source
before attempting to fetch it from the upstream specified in
-```SRC_URI`` <#var-SRC_URI>`__ within each recipe.
+:term:`SRC_URI` within each recipe.
To use this class, inherit it globally and specify
-```SOURCE_MIRROR_URL`` <#var-SOURCE_MIRROR_URL>`__. Here is an example:
+:term:`SOURCE_MIRROR_URL`. Here is an example:
INHERIT += "own-mirrors" SOURCE_MIRROR_URL =
"http://example.com/my-source-mirror" You can specify only a single URL
in ``SOURCE_MIRROR_URL``.
@@ -1719,10 +1719,10 @@ The ``package`` class supports generating packages from a build's
output. The core generic functionality is in ``package.bbclass``. The
code specific to particular package types resides in these
package-specific classes:
-```package_deb`` <#ref-classes-package_deb>`__,
-```package_rpm`` <#ref-classes-package_rpm>`__,
-```package_ipk`` <#ref-classes-package_ipk>`__, and
-```package_tar`` <#ref-classes-package_tar>`__.
+:ref:`package_deb `,
+:ref:`package_rpm `,
+:ref:`package_ipk `, and
+:ref:`package_tar `.
.. note::
@@ -1753,7 +1753,7 @@ takes about thirty percent less time as compared to using RPM to build
the same or similar package. This comparison takes into account a
complete build of the package with all dependencies previously built.
The reason for this discrepancy is because the RPM package manager
-creates and processes more `Metadata <#metadata>`__ than the IPK package
+creates and processes more :term:`Metadata` than the IPK package
manager. Consequently, you might consider setting ``PACKAGE_CLASSES`` to
"package_ipk" if you are building smaller systems.
@@ -1786,10 +1786,10 @@ at these two Yocto Project mailing list links:
The ``package_deb`` class provides support for creating packages that
use the Debian (i.e. ``.deb``) file format. The class ensures the
packages are written out in a ``.deb`` file format to the
-``${``\ ```DEPLOY_DIR_DEB`` <#var-DEPLOY_DIR_DEB>`__\ ``}`` directory.
+``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory.
-This class inherits the ```package`` <#ref-classes-package>`__ class and
-is enabled through the ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__
+This class inherits the :ref:`package ` class and
+is enabled through the :term:`PACKAGE_CLASSES`
variable in the ``local.conf`` file.
.. _ref-classes-package_ipk:
@@ -1800,10 +1800,10 @@ variable in the ``local.conf`` file.
The ``package_ipk`` class provides support for creating packages that
use the IPK (i.e. ``.ipk``) file format. The class ensures the packages
are written out in a ``.ipk`` file format to the
-``${``\ ```DEPLOY_DIR_IPK`` <#var-DEPLOY_DIR_IPK>`__\ ``}`` directory.
+``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory.
-This class inherits the ```package`` <#ref-classes-package>`__ class and
-is enabled through the ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__
+This class inherits the :ref:`package ` class and
+is enabled through the :term:`PACKAGE_CLASSES`
variable in the ``local.conf`` file.
.. _ref-classes-package_rpm:
@@ -1814,10 +1814,10 @@ variable in the ``local.conf`` file.
The ``package_rpm`` class provides support for creating packages that
use the RPM (i.e. ``.rpm``) file format. The class ensures the packages
are written out in a ``.rpm`` file format to the
-``${``\ ```DEPLOY_DIR_RPM`` <#var-DEPLOY_DIR_RPM>`__\ ``}`` directory.
+``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory.
-This class inherits the ```package`` <#ref-classes-package>`__ class and
-is enabled through the ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__
+This class inherits the :ref:`package ` class and
+is enabled through the :term:`PACKAGE_CLASSES`
variable in the ``local.conf`` file.
.. _ref-classes-package_tar:
@@ -1827,10 +1827,10 @@ variable in the ``local.conf`` file.
The ``package_tar`` class provides support for creating tarballs. The
class ensures the packages are written out in a tarball format to the
-``${``\ ```DEPLOY_DIR_TAR`` <#var-DEPLOY_DIR_TAR>`__\ ``}`` directory.
+``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory.
-This class inherits the ```package`` <#ref-classes-package>`__ class and
-is enabled through the ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__
+This class inherits the :ref:`package ` class and
+is enabled through the :term:`PACKAGE_CLASSES`
variable in the ``local.conf`` file.
.. note::
@@ -1853,12 +1853,12 @@ variable in the ``local.conf`` file.
=======================
The ``packagedata`` class provides common functionality for reading
-``pkgdata`` files found in ```PKGDATA_DIR`` <#var-PKGDATA_DIR>`__. These
+``pkgdata`` files found in :term:`PKGDATA_DIR`. These
files contain information about each output package produced by the
OpenEmbedded build system.
This class is enabled by default because it is inherited by the
-```package`` <#ref-classes-package>`__ class.
+:ref:`package ` class.
.. _ref-classes-packagegroup:
@@ -1883,10 +1883,10 @@ Previously, this class was called the ``task`` class.
=================
The ``patch`` class provides all functionality for applying patches
-during the ```do_patch`` <#ref-tasks-patch>`__ task.
+during the :ref:`ref-tasks-patch` task.
This class is enabled by default because it is inherited by the
-```base`` <#ref-classes-base>`__ class.
+:ref:`base ` class.
.. _ref-classes-perlnative:
@@ -1912,7 +1912,7 @@ host during image creation.
If the pixbuf loaders being installed are in packages other than the
recipe's main package, set
-```PIXBUF_PACKAGES`` <#var-PIXBUF_PACKAGES>`__ to specify the packages
+:term:`PIXBUF_PACKAGES` to specify the packages
containing the loaders.
.. _ref-classes-pkgconfig:
@@ -1936,7 +1936,7 @@ files.
The ``populate_sdk`` class provides support for SDK-only recipes. For
information on advantages gained when building a cross-development
-toolchain using the ```do_populate_sdk`` <#ref-tasks-populate_sdk>`__
+toolchain using the :ref:`ref-tasks-populate_sdk`
task, see the "`Building an SDK
Installer <&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer>`__"
section in the Yocto Project Application Development and the Extensible
@@ -1967,15 +1967,15 @@ following classes:
The ``populate_sdk_base`` class inherits the appropriate
``populate_sdk_*`` (i.e. ``deb``, ``rpm``, and ``ipk``) based on
-```IMAGE_PKGTYPE`` <#var-IMAGE_PKGTYPE>`__.
+:term:`IMAGE_PKGTYPE`.
The base class ensures all source and destination directories are
established and then populates the SDK. After populating the SDK, the
``populate_sdk_base`` class constructs two sysroots:
-``${``\ ```SDK_ARCH`` <#var-SDK_ARCH>`__\ ``}-nativesdk``, which
+``${``\ :term:`SDK_ARCH`\ ``}-nativesdk``, which
contains the cross-compiler and associated tooling, and the target,
which contains a target root filesystem that is configured for the SDK
-usage. These two images reside in ```SDK_OUTPUT`` <#var-SDK_OUTPUT>`__,
+usage. These two images reside in :term:`SDK_OUTPUT`,
which consists of the following:
${SDK_OUTPUT}/${SDK_ARCH}-nativesdk-pkgs
${SDK_OUTPUT}/${SDKTARGETSYSROOT}/target-pkgs
@@ -1993,7 +1993,7 @@ the "`Cross-Development Toolchain
Generation <&YOCTO_DOCS_OM_URL;#cross-development-toolchain-generation>`__"
section in the Yocto Project Overview and Concepts Manual. For
information on advantages gained when building a cross-development
-toolchain using the ```do_populate_sdk`` <#ref-tasks-populate_sdk>`__
+toolchain using the :ref:`ref-tasks-populate_sdk`
task, see the "`Building an SDK
Installer <&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer>`__"
section in the Yocto Project Application Development and the Extensible
@@ -2005,7 +2005,7 @@ Software Development Kit (eSDK) manual.
====================
The ``prexport`` class provides functionality for exporting
-```PR`` <#var-PR>`__ values.
+:term:`PR` values.
.. note::
@@ -2020,7 +2020,7 @@ The ``prexport`` class provides functionality for exporting
====================
The ``primport`` class provides functionality for importing
-```PR`` <#var-PR>`__ values.
+:term:`PR` values.
.. note::
@@ -2036,13 +2036,13 @@ The ``primport`` class provides functionality for importing
The ``prserv`` class provides functionality for using a `PR
service <&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service>`__ in order to
-automatically manage the incrementing of the ```PR`` <#var-PR>`__
+automatically manage the incrementing of the :term:`PR`
variable for each recipe.
This class is enabled by default because it is inherited by the
-```package`` <#ref-classes-package>`__ class. However, the OpenEmbedded
+:ref:`package ` class. However, the OpenEmbedded
build system will not enable the functionality of this class unless
-```PRSERV_HOST`` <#var-PRSERV_HOST>`__ has been set.
+:term:`PRSERV_HOST` has been set.
.. _ref-classes-ptest:
@@ -2054,7 +2054,7 @@ runtime tests for recipes that build software that provides these tests.
This class is intended to be inherited by individual recipes. However,
the class' functionality is largely disabled unless "ptest" appears in
-```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__. See the "`Testing
+:term:`DISTRO_FEATURES`. See the "`Testing
Packages With
ptest <&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest>`__" section in
the Yocto Project Development Tasks Manual for more information on
@@ -2126,9 +2126,9 @@ are set or software that is present).
The ``relocatable`` class enables relocation of binaries when they are
installed into the sysroot.
-This class makes use of the ```chrpath`` <#ref-classes-chrpath>`__ class
-and is used by both the ```cross`` <#ref-classes-cross>`__ and
-```native`` <#ref-classes-native>`__ classes.
+This class makes use of the :ref:`chrpath ` class
+and is used by both the :ref:`cross ` and
+:ref:`native ` classes.
.. _ref-classes-remove-libtool:
@@ -2136,7 +2136,7 @@ and is used by both the ```cross`` <#ref-classes-cross>`__ and
==========================
The ``remove-libtool`` class adds a post function to the
-```do_install`` <#ref-tasks-install>`__ task to remove all ``.la`` files
+:ref:`ref-tasks-install` task to remove all ``.la`` files
installed by ``libtool``. Removing these files results in them being
absent from both the sysroot and target packages.
@@ -2163,7 +2163,7 @@ The class collects debug information for recipe, recipe version, task,
machine, distro, build system, target system, host distro, branch,
commit, and log. From the information, report files using a JSON format
are created and stored in
-``${``\ ```LOG_DIR`` <#var-LOG_DIR>`__\ ``}/error-report``.
+``${``\ :term:`LOG_DIR`\ ``}/error-report``.
.. _ref-classes-rm-work:
@@ -2216,7 +2216,7 @@ image and consist of the following classes:
The root filesystem is created from packages using one of the
``rootfs*.bbclass`` files as determined by the
-```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ variable.
+:term:`PACKAGE_CLASSES` variable.
For information on how root filesystem images are created, see the
"`Image
@@ -2242,7 +2242,7 @@ usually determines whether to include this class.
The ``scons`` class supports recipes that need to build software that
uses the SCons build system. You can use the
-```EXTRA_OESCONS`` <#var-EXTRA_OESCONS>`__ variable to specify
+:term:`EXTRA_OESCONS` variable to specify
additional configuration options you want to pass SCons command line.
.. _ref-classes-sdl:
@@ -2293,8 +2293,8 @@ Python bindings.
The ``siteconfig`` class provides functionality for handling site
configuration. The class is used by the
-```autotools`` <#ref-classes-autotools>`__ class to accelerate the
-```do_configure`` <#ref-tasks-configure>`__ task.
+:ref:`autotools ` class to accelerate the
+:ref:`ref-tasks-configure` task.
.. _ref-classes-siteinfo:
@@ -2337,7 +2337,7 @@ build.
The ``sstate`` class provides support for Shared State (sstate). By
default, the class is enabled through the
-```INHERIT_DISTRO`` <#var-INHERIT_DISTRO>`__ variable's default value.
+:term:`INHERIT_DISTRO` variable's default value.
For more information on sstate, see the "`Shared State
Cache <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__" section in the Yocto
@@ -2351,15 +2351,15 @@ Project Overview and Concepts Manual.
The ``staging`` class installs files into individual recipe work
directories for sysroots. The class contains the following key tasks:
-- The ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task,
+- The :ref:`ref-tasks-populate_sysroot` task,
which is responsible for handing the files that end up in the recipe
sysroots.
- The
- ```do_prepare_recipe_sysroot`` <#ref-tasks-prepare_recipe_sysroot>`__
+ :ref:`ref-tasks-prepare_recipe_sysroot`
task (a "partner" task to the ``populate_sysroot`` task), which
installs the files into the individual recipe work directories (i.e.
- ```WORKDIR`` <#var-WORKDIR>`__).
+ :term:`WORKDIR`).
The code in the ``staging`` class is complex and basically works in two
stages:
@@ -2367,13 +2367,13 @@ stages:
- *Stage One:* The first stage addresses recipes that have files they
want to share with other recipes that have dependencies on the
originating recipe. Normally these dependencies are installed through
- the ```do_install`` <#ref-tasks-install>`__ task into
- ``${``\ ```D`` <#var-D>`__\ ``}``. The ``do_populate_sysroot`` task
+ the :ref:`ref-tasks-install` task into
+ ``${``\ :term:`D`\ ``}``. The ``do_populate_sysroot`` task
copies a subset of these files into ``${SYSROOT_DESTDIR}``. This
subset of files is controlled by the
- ```SYSROOT_DIRS`` <#var-SYSROOT_DIRS>`__,
- ```SYSROOT_DIRS_NATIVE`` <#var-SYSROOT_DIRS_NATIVE>`__, and
- ```SYSROOT_DIRS_BLACKLIST`` <#var-SYSROOT_DIRS_BLACKLIST>`__
+ :term:`SYSROOT_DIRS`,
+ :term:`SYSROOT_DIRS_NATIVE`, and
+ :term:`SYSROOT_DIRS_BLACKLIST`
variables.
.. note::
@@ -2391,17 +2391,17 @@ stages:
hardcoded locations are replaced by tokens and a list of the files
needing such replacements is created. These adjustments are referred
to as "FIXMEs". The list of files that are scanned for paths is
- controlled by the ```SSTATE_SCAN_FILES`` <#var-SSTATE_SCAN_FILES>`__
+ controlled by the :term:`SSTATE_SCAN_FILES`
variable.
- *Stage Two:* The second stage addresses recipes that want to use
something from another recipe and declare a dependency on that recipe
- through the ```DEPENDS`` <#var-DEPENDS>`__ variable. The recipe will
+ through the :term:`DEPENDS` variable. The recipe will
have a
- ```do_prepare_recipe_sysroot`` <#ref-tasks-prepare_recipe_sysroot>`__
+ :ref:`ref-tasks-prepare_recipe_sysroot`
task and when this task executes, it creates the ``recipe-sysroot``
and ``recipe-sysroot-native`` in the recipe work directory (i.e.
- ```WORKDIR`` <#var-WORKDIR>`__). The OpenEmbedded build system
+ :term:`WORKDIR`). The OpenEmbedded build system
creates hard links to copies of the relevant files from
``sysroots-components`` into the recipe work directory.
@@ -2437,7 +2437,7 @@ stages:
is used so that builds should be identical regardless of whether
sstate was used or not. For a closer look, see the
``setscene_depvalid()`` function in the
- ```sstate`` <#ref-classes-sstate>`__ class.
+ :ref:`sstate ` class.
The build system is careful to maintain manifests of the files it
installs so that any given dependency can be installed as needed. The
@@ -2454,37 +2454,37 @@ bootable images.
The class supports the following variables:
-- ```INITRD`` <#var-INITRD>`__: Indicates list of filesystem images to
+- :term:`INITRD`: Indicates list of filesystem images to
concatenate and use as an initial RAM disk (initrd). This variable is
optional.
-- ```ROOTFS`` <#var-ROOTFS>`__: Indicates a filesystem image to include
+- :term:`ROOTFS`: Indicates a filesystem image to include
as the root filesystem. This variable is optional.
-- ```AUTO_SYSLINUXMENU`` <#var-AUTO_SYSLINUXMENU>`__: Enables creating
+- :term:`AUTO_SYSLINUXMENU`: Enables creating
an automatic menu when set to "1".
-- ```LABELS`` <#var-LABELS>`__: Lists targets for automatic
+- :term:`LABELS`: Lists targets for automatic
configuration.
-- ```APPEND`` <#var-APPEND>`__: Lists append string overrides for each
+- :term:`APPEND`: Lists append string overrides for each
label.
-- ```SYSLINUX_OPTS`` <#var-SYSLINUX_OPTS>`__: Lists additional options
+- :term:`SYSLINUX_OPTS`: Lists additional options
to add to the syslinux file. Semicolon characters separate multiple
options.
-- ```SYSLINUX_SPLASH`` <#var-SYSLINUX_SPLASH>`__: Lists a background
+- :term:`SYSLINUX_SPLASH`: Lists a background
for the VGA boot menu when you are using the boot menu.
-- ```SYSLINUX_DEFAULT_CONSOLE`` <#var-SYSLINUX_DEFAULT_CONSOLE>`__: Set
+- :term:`SYSLINUX_DEFAULT_CONSOLE`: Set
to "console=ttyX" to change kernel boot default console.
-- ```SYSLINUX_SERIAL`` <#var-SYSLINUX_SERIAL>`__: Sets an alternate
+- :term:`SYSLINUX_SERIAL`: Sets an alternate
serial port. Or, turns off serial when the variable is set with an
empty string.
-- ```SYSLINUX_SERIAL_TTY`` <#var-SYSLINUX_SERIAL_TTY>`__: Sets an
+- :term:`SYSLINUX_SERIAL_TTY`: Sets an
alternate "console=tty..." kernel boot argument.
.. _ref-classes-systemd:
@@ -2496,24 +2496,24 @@ The ``systemd`` class provides support for recipes that install systemd
unit files.
The functionality for this class is disabled unless you have "systemd"
-in ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__.
+in :term:`DISTRO_FEATURES`.
Under this class, the recipe or Makefile (i.e. whatever the recipe is
-calling during the ```do_install`` <#ref-tasks-install>`__ task)
+calling during the :ref:`ref-tasks-install` task)
installs unit files into
-``${``\ ```D`` <#var-D>`__\ ``}${systemd_unitdir}/system``. If the unit
+``${``\ :term:`D`\ ``}${systemd_unitdir}/system``. If the unit
files being installed go into packages other than the main package, you
-need to set ```SYSTEMD_PACKAGES`` <#var-SYSTEMD_PACKAGES>`__ in your
+need to set :term:`SYSTEMD_PACKAGES` in your
recipe to identify the packages in which the files will be installed.
-You should set ```SYSTEMD_SERVICE`` <#var-SYSTEMD_SERVICE>`__ to the
+You should set :term:`SYSTEMD_SERVICE` to the
name of the service file. You should also use a package name override to
indicate the package to which the value applies. If the value applies to
-the recipe's main package, use ``${``\ ```PN`` <#var-PN>`__\ ``}``. Here
+the recipe's main package, use ``${``\ :term:`PN`\ ``}``. Here
is an example from the connman recipe: SYSTEMD_SERVICE_${PN} =
"connman.service" Services are set up to start on boot automatically
unless you have set
-```SYSTEMD_AUTO_ENABLE`` <#var-SYSTEMD_AUTO_ENABLE>`__ to "disable".
+:term:`SYSTEMD_AUTO_ENABLE` to "disable".
For more information on ``systemd``, see the "`Selecting an
Initialization
@@ -2539,14 +2539,14 @@ internal class and is not intended to be used directly.
systemd
project.
-Set the ```EFI_PROVIDER`` <#var-EFI_PROVIDER>`__ variable to
+Set the :term:`EFI_PROVIDER` variable to
"systemd-boot" to use this class. Doing so creates a standalone EFI
bootloader that is not dependent on systemd.
For information on more variables used and supported in this class, see
-the ```SYSTEMD_BOOT_CFG`` <#var-SYSTEMD_BOOT_CFG>`__,
-```SYSTEMD_BOOT_ENTRIES`` <#var-SYSTEMD_BOOT_ENTRIES>`__, and
-```SYSTEMD_BOOT_TIMEOUT`` <#var-SYSTEMD_BOOT_TIMEOUT>`__ variables.
+the :term:`SYSTEMD_BOOT_CFG`,
+:term:`SYSTEMD_BOOT_ENTRIES`, and
+:term:`SYSTEMD_BOOT_TIMEOUT` variables.
You can also see the `Systemd-boot
documentation `__
@@ -2558,15 +2558,15 @@ for more information.
====================
The ``terminal`` class provides support for starting a terminal session.
-The ```OE_TERMINAL`` <#var-OE_TERMINAL>`__ variable controls which
+The :term:`OE_TERMINAL` variable controls which
terminal emulator is used for the session.
Other classes use the ``terminal`` class anywhere a separate terminal
session needs to be started. For example, the
-```patch`` <#ref-classes-patch>`__ class assuming
-```PATCHRESOLVE`` <#var-PATCHRESOLVE>`__ is set to "user", the
+:ref:`patch ` class assuming
+:term:`PATCHRESOLVE` is set to "user", the
```cml1`` <#ref-classes-cml1>`__ class, and the
-```devshell`` <#ref-classes-devshell>`__ class all use the ``terminal``
+:ref:`devshell ` class all use the ``terminal``
class.
.. _ref-classes-testimage*:
@@ -2595,7 +2595,7 @@ test is written in Python and makes use of the ``unittest`` module.
The ``testimage.bbclass`` runs tests on an image when called using the
following: $ bitbake -c testimage image The ``testimage-auto`` class
runs tests on an image after the image is constructed (i.e.
-```TESTIMAGE_AUTO`` <#var-TESTIMAGE_AUTO>`__ must be set to "1").
+:term:`TESTIMAGE_AUTO` must be set to "1").
For information on how to enable, run, and create new tests, see the
"`Performing Automated Runtime
@@ -2693,8 +2693,8 @@ The ``uboot-config`` class provides support for U-Boot configuration for
a machine. Specify the machine in your recipe as follows: UBOOT_CONFIG
??= UBOOT_CONFIG[foo] = "config,images" You can also specify
the machine using this method: UBOOT_MACHINE = "config" See the
-```UBOOT_CONFIG`` <#var-UBOOT_CONFIG>`__ and
-```UBOOT_MACHINE`` <#var-UBOOT_MACHINE>`__ variables for additional
+:term:`UBOOT_CONFIG` and
+:term:`UBOOT_MACHINE` variables for additional
information.
.. _ref-classes-uninative:
@@ -2738,13 +2738,13 @@ packages.
To use this class, you need to define a number of variables:
-- ```ALTERNATIVE`` <#var-ALTERNATIVE>`__
+- :term:`ALTERNATIVE`
-- ```ALTERNATIVE_LINK_NAME`` <#var-ALTERNATIVE_LINK_NAME>`__
+- :term:`ALTERNATIVE_LINK_NAME`
-- ```ALTERNATIVE_TARGET`` <#var-ALTERNATIVE_TARGET>`__
+- :term:`ALTERNATIVE_TARGET`
-- ```ALTERNATIVE_PRIORITY`` <#var-ALTERNATIVE_PRIORITY>`__
+- :term:`ALTERNATIVE_PRIORITY`
These variables list alternative commands needed by a package, provide
pathnames for links, default links for targets, and so forth. For
@@ -2783,7 +2783,7 @@ usage by the package on the target. For example, if you have packages
that contain system services that should be run under their own user or
group, you can use these classes to enable creation of the user or
group. The ``meta-skeleton/recipes-skeleton/useradd/useradd-example.bb``
-recipe in the `Source Directory <#source-directory>`__ provides a simple
+recipe in the :term:`Source Directory` provides a simple
example that shows how to add three users and groups to two packages.
See the ``useradd-example.bb`` recipe for more information on how to use
these classes.
@@ -2792,10 +2792,10 @@ The ``useradd_base`` class provides basic functionality for user or
groups settings.
The ``useradd*`` classes support the
-```USERADD_PACKAGES`` <#var-USERADD_PACKAGES>`__,
-```USERADD_PARAM`` <#var-USERADD_PARAM>`__,
-```GROUPADD_PARAM`` <#var-GROUPADD_PARAM>`__, and
-```GROUPMEMS_PARAM`` <#var-GROUPMEMS_PARAM>`__ variables.
+:term:`USERADD_PACKAGES`,
+:term:`USERADD_PARAM`,
+:term:`GROUPADD_PARAM`, and
+:term:`GROUPMEMS_PARAM` variables.
The ``useradd-staticids`` class supports the addition of users or groups
that have static user identification (``uid``) and group identification
@@ -2810,15 +2810,15 @@ the final ``uid`` and ``gid`` values. However, if non-deterministic
``uid`` and ``gid`` values are a problem, you can override the default,
dynamic application of these values by setting static values. When you
set static values, the OpenEmbedded build system looks in
-```BBPATH`` <#var-BBPATH>`__ for ``files/passwd`` and ``files/group``
+:term:`BBPATH` for ``files/passwd`` and ``files/group``
files for the values.
To use static ``uid`` and ``gid`` values, you need to set some
-variables. See the ```USERADDEXTENSION`` <#var-USERADDEXTENSION>`__,
-```USERADD_UID_TABLES`` <#var-USERADD_UID_TABLES>`__,
-```USERADD_GID_TABLES`` <#var-USERADD_GID_TABLES>`__, and
-```USERADD_ERROR_DYNAMIC`` <#var-USERADD_ERROR_DYNAMIC>`__ variables.
-You can also see the ```useradd`` <#ref-classes-useradd>`__ class for
+variables. See the :term:`USERADDEXTENSION`,
+:term:`USERADD_UID_TABLES`,
+:term:`USERADD_GID_TABLES`, and
+:term:`USERADD_ERROR_DYNAMIC` variables.
+You can also see the :ref:`useradd ` class for
additional information.
.. note::
@@ -2844,11 +2844,11 @@ additional information.
The ``utility-tasks`` class provides support for various "utility" type
tasks that are applicable to all recipes, such as
-```do_clean`` <#ref-tasks-clean>`__ and
-```do_listtasks`` <#ref-tasks-listtasks>`__.
+:ref:`ref-tasks-clean` and
+:ref:`ref-tasks-listtasks`.
This class is enabled by default because it is inherited by the
-```base`` <#ref-classes-base>`__ class.
+:ref:`base ` class.
.. _ref-classes-utils:
@@ -2860,7 +2860,7 @@ typically used in inline Python expressions (e.g. ``${@...}``). One
example use is for ``bb.utils.contains()``.
This class is enabled by default because it is inherited by the
-```base`` <#ref-classes-base>`__ class.
+:ref:`base ` class.
.. _ref-classes-vala:
@@ -2877,7 +2877,7 @@ using the Vala programming language.
The ``waf`` class supports recipes that need to build software that uses
the Waf build system. You can use the
-```EXTRA_OECONF`` <#var-EXTRA_OECONF>`__ or
-```PACKAGECONFIG_CONFARGS`` <#var-PACKAGECONFIG_CONFARGS>`__ variables
+:term:`EXTRA_OECONF` or
+:term:`PACKAGECONFIG_CONFARGS` variables
to specify additional configuration options to be passed on the Waf
command line.
diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst
index 5bb1a64d99..b0c4bcc7a0 100644
--- a/documentation/ref-manual/ref-devtool-reference.rst
+++ b/documentation/ref-manual/ref-devtool-reference.rst
@@ -217,7 +217,7 @@ Git, checks out a branch for development, and applies any patches from
the recipe as commits on top. You can use the following command to
checkout the source files: $ devtool modify recipe Using the above
command form, ``devtool`` uses the existing recipe's
-```SRC_URI`` <#var-SRC_URI>`__ statement to locate the upstream source,
+:term:`SRC_URI` statement to locate the upstream source,
extracts the source into the default sources location in the workspace.
The default development branch used is "devtool".
@@ -360,9 +360,9 @@ When you use the ``devtool upgrade`` command, you must supply the root
name of the recipe (i.e. no version, paths, or extensions), and you must
supply the directory to which you want the source extracted. Additional
command options let you control things such as the version number to
-which you want to upgrade (i.e. the ```PV`` <#var-PV>`__), the source
+which you want to upgrade (i.e. the :term:`PV`), the source
revision to which you want to upgrade (i.e. the
-```SRCREV`` <#var-SRCREV>`__), whether or not to apply patches, and so
+:term:`SRCREV`), whether or not to apply patches, and so
forth.
You can read more on the ``devtool upgrade`` workflow in the "`Use
@@ -439,7 +439,7 @@ The target is the address of the target machine, which must be running
an SSH server (i.e. ``user@hostname[:destdir]``).
This command deploys all files installed during the
-```do_install`` <#ref-tasks-install>`__ task. Furthermore, you do not
+:ref:`ref-tasks-install` task. Furthermore, you do not
need to have package management enabled within the target machine. If
you do, the package manager is bypassed.
@@ -492,7 +492,7 @@ Creating the Workspace Layer in an Alternative Location
=======================================================
Use the ``devtool create-workspace`` command to create a new workspace
-layer in your `Build Directory <#build-directory>`__. When you create a
+layer in your :term:`Build Directory`. When you create a
new workspace layer, it is populated with the ``README`` file and the
``conf`` directory only.
diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst
index 1aa57a27d4..0e901edaeb 100644
--- a/documentation/ref-manual/ref-features.rst
+++ b/documentation/ref-manual/ref-features.rst
@@ -24,7 +24,7 @@ included if the distribution itself does not support them.
One method you can use to determine which recipes are checking to see if
a particular feature is contained or not is to ``grep`` through the
-`Metadata <#metadata>`__ for the feature. Here is an example that
+:term:`Metadata` for the feature. Here is an example that
discovers the recipes whose build is potentially changed based on a
given feature: $ cd poky $ git grep
'contains.*MACHINE_FEATURES.*feature'
@@ -35,12 +35,12 @@ Machine Features
================
The items below are features you can use with
-```MACHINE_FEATURES`` <#var-MACHINE_FEATURES>`__. Features do not have a
+:term:`MACHINE_FEATURES`. Features do not have a
one-to-one correspondence to packages, and they can go beyond simply
controlling the installation of a package or packages. Sometimes a
feature can influence how certain recipes are built. For example, a
feature might determine whether a particular configure option is
-specified within the ```do_configure`` <#ref-tasks-configure>`__ task
+specified within the :ref:`ref-tasks-configure` task
for a particular recipe.
This feature list only represents features as shipped with the Yocto
@@ -92,18 +92,18 @@ Distro Features
===============
The items below are features you can use with
-```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ to enable features across
+:term:`DISTRO_FEATURES` to enable features across
your distribution. Features do not have a one-to-one correspondence to
packages, and they can go beyond simply controlling the installation of
a package or packages. In most cases, the presence or absence of a
feature translates to the appropriate option supplied to the configure
-script during the ```do_configure`` <#ref-tasks-configure>`__ task for
+script during the :ref:`ref-tasks-configure` task for
the recipes that optionally support the feature.
Some distro features are also machine features. These select features
make sense to be controlled both at the machine and distribution
configuration level. See the
-```COMBINED_FEATURES`` <#var-COMBINED_FEATURES>`__ variable for more
+:term:`COMBINED_FEATURES` variable for more
information.
This list only represents features as shipped with the Yocto Project
@@ -189,8 +189,8 @@ Image Features
==============
The contents of images generated by the OpenEmbedded build system can be
-controlled by the ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ and
-```EXTRA_IMAGE_FEATURES`` <#var-EXTRA_IMAGE_FEATURES>`__ variables that
+controlled by the :term:`IMAGE_FEATURES` and
+:term:`EXTRA_IMAGE_FEATURES` variables that
you typically configure in your image recipes. Through these variables,
you can add several different predefined packages such as development
utilities or packages with debug information needed to investigate
@@ -254,7 +254,7 @@ The following image features are available for all images:
a given image.
Some image features are available only when you inherit the
-```core-image`` <#ref-classes-core-image>`__ class. The current list of
+:ref:`core-image ` class. The current list of
these valid features is as follows:
- *hwcodecs:* Installs hardware acceleration codecs.
@@ -299,8 +299,8 @@ Feature Backfilling
===================
Sometimes it is necessary in the OpenEmbedded build system to extend
-```MACHINE_FEATURES`` <#var-MACHINE_FEATURES>`__ or
-```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ to control functionality
+:term:`MACHINE_FEATURES` or
+:term:`DISTRO_FEATURES` to control functionality
that was previously enabled and not able to be disabled. For these
cases, we need to add an additional feature item to appear in one of
these variables, but we do not want to force developers who have
@@ -310,8 +310,8 @@ Thus, the OpenEmbedded build system has a mechanism to automatically
"backfill" these added features into existing distro or machine
configurations. You can see the list of features for which this is done
by finding the
-```DISTRO_FEATURES_BACKFILL`` <#var-DISTRO_FEATURES_BACKFILL>`__ and
-```MACHINE_FEATURES_BACKFILL`` <#var-MACHINE_FEATURES_BACKFILL>`__
+:term:`DISTRO_FEATURES_BACKFILL` and
+:term:`MACHINE_FEATURES_BACKFILL`
variables in the ``meta/conf/bitbake.conf`` file.
Because such features are backfilled by default into all configurations
@@ -319,9 +319,9 @@ as described in the previous paragraph, developers who wish to disable
the new features need to be able to selectively prevent the backfilling
from occurring. They can do this by adding the undesired feature or
features to the
-```DISTRO_FEATURES_BACKFILL_CONSIDERED`` <#var-DISTRO_FEATURES_BACKFILL_CONSIDERED>`__
+:term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
or
-```MACHINE_FEATURES_BACKFILL_CONSIDERED`` <#var-MACHINE_FEATURES_BACKFILL_CONSIDERED>`__
+:term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`
variables for distro features and machine features respectively.
Here are two examples to help illustrate feature backfilling:
diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/ref-images.rst
index f0f8398338..5aeaa43833 100644
--- a/documentation/ref-manual/ref-images.rst
+++ b/documentation/ref-manual/ref-images.rst
@@ -86,7 +86,7 @@ Following is a list of supported recipes:
has the Minimal RAM-based Initial Root Filesystem (initramfs) as part
of the kernel, which allows the system to find the first “init”
program more efficiently. See the
- ```PACKAGE_INSTALL`` <#var-PACKAGE_INSTALL>`__ variable for
+ :term:`PACKAGE_INSTALL` variable for
additional information helpful when working with initramfs images.
- ``core-image-minimal-mtdutils``: A ``core-image-minimal`` image that
diff --git a/documentation/ref-manual/ref-kickstart.rst b/documentation/ref-manual/ref-kickstart.rst
index 599e38080c..5f8c834f33 100644
--- a/documentation/ref-manual/ref-kickstart.rst
+++ b/documentation/ref-manual/ref-kickstart.rst
@@ -167,7 +167,7 @@ the ``part`` and ``partition`` commands:
- *``--fsuuid``:* This option is a Wic-specific option that specifies
the filesystem UUID. You can generate or modify
- ```WKS_FILE`` <#var-WKS_FILE>`__ with this option if a preconfigured
+ :term:`WKS_FILE` with this option if a preconfigured
filesystem UUID is added to the kernel command line in the bootloader
configuration before you run Wic.
diff --git a/documentation/ref-manual/ref-qa-checks.rst b/documentation/ref-manual/ref-qa-checks.rst
index e83fad8e10..d60c0616f0 100644
--- a/documentation/ref-manual/ref-qa-checks.rst
+++ b/documentation/ref-manual/ref-qa-checks.rst
@@ -28,7 +28,7 @@ error form along with an explanation.
.. note::
- At the end of each message, the name of the associated QA test (as
- listed in the "```insane.bbclass`` <#ref-classes-insane>`__"
+ listed in the ":ref:`insane.bbclass `"
section) appears within square brackets.
- As mentioned, this list of error and warning messages is for QA
@@ -56,10 +56,10 @@ Errors and Warnings
The specified binary produced by the recipe contains dynamic library
load paths (rpaths) that contain build system paths such as
- ```TMPDIR`` <#var-TMPDIR>`__, which are incorrect for the target and
+ :term:`TMPDIR`, which are incorrect for the target and
could potentially be a security issue. Check for bad ``-rpath``
options being passed to the linker in your
- ```do_compile`` <#ref-tasks-compile>`__ log. Depending on the build
+ :ref:`ref-tasks-compile` log. Depending on the build
system used by the software being built, there might be a configure
option to disable rpath usage completely within the build of the
software.
@@ -82,7 +82,7 @@ Errors and Warnings
A file-level dependency has been identified from the specified
package on the specified files, but there is no explicit
- corresponding entry in ```RDEPENDS`` <#var-RDEPENDS>`__. If
+ corresponding entry in :term:`RDEPENDS`. If
particular files are required at runtime then ``RDEPENDS`` should be
declared in the recipe to ensure the packages providing them are
built.
@@ -95,7 +95,7 @@ Errors and Warnings
there is nothing explicit within the recipe to enable the
OpenEmbedded build system to ensure that dependency is satisfied.
This condition is usually triggered by an
- ```RDEPENDS`` <#var-RDEPENDS>`__ value being added at the packaging
+ :term:`RDEPENDS` value being added at the packaging
stage rather than up front, which is usually automatic based on the
contents of the package. In most cases, you should change the recipe
to add an explicit ``RDEPENDS`` for the dependency.
@@ -107,8 +107,8 @@ Errors and Warnings
Symlink ``.so`` files are for development only, and should therefore
go into the ``-dev`` package. This situation might occur if you add
``*.so*`` rather than ``*.so.*`` to a non-dev package. Change
- ```FILES`` <#var-FILES>`__ (and possibly
- ```PACKAGES`` <#var-PACKAGES>`__) such that the specified ``.so``
+ :term:`FILES` (and possibly
+ :term:`PACKAGES`) such that the specified ``.so``
file goes into an appropriate ``-dev`` package.
@@ -116,8 +116,8 @@ Errors and Warnings
- ``non -staticdev package contains static .a library: path '' [staticdev]``
Static ``.a`` library files should go into a ``-staticdev`` package.
- Change ```FILES`` <#var-FILES>`__ (and possibly
- ```PACKAGES`` <#var-PACKAGES>`__) such that the specified ``.a`` file
+ Change :term:`FILES` (and possibly
+ :term:`PACKAGES`) such that the specified ``.a`` file
goes into an appropriate ``-staticdev`` package.
@@ -130,7 +130,7 @@ Errors and Warnings
"lib32". Another example is when recipes install
``/usr/lib64/foo.so`` when ``${libdir}`` is "/usr/lib". False
positives occasionally exist. For these cases add "libdir" to
- ```INSANE_SKIP`` <#var-INSANE_SKIP>`__ for the package.
+ :term:`INSANE_SKIP` for the package.
@@ -141,7 +141,7 @@ Errors and Warnings
occur if you add a path which contains a ``.debug`` directory and do
not explicitly add the ``.debug`` directory to the ``-dbg`` package.
If this is the case, add the ``.debug`` directory explicitly to
- ``FILES_${PN}-dbg``. See ```FILES`` <#var-FILES>`__ for additional
+ ``FILES_${PN}-dbg``. See :term:`FILES` for additional
information on ``FILES``.
@@ -158,8 +158,8 @@ Errors and Warnings
the error for is firmware that is not intended to be executed within
the target operating system or is intended to run on a separate
processor within the device, you can add "arch" to
- ```INSANE_SKIP`` <#var-INSANE_SKIP>`__ for the package. Another
- option is to check the ```do_compile`` <#ref-tasks-compile>`__ log
+ :term:`INSANE_SKIP` for the package. Another
+ option is to check the :ref:`ref-tasks-compile` log
and verify that the compiler options being used are correct.
@@ -176,8 +176,8 @@ Errors and Warnings
the error for is firmware that is not intended to be executed within
the target operating system or is intended to run on a separate
processor within the device, you can add "arch" to
- ```INSANE_SKIP`` <#var-INSANE_SKIP>`__ for the package. Another
- option is to check the ```do_compile`` <#ref-tasks-compile>`__ log
+ :term:`INSANE_SKIP` for the package. Another
+ option is to check the :ref:`ref-tasks-compile` log
and verify that the compiler options being used are correct.
@@ -194,8 +194,8 @@ Errors and Warnings
the error for is firmware that is not intended to be executed within
the target operating system or is intended to run on a separate
processor within the device, you can add "arch" to
- ```INSANE_SKIP`` <#var-INSANE_SKIP>`__ for the package. Another
- option is to check the ```do_compile`` <#ref-tasks-compile>`__ log
+ :term:`INSANE_SKIP` for the package. Another
+ option is to check the :ref:`ref-tasks-compile` log
and verify that the compiler options being used are correct.
@@ -208,7 +208,7 @@ Errors and Warnings
Typically, the way to solve this performance issue is to add "-fPIC"
or "-fpic" to the compiler command-line options. For example, given
- software that reads ```CFLAGS`` <#var-CFLAGS>`__ when you build it,
+ software that reads :term:`CFLAGS` when you build it,
you could add the following to your recipe: CFLAGS_append = " -fPIC "
For more information on text relocations at runtime, see
@@ -219,11 +219,11 @@ Errors and Warnings
- ``No GNU_HASH in the elf binary: '' [ldflags]``
This indicates that binaries produced when building the recipe have
- not been linked with the ```LDFLAGS`` <#var-LDFLAGS>`__ options
+ not been linked with the :term:`LDFLAGS` options
provided by the build system. Check to be sure that the ``LDFLAGS``
variable is being passed to the linker command. A common workaround
for this situation is to pass in ``LDFLAGS`` using
- ```TARGET_CC_ARCH`` <#var-TARGET_CC_ARCH>`__ within the recipe as
+ :term:`TARGET_CC_ARCH` within the recipe as
follows: TARGET_CC_ARCH += "${LDFLAGS}"
@@ -243,7 +243,7 @@ Errors and Warnings
- ``The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir]``
The ``/usr/share/info/dir`` should not be packaged. Add the following
- line to your ```do_install`` <#ref-tasks-install>`__ task or to your
+ line to your :ref:`ref-tasks-install` task or to your
``do_install_append`` within the recipe as follows: rm
${D}${infodir}/dir
@@ -251,7 +251,7 @@ Errors and Warnings
- ``Symlink in points to TMPDIR [symlink-to-sysroot]``
- The specified symlink points into ```TMPDIR`` <#var-TMPDIR>`__ on the
+ The specified symlink points into :term:`TMPDIR` on the
host. Such symlinks will work on the host. However, they are clearly
invalid when running on the target. You should either correct the
symlink to use a relative path or remove the symlink.
@@ -260,7 +260,7 @@ Errors and Warnings
- `` failed sanity test (workdir) in path [la]``
- The specified ``.la`` file contains ```TMPDIR`` <#var-TMPDIR>`__
+ The specified ``.la`` file contains :term:`TMPDIR`
paths. Any ``.la`` file containing these paths is incorrect since
``libtool`` adds the correct sysroot prefix when using the files
automatically itself.
@@ -270,7 +270,7 @@ Errors and Warnings
- `` failed sanity test (tmpdir) in path [pkgconfig]``
The specified ``.pc`` file contains
- ```TMPDIR`` <#var-TMPDIR>`__\ ``/``\ ```WORKDIR`` <#var-WORKDIR>`__
+ :term:`TMPDIR`\ ``/``\ :term:`WORKDIR`
paths. Any ``.pc`` file containing these paths is incorrect since
``pkg-config`` itself adds the correct sysroot prefix when the files
are accessed.
@@ -285,9 +285,9 @@ Errors and Warnings
brought in using several different methods:
- Using the ``dbg-pkgs``
- ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ value.
+ :term:`IMAGE_FEATURES` value.
- - Using ```IMAGE_INSTALL`` <#var-IMAGE_INSTALL>`__.
+ - Using :term:`IMAGE_INSTALL`.
- As a dependency of another ``dbg`` package that was brought in
using one of the above methods.
@@ -295,7 +295,7 @@ Errors and Warnings
The dependency might have been automatically added because the
``dbg`` package erroneously contains files that it should not contain
(e.g. a non-symlink ``.so`` file) or it might have been added
- manually (e.g. by adding to ```RDEPENDS`` <#var-RDEPENDS>`__).
+ manually (e.g. by adding to :term:`RDEPENDS`).
@@ -307,9 +307,9 @@ Errors and Warnings
usually brought in using several different methods:
- Using the ``dev-pkgs``
- ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ value.
+ :term:`IMAGE_FEATURES` value.
- - Using ```IMAGE_INSTALL`` <#var-IMAGE_INSTALL>`__.
+ - Using :term:`IMAGE_INSTALL`.
- As a dependency of another ``dev`` package that was brought in
using one of the above methods.
@@ -317,19 +317,19 @@ Errors and Warnings
The dependency might have been automatically added (because the
``dev`` package erroneously contains files that it should not have
(e.g. a non-symlink ``.so`` file) or it might have been added
- manually (e.g. by adding to ```RDEPENDS`` <#var-RDEPENDS>`__).
+ manually (e.g. by adding to :term:`RDEPENDS`).
- ``_ is invalid: () only comparisons <, =, >, <=, and >= are allowed [dep-cmp]``
If you are adding a versioned dependency relationship to one of the
- dependency variables (```RDEPENDS`` <#var-RDEPENDS>`__,
- ```RRECOMMENDS`` <#var-RRECOMMENDS>`__,
- ```RSUGGESTS`` <#var-RSUGGESTS>`__,
- ```RPROVIDES`` <#var-RPROVIDES>`__,
- ```RREPLACES`` <#var-RREPLACES>`__, or
- ```RCONFLICTS`` <#var-RCONFLICTS>`__), you must only use the named
+ dependency variables (:term:`RDEPENDS`,
+ :term:`RRECOMMENDS`,
+ :term:`RSUGGESTS`,
+ :term:`RPROVIDES`,
+ :term:`RREPLACES`, or
+ :term:`RCONFLICTS`), you must only use the named
comparison operators. Change the versioned dependency values you are
adding to match those listed in the message.
@@ -337,7 +337,7 @@ Errors and Warnings
- ``: The compile log indicates that host include and/or library paths were used. Please check the log '' for more information. [compile-host-path]``
- The log for the ```do_compile`` <#ref-tasks-compile>`__ task
+ The log for the :ref:`ref-tasks-compile` task
indicates that paths on the host were searched for files, which is
not appropriate when cross-compiling. Look for "is unsafe for
cross-compilation" or "CROSS COMPILE Badness" in the specified log
@@ -347,7 +347,7 @@ Errors and Warnings
- ``: The install log indicates that host include and/or library paths were used. Please check the log '' for more information. [install-host-path]``
- The log for the ```do_install`` <#ref-tasks-install>`__ task
+ The log for the :ref:`ref-tasks-install` task
indicates that paths on the host were searched for files, which is
not appropriate when cross-compiling. Look for "is unsafe for
cross-compilation" or "CROSS COMPILE Badness" in the specified log
@@ -357,7 +357,7 @@ Errors and Warnings
- ``This autoconf log indicates errors, it looked at host include and/or library paths while determining system capabilities. Rerun configure task after fixing this. The path was ''``
- The log for the ```do_configure`` <#ref-tasks-configure>`__ task
+ The log for the :ref:`ref-tasks-configure` task
indicates that paths on the host were searched for files, which is
not appropriate when cross-compiling. Look for "is unsafe for
cross-compilation" or "CROSS COMPILE Badness" in the specified log
@@ -371,7 +371,7 @@ Errors and Warnings
enforced by the package manager itself) is to require that package
names are all lower case and to allow a restricted set of characters.
If your recipe name does not match this, or you add packages to
- ```PACKAGES`` <#var-PACKAGES>`__ that do not conform to the
+ :term:`PACKAGES` that do not conform to the
convention, then you will receive this error. Rename your recipe. Or,
if you have added a non-conforming package name to ``PACKAGES``,
change the package name appropriately.
@@ -388,38 +388,38 @@ Errors and Warnings
upstream build documentation, the ``./configure --help`` output, and
the upstream change log or release notes. Once you have worked out
what the appropriate change is, you can update
- ```EXTRA_OECONF`` <#var-EXTRA_OECONF>`__,
- ```PACKAGECONFIG_CONFARGS`` <#var-PACKAGECONFIG_CONFARGS>`__, or the
- individual ```PACKAGECONFIG`` <#var-PACKAGECONFIG>`__ option values
+ :term:`EXTRA_OECONF`,
+ :term:`PACKAGECONFIG_CONFARGS`, or the
+ individual :term:`PACKAGECONFIG` option values
accordingly.
- ``Recipe has PN of "" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides]``
- The specified recipe has a name (```PN`` <#var-PN>`__) value that
- appears in ```OVERRIDES`` <#var-OVERRIDES>`__. If a recipe is named
+ The specified recipe has a name (:term:`PN`) value that
+ appears in :term:`OVERRIDES`. If a recipe is named
such that its ``PN`` value matches something already in ``OVERRIDES``
- (e.g. ``PN`` happens to be the same as ```MACHINE`` <#var-MACHINE>`__
- or ```DISTRO`` <#var-DISTRO>`__), it can have unexpected
+ (e.g. ``PN`` happens to be the same as :term:`MACHINE`
+ or :term:`DISTRO`), it can have unexpected
consequences. For example, assignments such as
``FILES_${PN} = "xyz"`` effectively turn into ``FILES = "xyz"``.
Rename your recipe (or if ``PN`` is being set explicitly, change the
``PN`` value) so that the conflict does not occur. See
- ```FILES`` <#var-FILES>`__ for additional information.
+ :term:`FILES` for additional information.
- ``: Variable is set as not being package specific, please fix this. [pkgvarcheck]``
- Certain variables (```RDEPENDS`` <#var-RDEPENDS>`__,
- ```RRECOMMENDS`` <#var-RRECOMMENDS>`__,
- ```RSUGGESTS`` <#var-RSUGGESTS>`__,
- ```RCONFLICTS`` <#var-RCONFLICTS>`__,
- ```RPROVIDES`` <#var-RPROVIDES>`__,
- ```RREPLACES`` <#var-RREPLACES>`__, ```FILES`` <#var-FILES>`__,
+ Certain variables (:term:`RDEPENDS`,
+ :term:`RRECOMMENDS`,
+ :term:`RSUGGESTS`,
+ :term:`RCONFLICTS`,
+ :term:`RPROVIDES`,
+ :term:`RREPLACES`, :term:`FILES`,
``pkg_preinst``, ``pkg_postinst``, ``pkg_prerm``, ``pkg_postrm``, and
- ```ALLOW_EMPTY`` <#var-ALLOW_EMPTY>`__) should always be set specific
+ :term:`ALLOW_EMPTY`) should always be set specific
to a package (i.e. they should be set with a package name override
such as ``RDEPENDS_${PN} = "value"`` rather than
``RDEPENDS = "value"``). If you receive this error, correct any
@@ -456,7 +456,7 @@ Errors and Warnings
- `` is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list]``
Package names must appear only once in the
- ```PACKAGES`` <#var-PACKAGES>`__ variable. You might receive this
+ :term:`PACKAGES` variable. You might receive this
error if you are attempting to add a package to ``PACKAGES`` that is
already in the variable's value.
@@ -465,7 +465,7 @@ Errors and Warnings
- ``FILES variable for package contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid]``
The string "//" is invalid in a Unix path. Correct all occurrences
- where this string appears in a ```FILES`` <#var-FILES>`__ variable so
+ where this string appears in a :term:`FILES` variable so
that there is only a single "/".
@@ -473,14 +473,14 @@ Errors and Warnings
- ``: Files/directories were installed but not shipped in any package [installed-vs-shipped]``
Files have been installed within the
- ```do_install`` <#ref-tasks-install>`__ task but have not been
- included in any package by way of the ```FILES`` <#var-FILES>`__
+ :ref:`ref-tasks-install` task but have not been
+ included in any package by way of the :term:`FILES`
variable. Files that do not appear in any package cannot be present
in an image later on in the build process. You need to do one of the
following:
- Add the files to ``FILES`` for the package you want them to appear
- in (e.g. ``FILES_${``\ ```PN`` <#var-PN>`__\ ``}`` for the main
+ in (e.g. ``FILES_${``\ :term:`PN`\ ``}`` for the main
package).
- Delete the files at the end of the ``do_install`` task if the
@@ -496,15 +496,15 @@ Errors and Warnings
message might indicate that a private version of a library is being
erroneously picked up as the provider for a common library. If that
is the case, you should add the library's ``.so`` file name to
- ```PRIVATE_LIBS`` <#var-PRIVATE_LIBS>`__ in the recipe that provides
+ :term:`PRIVATE_LIBS` in the recipe that provides
the private version of the library.
- ``LICENSE_ includes licenses () that are not listed in LICENSE [unlisted-pkg-lics]``
- The ```LICENSE`` <#var-LICENSE>`__ of the recipe should be a superset
+ The :term:`LICENSE` of the recipe should be a superset
of all the licenses of all packages produced by this recipe. In other
words, any license in ``LICENSE_*`` should also appear in
- ```LICENSE`` <#var-LICENSE>`__.
+ :term:`LICENSE`.
@@ -513,11 +513,11 @@ Configuring and Disabling QA Checks
You can configure the QA checks globally so that specific check failures
either raise a warning or an error message, using the
-```WARN_QA`` <#var-WARN_QA>`__ and ```ERROR_QA`` <#var-ERROR_QA>`__
+:term:`WARN_QA` and :term:`ERROR_QA`
variables, respectively. You can also disable checks within a particular
-recipe using ```INSANE_SKIP`` <#var-INSANE_SKIP>`__. For information on
+recipe using :term:`INSANE_SKIP`. For information on
how to work with the QA checks, see the
-"```insane.bbclass`` <#ref-classes-insane>`__" section.
+":ref:`insane.bbclass `" section.
.. note::
diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst
index c09fd7a075..95ec686a13 100644
--- a/documentation/ref-manual/ref-release-process.rst
+++ b/documentation/ref-manual/ref-release-process.rst
@@ -41,7 +41,7 @@ Major Release Codenames
Each major release receives a codename that identifies the release in
the `Yocto Project Source
Repositories <&YOCTO_DOCS_OM_URL;#yocto-project-repositories>`__. The
-concept is that branches of `Metadata <#metadata>`__ with the same
+concept is that branches of :term:`Metadata` with the same
codename are likely to be compatible and thus work together.
.. note::
@@ -107,12 +107,12 @@ consists of the following pieces:
- ``bitbake-selftest``: A standalone command that runs unit tests on
key pieces of BitBake and its fetchers.
-- ```sanity.bbclass`` <#ref-classes-sanity>`__: This automatically
+- :ref:`sanity.bbclass `: This automatically
included class checks the build environment for missing tools (e.g.
``gcc``) or common misconfigurations such as
- ```MACHINE`` <#var-MACHINE>`__ set incorrectly.
+ :term:`MACHINE` set incorrectly.
-- ```insane.bbclass`` <#ref-classes-insane>`__: This class checks the
+- :ref:`insane.bbclass `: This class checks the
generated output from builds for sanity. For example, if building for
an ARM target, did the build produce ARM binaries. If, for example,
the build produced PPC binaries then there is a problem.
@@ -149,7 +149,7 @@ efficiently.
The Yocto Project's main Autobuilder (``autobuilder.yoctoproject.org``)
publicly tests each Yocto Project release's code in the
-`OE-Core <#oe-core>`__, Poky, and BitBake repositories. The testing
+:term:`OpenEmbedded-Core (OE-Core)`, Poky, and BitBake repositories. The testing
occurs for both the current state of the "master" branch and also for
submitted patches. Testing for submitted patches usually occurs in the
"ross/mut" branch in the ``poky-contrib`` repository (i.e. the
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
index 5e30a08041..c63900e604 100644
--- a/documentation/ref-manual/ref-structure.rst
+++ b/documentation/ref-manual/ref-structure.rst
@@ -4,7 +4,7 @@
Source Directory Structure
**************************
-The `Source Directory <#source-directory>`__ consists of numerous files,
+The :term:`Source Directory` consists of numerous files,
directories and subdirectories; understanding their locations and
contents is key to using the Yocto Project effectively. This chapter
describes the Source Directory and gives information about those files
@@ -36,7 +36,7 @@ Directory <#source-directory>`__.
This directory includes a copy of BitBake for ease of use. The copy
usually matches the current stable BitBake release from the BitBake
-project. BitBake, a `Metadata <#metadata>`__ interpreter, reads the
+project. BitBake, a :term:`Metadata` interpreter, reads the
Yocto Project Metadata and runs the tasks defined by that data. Failures
are usually caused by errors in your Metadata and not from BitBake
itself; consequently, most users do not need to worry about BitBake.
@@ -63,7 +63,7 @@ the OpenEmbedded build environment setup script (i.e.
````` <#structure-core-script>`__).
It is also possible to place output and configuration files in a
-directory separate from the `Source Directory <#source-directory>`__ by
+directory separate from the :term:`Source Directory` by
providing a directory name when you ``source`` the setup script. For
information on separating output from your local Source Directory files
(commonly described as an "out of tree" build), see the
@@ -152,7 +152,7 @@ BitBake commands. The script uses other scripts within the ``scripts``
directory to do the bulk of the work.
When you run this script, your Yocto Project environment is set up, a
-`Build Directory <#build-directory>`__ is created, your working
+:term:`Build Directory` is created, your working
directory becomes the Build Directory, and you are presented with some
simple suggestions as to what to do next, including a list of some
possible targets to build. Here is an example: $ source
@@ -162,7 +162,7 @@ core-image-sato meta-toolchain meta-ide-support You can also run
generated qemu images with a command like 'runqemu qemux86-64' The
default output of the ``oe-init-build-env`` script is from the
``conf-notes.txt`` file, which is found in the ``meta-poky`` directory
-within the `Source Directory <#source-directory>`__. If you design a
+within the :term:`Source Directory`. If you design a
custom distribution, you can include your own version of this
configuration file to mention the targets defined by your distribution.
See the "`Creating a Custom Template Configuration
@@ -213,7 +213,7 @@ Directory a specific name when you run the setup script, the name
defaults to ``build/``.
For subsequent parsing and processing, the name of the Build directory
-is available via the ```TOPDIR`` <#var-TOPDIR>`__ variable.
+is available via the :term:`TOPDIR` variable.
.. _structure-build-buildhistory:
@@ -243,7 +243,7 @@ relatively rare.
At a minimum, you would normally edit this file to select the target
``MACHINE``, which package types you wish to use
-(```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__), and the location from
+(:term:`PACKAGE_CLASSES`), and the location from
which you want to access downloaded files (``DL_DIR``).
If ``local.conf`` is not present when you start the build, the
@@ -261,7 +261,7 @@ build environment from any layer by setting the variable in the
top-level build environment setup script as follows:
TEMPLATECONF=your_layer/conf Once the build process gets the sample
file, it uses ``sed`` to substitute final
-``${``\ ```OEROOT`` <#var-OEROOT>`__\ ``}`` values for all
+``${``\ :term:`OEROOT`\ ``}`` values for all
``##OEROOT##`` values.
.. note::
@@ -286,7 +286,7 @@ file, it uses ``sed`` to substitute final
This configuration file defines
`layers <&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers>`__,
which are directory trees, traversed (or walked) by BitBake. The
-``bblayers.conf`` file uses the ```BBLAYERS`` <#var-BBLAYERS>`__
+``bblayers.conf`` file uses the :term:`BBLAYERS`
variable to list the layers BitBake tries to find.
If ``bblayers.conf`` is not present when you start the build, the
@@ -304,7 +304,7 @@ implies that you can base your build from any layer by setting the
variable in the top-level build environment setup script as follows:
TEMPLATECONF=your_layer/conf Once the build process gets the sample
file, it uses ``sed`` to substitute final
-``${``\ ```OEROOT`` <#var-OEROOT>`__\ ``}`` values for all
+``${``\ :term:`OEROOT`\ ``}`` values for all
``##OEROOT##`` values.
.. note::
@@ -355,7 +355,7 @@ You can control the location of this directory through the
--------------
The OpenEmbedded build system creates and uses this directory for all
-the build system's output. The ```TMPDIR`` <#var-TMPDIR>`__ variable
+the build system's output. The :term:`TMPDIR` variable
points to this directory.
BitBake creates this directory if it does not exist. As a last resort,
@@ -393,7 +393,7 @@ cache is reused. If the file has changed, it is reparsed.
---------------------
This directory contains any "end result" output from the OpenEmbedded
-build process. The ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__ variable points
+build process. The :term:`DEPLOY_DIR` variable points
to this directory. For more detail on the contents of the ``deploy``
directory, see the
"`Images <&YOCTO_DOCS_OM_URL;#images-dev-environment>`__" and
@@ -497,11 +497,11 @@ another.
----------------------------------
This directory is the location of the sysroot contents that the task
-```do_prepare_recipe_sysroot`` <#ref-tasks-prepare_recipe_sysroot>`__
+:ref:`ref-tasks-prepare_recipe_sysroot`
links or copies into the recipe-specific sysroot for each recipe listed
-in ```DEPENDS`` <#var-DEPENDS>`__. Population of this directory is
+in :term:`DEPENDS`. Population of this directory is
handled through shared state, while the path is specified by the
-```COMPONENTS_DIR`` <#var-COMPONENTS_DIR>`__ variable. Apart from a few
+:term:`COMPONENTS_DIR` variable. Apart from a few
unusual circumstances, handling of the ``sysroots-components`` directory
should be automatic, and recipes should not directly reference
``build/tmp/sysroots-components``.
@@ -514,7 +514,7 @@ should be automatic, and recipes should not directly reference
Previous versions of the OpenEmbedded build system used to create a
global shared sysroot per machine along with a native sysroot. Beginning
with the DISTRO version of the Yocto Project, sysroots exist in
-recipe-specific ```WORKDIR`` <#var-WORKDIR>`__ directories. Thus, the
+recipe-specific :term:`WORKDIR` directories. Thus, the
``build/tmp/sysroots/`` directory is unused.
.. note::
@@ -566,7 +566,7 @@ directory. For example, the source for a particular package is unpacked,
patched, configured and compiled all within its own work directory.
Within the work directory, organization is based on the package group
and version for which the source is being compiled as defined by the
-```WORKDIR`` <#var-WORKDIR>`__.
+:term:`WORKDIR`.
It is worth considering the structure of a typical work directory. As an
example, consider ``linux-yocto-kernel-3.0`` on the machine ``qemux86``
@@ -599,12 +599,12 @@ As described earlier in the
"```build/tmp/sysroots/`` <#structure-build-tmp-sysroots>`__" section,
beginning with the DISTRO release of the Yocto Project, the OpenEmbedded
build system builds each recipe in its own work directory (i.e.
-```WORKDIR`` <#var-WORKDIR>`__). The path to the work directory is
+:term:`WORKDIR`). The path to the work directory is
constructed using the architecture of the given build (e.g.
-```TUNE_PKGARCH`` <#var-TUNE_PKGARCH>`__,
-```MACHINE_ARCH`` <#var-MACHINE_ARCH>`__, or "allarch"), the recipe
+:term:`TUNE_PKGARCH`,
+:term:`MACHINE_ARCH`, or "allarch"), the recipe
name, and the version of the recipe (i.e.
-```PE`` <#var-PE>`__\ ``:``\ ```PV`` <#var-PV>`__\ ``-``\ ```PR`` <#var-PR>`__).
+:term:`PE`\ ``:``\ :term:`PV`\ ``-``\ :term:`PR`).
A number of key subdirectories exist within each recipe work directory:
@@ -614,17 +614,17 @@ A number of key subdirectories exist within each recipe work directory:
which tasks were executed.
- ``${WORKDIR}/image``: Contains the output of the
- ```do_install`` <#ref-tasks-install>`__ task, which corresponds to
- the ``${``\ ```D`` <#var-D>`__\ ``}`` variable in that task.
+ :ref:`ref-tasks-install` task, which corresponds to
+ the ``${``\ :term:`D`\ ``}`` variable in that task.
- ``${WORKDIR}/pseudo``: Contains the pseudo database and log for any
tasks executed under pseudo for the recipe.
- ``${WORKDIR}/sysroot-destdir``: Contains the output of the
- ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task.
+ :ref:`ref-tasks-populate_sysroot` task.
- ``${WORKDIR}/package``: Contains the output of the
- ```do_package`` <#ref-tasks-package>`__ task before the output is
+ :ref:`ref-tasks-package` task before the output is
split into individual packages.
- ``${WORKDIR}/packages-split``: Contains the output of the
@@ -645,7 +645,7 @@ A number of key subdirectories exist within each recipe work directory:
- ``${WORKDIR}/build``: This subdirectory applies only to recipes that
support builds where the source is separate from the build artifacts.
The OpenEmbedded build system uses this directory as a separate build
- directory (i.e. ``${``\ ```B`` <#var-B>`__\ ``}``).
+ directory (i.e. ``${``\ :term:`B`\ ``}``).
.. _structure-build-work-shared:
@@ -662,7 +662,7 @@ recipes. In practice, this is only used for ``gcc`` and its variants
The Metadata - ``meta/``
========================
-As mentioned previously, `Metadata <#metadata>`__ is the core of the
+As mentioned previously, :term:`Metadata` is the core of the
Yocto Project. Metadata has several important subdivisions:
.. _structure-meta-classes:
@@ -681,7 +681,7 @@ generation or packaging also have their specific class files such as
``image.bbclass``, ``rootfs_*.bbclass`` and ``package*.bbclass``.
For reference information on classes, see the
-"`Classes <#ref-classes>`__" chapter.
+":ref:`ref-manual/ref-classes:Classes`" chapter.
.. _structure-meta-conf:
@@ -726,7 +726,7 @@ file mainly inherits its configuration from Poky.
The OpenEmbedded build system searches this directory for configuration
files that correspond to the value of
-```SDKMACHINE`` <#var-SDKMACHINE>`__. By default, 32-bit and 64-bit x86
+:term:`SDKMACHINE`. By default, 32-bit and 64-bit x86
files ship with the Yocto Project that support some SDK hosts. However,
it is possible to extend that support to other SDK hosts by adding
additional configuration files in this subdirectory within another
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index 1e4b8197a0..aa7c0df552 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -32,7 +32,7 @@ tasks required to build a recipe.
--------------
Compiles the source code. This task runs with the current working
-directory set to ``${``\ ```B`` <#var-B>`__\ ``}``.
+directory set to ``${``\ :term:`B`\ ``}``.
The default behavior of this task is to run the ``oe_runmake`` function
if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found.
@@ -52,11 +52,11 @@ Compiles the runtime test suite included in the software being built.
Configures the source by enabling and disabling any build-time and
configuration options for the software being built. The task runs with
-the current working directory set to ``${``\ ```B`` <#var-B>`__\ ``}``.
+the current working directory set to ``${``\ :term:`B`\ ``}``.
The default behavior of this task is to run ``oe_runmake clean`` if a
makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found and
-```CLEANBROKEN`` <#var-CLEANBROKEN>`__ is not set to "1". If no such
+:term:`CLEANBROKEN` is not set to "1". If no such
file is found or the ``CLEANBROKEN`` variable is set to "1", the
``do_configure`` task does nothing.
@@ -73,13 +73,13 @@ Configures the runtime test suite included in the software being built.
-------------
Writes output files that are to be deployed to
-``${``\ ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__\ ``}``. The
+``${``\ :term:`DEPLOY_DIR_IMAGE`\ ``}``. The
task runs with the current working directory set to
-``${``\ ```B`` <#var-B>`__\ ``}``.
+``${``\ :term:`B`\ ``}``.
Recipes implementing this task should inherit the
-```deploy`` <#ref-classes-deploy>`__ class and should write the output
-to ``${``\ ```DEPLOYDIR`` <#var-DEPLOYDIR>`__\ ``}``, which is not to be
+:ref:`deploy ` class and should write the output
+to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be
confused with ``${DEPLOY_DIR}``. The ``deploy`` class sets up
``do_deploy`` as a shared state (sstate) task that can be accelerated
through sstate use. The sstate mechanism takes care of copying the
@@ -93,7 +93,7 @@ output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``.
The ``do_deploy`` task is not added as a task by default and
consequently needs to be added manually. If you want the task to run
-after ```do_compile`` <#ref-tasks-compile>`__, you can add it by doing
+after :ref:`ref-tasks-compile`, you can add it by doing
the following: addtask deploy after do_compile Adding ``do_deploy``
after other tasks works the same way.
@@ -124,7 +124,7 @@ If the ``do_deploy`` task re-executes, any previous output is removed
------------
Fetches the source code. This task uses the
-```SRC_URI`` <#var-SRC_URI>`__ variable and the argument's prefix to
+:term:`SRC_URI` variable and the argument's prefix to
determine the correct `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__
module.
@@ -135,12 +135,12 @@ module.
Starts the image generation process. The ``do_image`` task runs after
the OpenEmbedded build system has run the
-```do_rootfs`` <#ref-tasks-rootfs>`__ task during which packages are
+:ref:`ref-tasks-rootfs` task during which packages are
identified for installation into the image and the root filesystem is
created, complete with post-processing.
The ``do_image`` task performs pre-processing on the image through the
-```IMAGE_PREPROCESS_COMMAND`` <#var-IMAGE_PREPROCESS_COMMAND>`__ and
+:term:`IMAGE_PREPROCESS_COMMAND` and
dynamically generates supporting ``do_image_*`` tasks as needed.
For more information on image creation, see the "`Image
@@ -154,13 +154,13 @@ section in the Yocto Project Overview and Concepts Manual.
Completes the image generation process. The ``do_image_complete`` task
runs after the OpenEmbedded build system has run the
-```do_image`` <#ref-tasks-image>`__ task during which image
+:ref:`ref-tasks-image` task during which image
pre-processing occurs and through dynamically generated ``do_image_*``
tasks the image is constructed.
The ``do_image_complete`` task performs post-processing on the image
through the
-```IMAGE_POSTPROCESS_COMMAND`` <#var-IMAGE_POSTPROCESS_COMMAND>`__.
+:term:`IMAGE_POSTPROCESS_COMMAND`.
For more information on image creation, see the "`Image
Generation <&YOCTO_DOCS_OM_URL;#image-generation-dev-environment>`__"
@@ -172,13 +172,13 @@ section in the Yocto Project Overview and Concepts Manual.
--------------
Copies files that are to be packaged into the holding area
-``${``\ ```D`` <#var-D>`__\ ``}``. This task runs with the current
-working directory set to ``${``\ ```B`` <#var-B>`__\ ``}``, which is the
+``${``\ :term:`D`\ ``}``. This task runs with the current
+working directory set to ``${``\ :term:`B`\ ``}``, which is the
compilation directory. The ``do_install`` task, as well as other tasks
that either directly or indirectly depend on the installed files (e.g.
-```do_package`` <#ref-tasks-package>`__,
+:ref:`ref-tasks-package`,
```do_package_write_*`` <#ref-tasks-package_write_deb>`__, and
-```do_rootfs`` <#ref-tasks-rootfs>`__), run under
+:ref:`ref-tasks-rootfs`), run under
`fakeroot <&YOCTO_DOCS_OM_URL;#fakeroot-and-pseudo>`__.
.. note::
@@ -199,7 +199,7 @@ that either directly or indirectly depend on the installed files (e.g.
- The ``tar`` command with the "--no-same-owner" option. See the
``bin_package.bbclass`` file in the ``meta/classes`` directory of
- the `Source Directory <#source-directory>`__ for an example.
+ the :term:`Source Directory` for an example.
.. _ref-tasks-install_ptest_base:
@@ -215,15 +215,15 @@ holding area.
--------------
Analyzes the content of the holding area
-``${``\ ```D`` <#var-D>`__\ ``}`` and splits the content into subsets
+``${``\ :term:`D`\ ``}`` and splits the content into subsets
based on available packages and files. This task makes use of the
-```PACKAGES`` <#var-PACKAGES>`__ and ```FILES`` <#var-FILES>`__
+:term:`PACKAGES` and :term:`FILES`
variables.
The ``do_package`` task, in conjunction with the
-```do_packagedata`` <#ref-tasks-packagedata>`__ task, also saves some
+:ref:`ref-tasks-packagedata` task, also saves some
important package metadata. For additional information, see the
-```PKGDESTWORK`` <#var-PKGDESTWORK>`__ variable and the "`Automatically
+:term:`PKGDESTWORK` variable and the "`Automatically
Added Runtime
Dependencies <&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies>`__"
section in the Yocto Project Overview and Concepts Manual.
@@ -234,7 +234,7 @@ section in the Yocto Project Overview and Concepts Manual.
-----------------
Runs QA checks on packaged files. For more information on these checks,
-see the ```insane`` <#ref-classes-insane>`__ class.
+see the :ref:`insane ` class.
.. _ref-tasks-package_write_deb:
@@ -242,7 +242,7 @@ see the ```insane`` <#ref-classes-insane>`__ class.
------------------------
Creates Debian packages (i.e. ``*.deb`` files) and places them in the
-``${``\ ```DEPLOY_DIR_DEB`` <#var-DEPLOY_DIR_DEB>`__\ ``}`` directory in
+``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in
the package feeds area. For more information, see the "`Package
Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in
the Yocto Project Overview and Concepts Manual.
@@ -253,7 +253,7 @@ the Yocto Project Overview and Concepts Manual.
------------------------
Creates IPK packages (i.e. ``*.ipk`` files) and places them in the
-``${``\ ```DEPLOY_DIR_IPK`` <#var-DEPLOY_DIR_IPK>`__\ ``}`` directory in
+``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in
the package feeds area. For more information, see the "`Package
Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in
the Yocto Project Overview and Concepts Manual.
@@ -264,7 +264,7 @@ the Yocto Project Overview and Concepts Manual.
------------------------
Creates RPM packages (i.e. ``*.rpm`` files) and places them in the
-``${``\ ```DEPLOY_DIR_RPM`` <#var-DEPLOY_DIR_RPM>`__\ ``}`` directory in
+``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in
the package feeds area. For more information, see the "`Package
Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in
the Yocto Project Overview and Concepts Manual.
@@ -275,7 +275,7 @@ the Yocto Project Overview and Concepts Manual.
------------------------
Creates tarballs and places them in the
-``${``\ ```DEPLOY_DIR_TAR`` <#var-DEPLOY_DIR_TAR>`__\ ``}`` directory in
+``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in
the package feeds area. For more information, see the "`Package
Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in
the Yocto Project Overview and Concepts Manual.
@@ -286,8 +286,8 @@ the Yocto Project Overview and Concepts Manual.
------------------
Saves package metadata generated by the
-```do_package`` <#ref-tasks-package>`__ task in
-```PKGDATA_DIR`` <#var-PKGDATA_DIR>`__ to make it available globally.
+:ref:`ref-tasks-package` task in
+:term:`PKGDATA_DIR` to make it available globally.
.. _ref-tasks-patch:
@@ -297,7 +297,7 @@ Saves package metadata generated by the
Locates patch files and applies them to the source code.
After fetching and unpacking source files, the build system uses the
-recipe's ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ statements
+recipe's :term:`SRC_URI` statements
to locate and apply patch files to the source code.
.. note::
@@ -375,7 +375,7 @@ information.
-----------------------
Stages (copies) a subset of the files installed by the
-```do_install`` <#ref-tasks-install>`__ task into the appropriate
+:ref:`ref-tasks-install` task into the appropriate
sysroot. For information on how to access these files from other
recipes, see the ```STAGING_DIR*`` <#var-STAGING_DIR_HOST>`__ variables.
Directories that would typically not be needed by other recipes at build
@@ -398,9 +398,9 @@ that if the task is re-executed, any previous output is removed (i.e.
Installs the files into the individual recipe specific sysroots (i.e.
``recipe-sysroot`` and ``recipe-sysroot-native`` under
-``${``\ ```WORKDIR`` <#var-WORKDIR>`__\ ``}`` based upon the
-dependencies specified by ```DEPENDS`` <#var-DEPENDS>`__). See the
-"```staging`` <#ref-classes-staging>`__" class for more information.
+``${``\ :term:`WORKDIR`\ ``}`` based upon the
+dependencies specified by :term:`DEPENDS`). See the
+":ref:`staging `" class for more information.
.. _ref-tasks-rm_work:
@@ -417,7 +417,7 @@ them. You can learn more by looking at the
-------------
Unpacks the source code into a working directory pointed to by
-``${``\ ```WORKDIR`` <#var-WORKDIR>`__\ ``}``. The ```S`` <#var-S>`__
+``${``\ :term:`WORKDIR`\ ``}``. The :term:`S`
variable also plays a role in where unpacked source files ultimately
reside. For more information on how source files are unpacked, see the
"`Source
@@ -459,7 +459,7 @@ default, the results are stored in ```$LOG_DIR`` <#var-LOG_DIR>`__ (e.g.
``do_checkuri``
---------------
-Validates the ```SRC_URI`` <#var-SRC_URI>`__ value.
+Validates the :term:`SRC_URI` value.
.. _ref-tasks-clean:
@@ -467,11 +467,11 @@ Validates the ```SRC_URI`` <#var-SRC_URI>`__ value.
------------
Removes all output files for a target from the
-```do_unpack`` <#ref-tasks-unpack>`__ task forward (i.e. ``do_unpack``,
-```do_configure`` <#ref-tasks-configure>`__,
-```do_compile`` <#ref-tasks-compile>`__,
-```do_install`` <#ref-tasks-install>`__, and
-```do_package`` <#ref-tasks-package>`__).
+:ref:`ref-tasks-unpack` task forward (i.e. ``do_unpack``,
+:ref:`ref-tasks-configure`,
+:ref:`ref-tasks-compile`,
+:ref:`ref-tasks-install`, and
+:ref:`ref-tasks-package`).
You can run this task using BitBake as follows: $ bitbake -c clean
recipe
@@ -481,7 +481,7 @@ Running this task does not remove the
Consequently, if no changes have been made and the recipe is rebuilt
after cleaning, output files are simply restored from the sstate cache.
If you want to remove the sstate cache files for the recipe, you need to
-use the ```do_cleansstate`` <#ref-tasks-cleansstate>`__ task instead
+use the :ref:`ref-tasks-cleansstate` task instead
(i.e. ``bitbake -c cleansstate`` recipe).
.. _ref-tasks-cleanall:
@@ -492,15 +492,15 @@ use the ```do_cleansstate`` <#ref-tasks-cleansstate>`__ task instead
Removes all output files, shared state
(`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) cache, and
downloaded source files for a target (i.e. the contents of
-```DL_DIR`` <#var-DL_DIR>`__). Essentially, the ``do_cleanall`` task is
-identical to the ```do_cleansstate`` <#ref-tasks-cleansstate>`__ task
+:term:`DL_DIR`). Essentially, the ``do_cleanall`` task is
+identical to the :ref:`ref-tasks-cleansstate` task
with the added removal of downloaded source files.
You can run this task using BitBake as follows: $ bitbake -c cleanall
recipe
Typically, you would not normally use the ``cleanall`` task. Do so only
-if you want to start fresh with the ```do_fetch`` <#ref-tasks-fetch>`__
+if you want to start fresh with the :ref:`ref-tasks-fetch`
task.
.. _ref-tasks-cleansstate:
@@ -511,7 +511,7 @@ task.
Removes all output files and shared state
(`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) cache for a
target. Essentially, the ``do_cleansstate`` task is identical to the
-```do_clean`` <#ref-tasks-clean>`__ task with the added removal of
+:ref:`ref-tasks-clean` task with the added removal of
shared state (`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__)
cache.
@@ -596,7 +596,7 @@ The following tasks are applicable to image recipes.
--------------
Creates a bootable live image. See the
-```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable for additional
+:term:`IMAGE_FSTYPES` variable for additional
information on live image types.
.. _ref-tasks-bundle_initramfs:
@@ -606,7 +606,7 @@ information on live image types.
Combines an initial RAM disk (initramfs) image and kernel together to
form a single image. The
-```CONFIG_INITRAMFS_SOURCE`` <#var-CONFIG_INITRAMFS_SOURCE>`__ variable
+:term:`CONFIG_INITRAMFS_SOURCE` variable
has some more information about these types of images.
.. _ref-tasks-rootfs:
@@ -638,7 +638,7 @@ section in the Yocto Project Development Tasks Manual.
Boots an image and performs runtime tests within the image immediately
after it has been built. This task is enabled when you set
-```TESTIMAGE_AUTO`` <#var-TESTIMAGE_AUTO>`__ equal to "1".
+:term:`TESTIMAGE_AUTO` equal to "1".
For information on automatically testing images, see the "`Performing
Automated Runtime
@@ -649,7 +649,7 @@ Kernel-Related Tasks
====================
The following tasks are applicable to kernel recipes. Some of these
-tasks (e.g. the ```do_menuconfig`` <#ref-tasks-menuconfig>`__ task) are
+tasks (e.g. the :ref:`ref-tasks-menuconfig` task) are
also applicable to recipes that use Linux kernel style configuration
such as the BusyBox recipe.
@@ -669,9 +669,9 @@ kernel consists of two steps: 1) the kernel (``vmlinux``) is built, and
When invoked by the user, this task creates a file containing the
differences between the original config as produced by
-```do_kernel_configme`` <#ref-tasks-kernel_configme>`__ task and the
+:ref:`ref-tasks-kernel_configme` task and the
changes made by the user with other methods (i.e. using
-(```do_kernel_menuconfig`` <#ref-tasks-kernel_menuconfig>`__). Once the
+(:ref:`ref-tasks-kernel_menuconfig`). Once the
file of differences is created, it can be used to create a config
fragment that only contains the differences. You can invoke this task
from the command line as follows: $ bitbake linux-yocto -c diffconfig
@@ -696,7 +696,7 @@ kernel with the correct branches checked out.
-------------------------
Validates the configuration produced by the
-```do_kernel_menuconfig`` <#ref-tasks-kernel_menuconfig>`__ task. The
+:ref:`ref-tasks-kernel_menuconfig` task. The
``do_kernel_configcheck`` task produces warnings when a requested
configuration does not appear in the final ``.config`` file or when you
override a policy configuration in a hardware configuration fragment.
@@ -711,7 +711,7 @@ section in the Yocto Project Linux Kernel Development Manual.
``do_kernel_configme``
----------------------
-After the kernel is patched by the ```do_patch`` <#ref-tasks-patch>`__
+After the kernel is patched by the :ref:`ref-tasks-patch`
task, the ``do_kernel_configme`` task assembles and merges all the
kernel config fragments into a merged configuration that can then be
passed to the kernel configuration phase proper. This is also the time
@@ -746,12 +746,12 @@ information on this configuration tool.
----------------------
Collects all the features required for a given kernel build, whether the
-features come from ```SRC_URI`` <#var-SRC_URI>`__ or from Git
+features come from :term:`SRC_URI` or from Git
repositories. After collection, the ``do_kernel_metadata`` task
processes the features into a series of config fragments and patches,
which can then be applied by subsequent tasks such as
-```do_patch`` <#ref-tasks-patch>`__ and
-```do_kernel_configme`` <#ref-tasks-kernel_configme>`__.
+:ref:`ref-tasks-patch` and
+:ref:`ref-tasks-kernel_configme`.
.. _ref-tasks-menuconfig:
@@ -772,7 +772,7 @@ When invoked by the user, creates a defconfig file that can be used
instead of the default defconfig. The saved defconfig contains the
differences between the default defconfig and the changes made by the
user using other methods (i.e. the
-```do_kernel_menuconfig`` <#ref-tasks-kernel_menuconfig>`__ task. You
+:ref:`ref-tasks-kernel_menuconfig` task. You
can invoke the task using the following command: $ bitbake linux-yocto
-c savedefconfig
@@ -785,7 +785,7 @@ After the kernel has been compiled but before the kernel modules have
been compiled, this task copies files required for module builds and
which are generated from the kernel build into the shared work
directory. With these copies successfully copied, the
-```do_compile_kernelmodules`` <#ref-tasks-compile_kernelmodules>`__ task
+:ref:`ref-tasks-compile_kernelmodules` task
can successfully build the kernel modules in the next step of the build.
.. _ref-tasks-sizecheck:
@@ -795,7 +795,7 @@ can successfully build the kernel modules in the next step of the build.
After the kernel has been built, this task checks the size of the
stripped kernel image against
-```KERNEL_IMAGE_MAXSIZE`` <#var-KERNEL_IMAGE_MAXSIZE>`__. If that
+:term:`KERNEL_IMAGE_MAXSIZE`. If that
variable was set and the size of the stripped kernel exceeds that size,
the kernel build produces a warning to that effect.
@@ -816,9 +816,9 @@ sections from a size-sensitive configuration.
After the kernel is unpacked but before it is patched, this task makes
sure that the machine and metadata branches as specified by the
-```SRCREV`` <#var-SRCREV>`__ variables actually exist on the specified
+:term:`SRCREV` variables actually exist on the specified
branches. If these branches do not exist and
-```AUTOREV`` <#var-AUTOREV>`__ is not being used, the
+:term:`AUTOREV` is not being used, the
``do_validate_branches`` task fails during the build.
Miscellaneous Tasks
@@ -833,4 +833,4 @@ The following sections describe miscellaneous tasks.
A build stage that takes the source code and scans it on a remote
FOSSOLOGY server in order to produce an SPDX document. This task applies
-only to the ```spdx`` <#ref-classes-spdx>`__ class.
+only to the :ref:`spdx ` class.
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst
index 59100e9c88..4298e04965 100644
--- a/documentation/ref-manual/ref-terms.rst
+++ b/documentation/ref-manual/ref-terms.rst
@@ -113,7 +113,7 @@ universal, the list includes them just in case:
Files that provide for logic encapsulation and inheritance so that
commonly used patterns can be defined once and then easily used in
multiple recipes. For reference information on the Yocto Project classes,
- see the "`Classes <#ref-classes>`__" chapter. Class files end with the
+ see the ":ref:`ref-manual/ref-classes:Classes`" chapter. Class files end with the
``.bbclass`` filename extension.
Configuration File
@@ -200,7 +200,7 @@ universal, the list includes them just in case:
Metadata
A key element of the Yocto Project is the Metadata that
is used to construct a Linux distribution and is contained in the
- files that the `OpenEmbedded build system <#build-system-term>`__
+ files that the :term:`OpenEmbedded Build System`
parses when building an image. In general, Metadata includes recipes,
configuration files, and other information that refers to the build
instructions themselves, as well as the data used to control what
@@ -233,7 +233,7 @@ universal, the list includes them just in case:
OpenEmbedded Build System
The build system specific to the Yocto
Project. The OpenEmbedded build system is based on another project
- known as "Poky", which uses `BitBake <#bitbake-term>`__ as the task
+ known as "Poky", which uses :term:`BitBake` as the task
executor. Throughout the Yocto Project documentation set, the
OpenEmbedded build system is sometimes referred to simply as "the
build system". If other build systems, such as a host or target build
@@ -262,8 +262,8 @@ universal, the list includes them just in case:
Another point worth noting is that historically within the Yocto
Project, recipes were referred to as packages - thus, the existence
of several BitBake variables that are seemingly mis-named, (e.g.
- ```PR`` <#var-PR>`__, ```PV`` <#var-PV>`__, and
- ```PE`` <#var-PE>`__).
+ :term:`PR`, :term:`PV`, and
+ :term:`PE`).
Package Groups
Arbitrary groups of software Recipes. You use
@@ -373,9 +373,9 @@ universal, the list includes them just in case:
Task
A unit of execution for BitBake (e.g.
- ```do_compile`` <#ref-tasks-compile>`__,
- ```do_fetch`` <#ref-tasks-fetch>`__,
- ```do_patch`` <#ref-tasks-patch>`__, and so forth).
+ :ref:`ref-tasks-compile`,
+ :ref:`ref-tasks-fetch`,
+ :ref:`ref-tasks-patch`, and so forth).
Toaster
A web interface to the Yocto Project's `OpenEmbedded Build
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index b84640c6a7..3eae836fd6 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -7,12 +7,12 @@ Variables Glossary
This chapter lists common variables used in the OpenEmbedded build
system and gives an overview of their function and contents.
-`A <#var-ABIEXTENSION>`__ `B <#var-B>`__ `C <#var-CACHE>`__
-`D <#var-D>`__ `E <#var-EFI_PROVIDER>`__ `F <#var-FEATURE_PACKAGES>`__
+`A <#var-ABIEXTENSION>`__ :term:`B` `C <#var-CACHE>`__
+:term:`D` `E <#var-EFI_PROVIDER>`__ `F <#var-FEATURE_PACKAGES>`__
`G <#var-GCCPIE>`__ `H <#var-HOMEPAGE>`__ `I <#var-ICECC_DISABLED>`__
`K <#var-KARCH>`__ `L <#var-LABELS>`__ `M <#var-MACHINE>`__
-`N <#var-NATIVELSBSTRING>`__ `O <#var-OBJCOPY>`__ `P <#var-P>`__
-`R <#var-RANLIB>`__ `S <#var-S>`__ `T <#var-T>`__
+`N <#var-NATIVELSBSTRING>`__ `O <#var-OBJCOPY>`__ :term:`P`
+`R <#var-RANLIB>`__ :term:`S` :term:`T`
`U <#var-UBOOT_CONFIG>`__ `V <#var-VOLATILE_LOG_DIR>`__
`W <#var-WARN_QA>`__ `X <#var-XSERVER>`__
@@ -30,7 +30,7 @@ system and gives an overview of their function and contents.
Specifies whether to produce an output package even if it is empty.
By default, BitBake does not produce empty packages. This default
behavior can cause issues when there is an
- ```RDEPENDS`` <#var-RDEPENDS>`__ or some other hard runtime
+ :term:`RDEPENDS` or some other hard runtime
requirement on the existence of the package.
Like all package-controlling variables, you must always use them in
@@ -49,7 +49,7 @@ system and gives an overview of their function and contents.
has four commands that also exist as part of another package, you
identify them as follows: ALTERNATIVE_busybox = "sh sed test bracket"
For more information on the alternatives system, see the
- "```update-alternatives.bbclass`` <#ref-classes-update-alternatives>`__"
+ ":ref:`update-alternatives.bbclass `"
section.
ALTERNATIVE_LINK_NAME
@@ -72,7 +72,7 @@ system and gives an overview of their function and contents.
.
For more information on the alternatives system, see the
- "```update-alternatives.bbclass`` <#ref-classes-update-alternatives>`__"
+ ":ref:`update-alternatives.bbclass `"
section.
ALTERNATIVE_PRIORITY
@@ -86,7 +86,7 @@ system and gives an overview of their function and contents.
ALTERNATIVE_PRIORITY_pkg[name] = "priority"
For more information on the alternatives system, see the
- "```update-alternatives.bbclass`` <#ref-classes-update-alternatives>`__"
+ ":ref:`update-alternatives.bbclass `"
section.
ALTERNATIVE_TARGET
@@ -103,7 +103,7 @@ system and gives an overview of their function and contents.
If ``ALTERNATIVE_TARGET`` is not defined, it inherits the value
from the
- ```ALTERNATIVE_LINK_NAME`` <#var-ALTERNATIVE_LINK_NAME>`__
+ :term:`ALTERNATIVE_LINK_NAME`
variable.
If ``ALTERNATIVE_LINK_NAME`` and ``ALTERNATIVE_TARGET`` are the
@@ -112,25 +112,25 @@ system and gives an overview of their function and contents.
Finally, if the file referenced has not been renamed, the
alternatives system will rename it to avoid the need to rename
- alternative files in the ```do_install`` <#ref-tasks-install>`__
+ alternative files in the :ref:`ref-tasks-install`
task while retaining support for the command if necessary.
For more information on the alternatives system, see the
- "```update-alternatives.bbclass`` <#ref-classes-update-alternatives>`__"
+ ":ref:`update-alternatives.bbclass `"
section.
APPEND
An override list of append strings for each target specified with
- ```LABELS`` <#var-LABELS>`__.
+ :term:`LABELS`.
- See the ```grub-efi`` <#ref-classes-grub-efi>`__ class for more
+ See the :ref:`grub-efi ` class for more
information on how this variable is used.
AR
The minimal command and arguments used to run ``ar``.
ARCHIVER_MODE
- When used with the ```archiver`` <#ref-classes-archiver>`__ class,
+ When used with the :ref:`archiver ` class,
determines the type of information used to create a released archive.
You can use this variable to create archives of patched source,
original source, configured source, and so forth by employing the
@@ -151,7 +151,7 @@ system and gives an overview of their function and contents.
Minimal command and arguments needed to run the assembler.
ASSUME_PROVIDED
- Lists recipe names (```PN`` <#var-PN>`__ values) BitBake does not
+ Lists recipe names (:term:`PN` values) BitBake does not
attempt to build. Instead, BitBake assumes these recipes have already
been built.
@@ -178,7 +178,7 @@ system and gives an overview of their function and contents.
order to send patches and forward bugs.
AUTO_LIBNAME_PKGS
- When the ```debian`` <#ref-classes-debian>`__ class is inherited,
+ When the :ref:`debian ` class is inherited,
which is the default behavior, ``AUTO_LIBNAME_PKGS`` specifies which
packages should be checked for libraries and renamed according to
Debian library package naming.
@@ -189,7 +189,7 @@ system and gives an overview of their function and contents.
AUTO_SYSLINUXMENU
Enables creating an automatic menu for the syslinux bootloader. You
must set this variable in your recipe. The
- ```syslinux`` <#ref-classes-syslinux>`__ class checks this variable.
+ :ref:`syslinux ` class checks this variable.
AUTOREV
When ``SRCREV`` is set to the value of this variable, it specifies to
@@ -197,10 +197,10 @@ system and gives an overview of their function and contents.
SRCREV = "${AUTOREV}"
If you use the previous statement to retrieve the latest version of
- software, you need to be sure ```PV`` <#var-PV>`__ contains
- ``${``\ ```SRCPV`` <#var-SRCPV>`__\ ``}``. For example, suppose you
+ software, you need to be sure :term:`PV` contains
+ ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you
have a kernel recipe that inherits the
- `kernel <#ref-classes-kernel>`__ class and you use the previous
+ :ref:`kernel ` class and you use the previous
statement. In this example, ``${SRCPV}`` does not automatically get
into ``PV``. Consequently, you need to change ``PV`` in your recipe
so that it does contain ``${SRCPV}``.
@@ -212,8 +212,8 @@ system and gives an overview of their function and contents.
AVAILABLE_LICENSES
List of licenses found in the directories specified by
- ```COMMON_LICENSE_DIR`` <#var-COMMON_LICENSE_DIR>`__ and
- ```LICENSE_PATH`` <#var-LICENSE_PATH>`__.
+ :term:`COMMON_LICENSE_DIR` and
+ :term:`LICENSE_PATH`.
.. note::
@@ -245,10 +245,10 @@ system and gives an overview of their function and contents.
User Manual for more information.
B
- The directory within the `Build Directory <#build-directory>`__ in
+ The directory within the :term:`Build Directory` 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`` <#var-S>`__ directory, which is defined as: S =
+ :term:`S` directory, which is defined as: S =
"${WORKDIR}/${BP}"
You can separate the (``S``) directory and the directory pointed to
@@ -259,7 +259,7 @@ system and gives an overview of their function and contents.
BAD_RECOMMENDATIONS
Lists "recommended-only" packages to not install. Recommended-only
packages are packages installed only through the
- ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ variable. You can prevent any
+ :term:`RRECOMMENDS` variable. You can prevent any
of these "recommended" packages from being installed by listing them
with the ``BAD_RECOMMENDATIONS`` variable: BAD_RECOMMENDATIONS =
"package_name package_name package_name ..."
@@ -270,15 +270,15 @@ system and gives an overview of their function and contents.
It is important to realize that if you choose to not install packages
using this variable and some other packages are dependent on them
- (i.e. listed in a recipe's ```RDEPENDS`` <#var-RDEPENDS>`__
+ (i.e. listed in a recipe's :term:`RDEPENDS`
variable), the OpenEmbedded build system ignores your request and
will install the packages to avoid dependency errors.
Support for this variable exists only when using the IPK and RPM
packaging backend. Support does not exist for DEB.
- See the ```NO_RECOMMENDATIONS`` <#var-NO_RECOMMENDATIONS>`__ and the
- ```PACKAGE_EXCLUDE`` <#var-PACKAGE_EXCLUDE>`__ variables for related
+ See the :term:`NO_RECOMMENDATIONS` and the
+ :term:`PACKAGE_EXCLUDE` variables for related
information.
BASE_LIB
@@ -291,7 +291,7 @@ system and gives an overview of their function and contents.
on Multilib.
The ``BASE_LIB`` variable is defined in the machine include files in
- the `Source Directory <#source-directory>`__. If Multilib is not
+ the :term:`Source Directory`. If Multilib is not
being used, the value defaults to "lib".
BASE_WORKDIR
@@ -327,10 +327,10 @@ system and gives an overview of their function and contents.
- Attempts to access networks not in the host list cause a failure.
Using ``BB_ALLOWED_NETWORKS`` in conjunction with
- ```PREMIRRORS`` <#var-PREMIRRORS>`__ is very useful. Adding the host
+ :term:`PREMIRRORS` is very useful. Adding the host
you want to use to ``PREMIRRORS`` results in the source code being
fetched from an allowed location and avoids raising an error when a
- host that is not allowed is in a ```SRC_URI`` <#var-SRC_URI>`__
+ host that is not allowed is in a :term:`SRC_URI`
statement. This is because the fetcher does not attempt to use the
host listed in ``SRC_URI`` after a successful fetch from the
``PREMIRRORS`` occurs.
@@ -349,7 +349,7 @@ system and gives an overview of their function and contents.
You can change the default behavior by setting this variable to "1",
"yes", or "true" in your ``local.conf`` file, which is located in the
- `Build Directory <#build-directory>`__: Here is an example:
+ :term:`Build Directory`: Here is an example:
BB_DANGLINGAPPENDS_WARNONLY = "1"
BB_DISKMON_DIRS
@@ -358,7 +358,7 @@ system and gives an overview of their function and contents.
Disk space monitoring is disabled by default. To enable monitoring,
add the ``BB_DISKMON_DIRS`` variable to your ``conf/local.conf`` file
- found in the `Build Directory <#build-directory>`__. Use the
+ found in the :term:`Build Directory`. 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
@@ -379,7 +379,7 @@ system and gives an overview of their function and contents.
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 provide the
- ```BB_DISKMON_WARNINTERVAL`` <#var-BB_DISKMON_WARNINTERVAL>`__
+ :term:`BB_DISKMON_WARNINTERVAL`
variable in the ``conf/local.conf``. This example causes the build
system to immediately abort when either the disk space in
``${TMPDIR}`` drops below 1 Gbyte or the available free inodes drops
@@ -402,10 +402,10 @@ system and gives an overview of their function and contents.
BB_DISKMON_WARNINTERVAL
Defines the disk space and free inode warning intervals. To set these
intervals, define the variable in your ``conf/local.conf`` file in
- the `Build Directory <#build-directory>`__.
+ the :term:`Build Directory`.
If you are going to use the ``BB_DISKMON_WARNINTERVAL`` variable, you
- must also use the ```BB_DISKMON_DIRS`` <#var-BB_DISKMON_DIRS>`__
+ must also use the :term:`BB_DISKMON_DIRS`
variable and define its action as "WARN". During the build,
subsequent warnings are issued each time disk space or number of free
inodes further reduces by the respective interval.
@@ -436,12 +436,12 @@ system and gives an overview of their function and contents.
BB_GENERATE_MIRROR_TARBALLS
Causes tarballs of the source control repositories (e.g. Git
repositories), including metadata, to be placed in the
- ```DL_DIR`` <#var-DL_DIR>`__ directory.
+ :term:`DL_DIR` directory.
For performance reasons, creating and placing tarballs of these
repositories is not the default action by the OpenEmbedded build
system. BB_GENERATE_MIRROR_TARBALLS = "1" Set this variable in your
- ``local.conf`` file in the `Build Directory <#build-directory>`__.
+ ``local.conf`` file in the :term:`Build Directory`.
Once you have the tarballs containing your source files, you can
clean up your ``DL_DIR`` directory by deleting any Git or other
@@ -481,7 +481,7 @@ system and gives an overview of their function and contents.
``quilt-native``, which is a copy of Quilt built to run on the build
system; "crosses" such as ``gcc-cross``, which is a compiler built to
run on the build machine but produces binaries that run on the target
- ```MACHINE`` <#var-MACHINE>`__; "nativesdk", which targets the SDK
+ :term:`MACHINE`; "nativesdk", which targets the SDK
machine instead of ``MACHINE``; and "mulitlibs" in the form
"``multilib:``\ multilib_name".
@@ -495,7 +495,7 @@ system and gives an overview of their function and contents.
Internally, the ``BBCLASSEXTEND`` mechanism generates recipe
variants by rewriting variable values and applying overrides such
as ``_class-native``. For example, to generate a native version of
- a recipe, a ```DEPENDS`` <#var-DEPENDS>`__ on "foo" is rewritten
+ a recipe, a :term:`DEPENDS` on "foo" is rewritten
to a ``DEPENDS`` on "foo-native".
Even when using ``BBCLASSEXTEND``, the recipe is only parsed once.
@@ -511,7 +511,7 @@ system and gives an overview of their function and contents.
BBFILE_PATTERN
Variable that expands to match files from
- ```BBFILES`` <#var-BBFILES>`__ in a particular layer. This variable
+ :term:`BBFILES` in a particular layer. This variable
is used in the ``conf/layer.conf`` file and must be suffixed with the
name of the specific layer (e.g. ``BBFILE_PATTERN_emenlow``).
@@ -523,7 +523,7 @@ system and gives an overview of their function and contents.
prioritize a layer against other layers that contain the same recipe
- effectively letting you control the precedence for the multiple
layers. The precedence established through this variable stands
- regardless of a recipe's version (```PV`` <#var-PV>`__ variable). For
+ regardless of a recipe's version (:term:`PV` variable). For
example, a layer that has a recipe with a higher ``PV`` value but for
which the ``BBFILE_PRIORITY`` is set to have a lower precedence still
has a lower precedence.
@@ -576,7 +576,7 @@ system and gives an overview of their function and contents.
Variable that controls how BitBake displays logs on build failure.
BBINCLUDELOGS_LINES
- If ```BBINCLUDELOGS`` <#var-BBINCLUDELOGS>`__ is set, specifies the
+ If :term:`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.
@@ -629,7 +629,7 @@ system and gives an overview of their function and contents.
multiconfigname for each configuration file you are using. For
example, the following line specifies three configuration files:
BBMULTICONFIG = "configA configB configC" Each configuration file you
- use must reside in the `Build Directory <#build-directory>`__
+ use must reside in the :term:`Build Directory`
``conf/multiconfig`` directory (e.g.
build_directory\ ``/conf/multiconfig/configA.conf``).
@@ -672,7 +672,7 @@ system and gives an overview of their function and contents.
BINCONFIG
When inheriting the
- ```binconfig-disabled`` <#ref-classes-binconfig-disabled>`__ class,
+ :ref:`binconfig-disabled ` class,
this variable specifies binary configuration scripts to disable in
favor of using ``pkg-config`` to query the information. The
``binconfig-disabled`` class will modify the specified scripts to
@@ -684,7 +684,7 @@ system and gives an overview of their function and contents.
${bindir}/libpng16-config"
BINCONFIG_GLOB
- When inheriting the ```binconfig`` <#ref-classes-binconfig>`__ class,
+ When inheriting the :ref:`binconfig ` class,
this variable specifies a wildcard for configuration scripts that
need editing. The scripts are edited to correct any paths that have
been set up during compilation so that they are correct for use when
@@ -708,7 +708,7 @@ system and gives an overview of their function and contents.
``meta/classes/binconfig.bbclass`` in the `Source
Directory <#source-directory>`__. You can also find general
information on the class in the
- "```binconfig.bbclass`` <#ref-classes-binconfig>`__" section.
+ ":ref:`binconfig.bbclass `" section.
BP
The base recipe name and version but without any special recipe name
@@ -716,12 +716,12 @@ system and gives an overview of their function and contents.
comprised of the following: ${BPN}-${PV}
BPN
- This variable is a version of the ```PN`` <#var-PN>`__ variable with
+ This variable is a version of the :term:`PN` variable with
common prefixes and suffixes removed, such as ``nativesdk-``,
``-cross``, ``-native``, and multilib's ``lib64-`` and ``lib32-``.
The exact lists of prefixes and suffixes removed are specified by the
- ```MLPREFIX`` <#var-MLPREFIX>`__ and
- ```SPECIAL_PKGSUFFIX`` <#var-SPECIAL_PKGSUFFIX>`__ variables,
+ :term:`MLPREFIX` and
+ :term:`SPECIAL_PKGSUFFIX` variables,
respectively.
BUGTRACKER
@@ -747,37 +747,37 @@ system and gives an overview of their function and contents.
Specifies the linker command to be used for the build host when the C
compiler is being used as the linker. By default, ``BUILD_CCLD``
points to GCC and passes as arguments the value of
- ```BUILD_CC_ARCH`` <#var-BUILD_CC_ARCH>`__, assuming
+ :term:`BUILD_CC_ARCH`, assuming
``BUILD_CC_ARCH`` is set.
BUILD_CFLAGS
Specifies the flags to pass to the C compiler when building for the
build host. When building in the ``-native`` context,
- ```CFLAGS`` <#var-CFLAGS>`__ is set to the value of this variable by
+ :term:`CFLAGS` is set to the value of this variable by
default.
BUILD_CPPFLAGS
Specifies the flags to pass to the C preprocessor (i.e. to both the C
and the C++ compilers) when building for the build host. When
- building in the ``-native`` context, ```CPPFLAGS`` <#var-CPPFLAGS>`__
+ building in the ``-native`` context, :term:`CPPFLAGS`
is set to the value of this variable by default.
BUILD_CXXFLAGS
Specifies the flags to pass to the C++ compiler when building for the
build host. When building in the ``-native`` context,
- ```CXXFLAGS`` <#var-CXXFLAGS>`__ is set to the value of this variable
+ :term:`CXXFLAGS` is set to the value of this variable
by default.
BUILD_FC
Specifies the Fortran compiler command for the build host. By
default, ``BUILD_FC`` points to Gfortran and passes as arguments the
- value of ```BUILD_CC_ARCH`` <#var-BUILD_CC_ARCH>`__, assuming
+ value of :term:`BUILD_CC_ARCH`, assuming
``BUILD_CC_ARCH`` is set.
BUILD_LD
Specifies the linker command for the build host. By default,
``BUILD_LD`` points to the GNU linker (ld) and passes as arguments
- the value of ```BUILD_LD_ARCH`` <#var-BUILD_LD_ARCH>`__, assuming
+ the value of :term:`BUILD_LD_ARCH`, assuming
``BUILD_LD_ARCH`` is set.
BUILD_LD_ARCH
@@ -787,14 +787,14 @@ system and gives an overview of their function and contents.
BUILD_LDFLAGS
Specifies the flags to pass to the linker when building for the build
host. When building in the ``-native`` context,
- ```LDFLAGS`` <#var-LDFLAGS>`__ is set to the value of this variable
+ :term:`LDFLAGS` is set to the value of this variable
by default.
BUILD_OPTIMIZATION
Specifies the optimization flags passed to the C compiler when
building for the build host or the SDK. The flags are passed through
- the ```BUILD_CFLAGS`` <#var-BUILD_CFLAGS>`__ and
- ```BUILDSDK_CFLAGS`` <#var-BUILDSDK_CFLAGS>`__ default values.
+ the :term:`BUILD_CFLAGS` and
+ :term:`BUILDSDK_CFLAGS` default values.
The default value of the ``BUILD_OPTIMIZATION`` variable is "-O2
-pipe".
@@ -808,14 +808,14 @@ system and gives an overview of their function and contents.
BUILD_PREFIX
The toolchain binary prefix used for native recipes. The OpenEmbedded
build system uses the ``BUILD_PREFIX`` value to set the
- ```TARGET_PREFIX`` <#var-TARGET_PREFIX>`__ when building for
+ :term:`TARGET_PREFIX` when building for
``native`` recipes.
BUILD_STRIP
Specifies the command to be used to strip debugging symbols from
binaries produced for the build host. By default, ``BUILD_STRIP``
points to
- ``${``\ ```BUILD_PREFIX`` <#var-BUILD_PREFIX>`__\ ``}strip``.
+ ``${``\ :term:`BUILD_PREFIX`\ ``}strip``.
BUILD_SYS
Specifies the system, including the architecture and the operating
@@ -823,9 +823,9 @@ system and gives an overview of their function and contents.
``native`` recipes).
The OpenEmbedded build system automatically sets this variable based
- on ```BUILD_ARCH`` <#var-BUILD_ARCH>`__,
- ```BUILD_VENDOR`` <#var-BUILD_VENDOR>`__, and
- ```BUILD_OS`` <#var-BUILD_OS>`__. You do not need to set the
+ on :term:`BUILD_ARCH`,
+ :term:`BUILD_VENDOR`, and
+ :term:`BUILD_OS`. You do not need to set the
``BUILD_SYS`` variable yourself.
BUILD_VENDOR
@@ -833,7 +833,7 @@ system and gives an overview of their function and contents.
The default value is an empty string ("").
BUILDDIR
- Points to the location of the `Build Directory <#build-directory>`__.
+ Points to the location of the :term:`Build Directory`.
You can define this directory indirectly through the
````` <#structure-core-script>`__ script by passing in a Build
Directory path when you run the script. If you run the script and do
@@ -841,7 +841,7 @@ system and gives an overview of their function and contents.
``build`` in the current directory.
BUILDHISTORY_COMMIT
- When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__
+ When inheriting the :ref:`buildhistory `
class, this variable specifies whether or not to commit the build
history output in a local Git repository. If set to "1", this local
repository will be maintained automatically by the ``buildhistory``
@@ -854,10 +854,10 @@ system and gives an overview of their function and contents.
history output in a local Git repository: BUILDHISTORY_COMMIT ?= "0"
BUILDHISTORY_COMMIT_AUTHOR
- When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__
+ When inheriting the :ref:`buildhistory `
class, this variable specifies the author to use for each Git commit.
In order for the ``BUILDHISTORY_COMMIT_AUTHOR`` variable to work, the
- ```BUILDHISTORY_COMMIT`` <#var-BUILDHISTORY_COMMIT>`__ variable must
+ :term:`BUILDHISTORY_COMMIT` variable must
be set to "1".
Git requires that the value you provide for the
@@ -869,7 +869,7 @@ system and gives an overview of their function and contents.
BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory "
BUILDHISTORY_DIR
- When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__
+ When inheriting the :ref:`buildhistory `
class, this variable specifies the directory in which build history
information is kept. For more information on how the variable works,
see the ``buildhistory.class``.
@@ -878,7 +878,7 @@ system and gives an overview of their function and contents.
BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory"
BUILDHISTORY_FEATURES
- When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__
+ When inheriting the :ref:`buildhistory `
class, this variable specifies the build history features to be
enabled. For more information on how build history works, see the
"`Maintaining Build Output
@@ -904,7 +904,7 @@ system and gives an overview of their function and contents.
features: BUILDHISTORY_FEATURES ?= "image package sdk"
BUILDHISTORY_IMAGE_FILES
- When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__
+ When inheriting the :ref:`buildhistory `
class, this variable specifies a list of paths to files copied from
the image contents into the build history directory under an
"image-files" directory in the directory for the image, so that you
@@ -918,11 +918,11 @@ system and gives an overview of their function and contents.
following files: BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group"
BUILDHISTORY_PUSH_REPO
- When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__
+ When inheriting the :ref:`buildhistory `
class, this variable optionally specifies a remote repository to
which build history pushes Git changes. In order for
``BUILDHISTORY_PUSH_REPO`` to work,
- ```BUILDHISTORY_COMMIT`` <#var-BUILDHISTORY_COMMIT>`__ must be set to
+ :term:`BUILDHISTORY_COMMIT` must be set to
"1".
The repository should correspond to a remote address that specifies a
@@ -936,33 +936,33 @@ system and gives an overview of their function and contents.
BUILDSDK_CFLAGS
Specifies the flags to pass to the C compiler when building for the
SDK. When building in the ``nativesdk-`` context,
- ```CFLAGS`` <#var-CFLAGS>`__ is set to the value of this variable by
+ :term:`CFLAGS` is set to the value of this variable by
default.
BUILDSDK_CPPFLAGS
Specifies the flags to pass to the C pre-processor (i.e. to both the
C and the C++ compilers) when building for the SDK. When building in
- the ``nativesdk-`` context, ```CPPFLAGS`` <#var-CPPFLAGS>`__ is set
+ the ``nativesdk-`` context, :term:`CPPFLAGS` is set
to the value of this variable by default.
BUILDSDK_CXXFLAGS
Specifies the flags to pass to the C++ compiler when building for the
SDK. When building in the ``nativesdk-`` context,
- ```CXXFLAGS`` <#var-CXXFLAGS>`__ is set to the value of this variable
+ :term:`CXXFLAGS` is set to the value of this variable
by default.
BUILDSDK_LDFLAGS
Specifies the flags to pass to the linker when building for the SDK.
When building in the ``nativesdk-`` context,
- ```LDFLAGS`` <#var-LDFLAGS>`__ is set to the value of this variable
+ :term:`LDFLAGS` is set to the value of this variable
by default.
BUILDSTATS_BASE
Points to the location of the directory that holds build statistics
when you use and enable the
- ```buildstats`` <#ref-classes-buildstats>`__ class. The
+ :ref:`buildstats ` class. The
``BUILDSTATS_BASE`` directory defaults to
- ``${``\ ```TMPDIR`` <#var-TMPDIR>`__\ ``}/buildstats/``.
+ ``${``\ :term:`TMPDIR`\ ``}/buildstats/``.
BUSYBOX_SPLIT_SUID
For the BusyBox recipe, specifies whether to split the output
@@ -976,7 +976,7 @@ system and gives an overview of their function and contents.
CACHE
Specifies the directory BitBake uses to store a cache of the
- `Metadata <#metadata>`__ so it does not need to be parsed every time
+ :term:`Metadata` so it does not need to be parsed every time
BitBake is started.
CC
@@ -990,21 +990,21 @@ system and gives an overview of their function and contents.
Default initialization for ``CFLAGS`` varies depending on what is
being built:
- - ```TARGET_CFLAGS`` <#var-TARGET_CFLAGS>`__ when building for the
+ - :term:`TARGET_CFLAGS` when building for the
target
- - ```BUILD_CFLAGS`` <#var-BUILD_CFLAGS>`__ when building for the
+ - :term:`BUILD_CFLAGS` when building for the
build host (i.e. ``-native``)
- - ```BUILDSDK_CFLAGS`` <#var-BUILDSDK_CFLAGS>`__ when building for
+ - :term:`BUILDSDK_CFLAGS` when building for
an SDK (i.e. ``nativesdk-``)
CLASSOVERRIDE
An internal variable specifying the special class override that
should currently apply (e.g. "class-target", "class-native", and so
forth). The classes that use this variable (e.g.
- ```native`` <#ref-classes-native>`__,
- ```nativesdk`` <#ref-classes-nativesdk>`__, and so forth) set the
+ :ref:`native `,
+ :ref:`nativesdk `, and so forth) set the
variable to appropriate values.
.. note::
@@ -1022,19 +1022,19 @@ system and gives an overview of their function and contents.
building for the build host: FOO_class-native = "native" FOO =
"other" The underlying mechanism behind ``CLASSOVERRIDE`` is simply
that it is included in the default value of
- ```OVERRIDES`` <#var-OVERRIDES>`__.
+ :term:`OVERRIDES`.
CLEANBROKEN
If set to "1" within a recipe, ``CLEANBROKEN`` specifies that the
``make clean`` command does not work for the software being built.
Consequently, the OpenEmbedded build system will not try to run
- ``make clean`` during the ```do_configure`` <#ref-tasks-configure>`__
+ ``make clean`` during the :ref:`ref-tasks-configure`
task, which is the default behavior.
COMBINED_FEATURES
Provides a list of hardware features that are enabled in both
- ```MACHINE_FEATURES`` <#var-MACHINE_FEATURES>`__ and
- ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__. This select list of
+ :term:`MACHINE_FEATURES` and
+ :term:`DISTRO_FEATURES`. This select list of
features contains features that make sense to be controlled both at
the machine and distribution configuration level. For example, the
"bluetooth" feature requires hardware support but should also be
@@ -1050,7 +1050,7 @@ system and gives an overview of their function and contents.
A regular expression that resolves to one or more hosts (when the
recipe is native) or one or more targets (when the recipe is
non-native) with which a recipe is compatible. The regular expression
- is matched against ```HOST_SYS`` <#var-HOST_SYS>`__. You can use the
+ is matched against :term:`HOST_SYS`. You can use the
variable to stop recipes from being built for classes of systems with
which the recipes are not compatible. Stopping these builds is
particularly useful with kernels. The variable also helps to increase
@@ -1060,7 +1060,7 @@ system and gives an overview of their function and contents.
COMPATIBLE_MACHINE
A regular expression that resolves to one or more target machines
with which a recipe is compatible. The regular expression is matched
- against ```MACHINEOVERRIDES`` <#var-MACHINEOVERRIDES>`__. You can use
+ against :term:`MACHINEOVERRIDES`. You can use
the variable to stop recipes from being built for machines with which
the recipes are not compatible. Stopping these builds is particularly
useful with kernels. The variable also helps to increase parsing
@@ -1084,7 +1084,7 @@ system and gives an overview of their function and contents.
The resulting list of complementary packages is associated with an
item that can be added to
- ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__. An example usage of
+ :term:`IMAGE_FEATURES`. An example usage of
this is the "dev-pkgs" item that when added to ``IMAGE_FEATURES``
will install -dev packages (containing headers and other development
files) for every package in the image.
@@ -1099,9 +1099,9 @@ system and gives an overview of their function and contents.
sysroots for other recipes.
The default is
- "``${``\ ```STAGING_DIR`` <#var-STAGING_DIR>`__\ ``}-components``."
+ "``${``\ :term:`STAGING_DIR`\ ``}-components``."
(i.e.
- "``${``\ ```TMPDIR`` <#var-TMPDIR>`__\ ``}/sysroots-components``").
+ "``${``\ :term:`TMPDIR`\ ``}/sysroots-components``").
CONF_VERSION
Tracks the version of the local configuration file (i.e.
@@ -1183,7 +1183,7 @@ system and gives an overview of their function and contents.
CONFLICT_DISTRO_FEATURES
When inheriting the
- ```distro_features_check`` <#ref-classes-distro_features_check>`__
+ :ref:`distro_features_check `
class, this variable identifies distribution features that would be
in conflict should the recipe be built. In other words, if the
``CONFLICT_DISTRO_FEATURES`` variable lists a feature that also
@@ -1192,9 +1192,9 @@ system and gives an overview of their function and contents.
COPYLEFT_LICENSE_EXCLUDE
A space-separated list of licenses to exclude from the source
- archived by the ```archiver`` <#ref-classes-archiver>`__ class. In
+ archived by the :ref:`archiver ` class. In
other words, if a license in a recipe's
- ```LICENSE`` <#var-LICENSE>`__ value is in the value of
+ :term:`LICENSE` value is in the value of
``COPYLEFT_LICENSE_EXCLUDE``, then its source is not archived by the
class.
@@ -1208,62 +1208,62 @@ system and gives an overview of their function and contents.
The default value, which is "CLOSED Proprietary", for
``COPYLEFT_LICENSE_EXCLUDE`` is set by the
- ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ class, which
+ :ref:`copyleft_filter ` class, which
is inherited by the ``archiver`` class.
COPYLEFT_LICENSE_INCLUDE
A space-separated list of licenses to include in the source archived
- by the ```archiver`` <#ref-classes-archiver>`__ class. In other
- words, if a license in a recipe's ```LICENSE`` <#var-LICENSE>`__
+ by the :ref:`archiver ` class. In other
+ words, if a license in a recipe's :term:`LICENSE`
value is in the value of ``COPYLEFT_LICENSE_INCLUDE``, then its
source is archived by the class.
The default value is set by the
- ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ class, which
+ :ref:`copyleft_filter ` class, which
is inherited by the ``archiver`` class. The default value includes
"GPL*", "LGPL*", and "AGPL*".
COPYLEFT_PN_EXCLUDE
A list of recipes to exclude in the source archived by the
- ```archiver`` <#ref-classes-archiver>`__ class. The
+ :ref:`archiver ` class. The
``COPYLEFT_PN_EXCLUDE`` variable overrides the license inclusion and
exclusion caused through the
- ```COPYLEFT_LICENSE_INCLUDE`` <#var-COPYLEFT_LICENSE_INCLUDE>`__ and
- ```COPYLEFT_LICENSE_EXCLUDE`` <#var-COPYLEFT_LICENSE_EXCLUDE>`__
+ :term:`COPYLEFT_LICENSE_INCLUDE` and
+ :term:`COPYLEFT_LICENSE_EXCLUDE`
variables, respectively.
The default value, which is "" indicating to not explicitly exclude
any recipes by name, for ``COPYLEFT_PN_EXCLUDE`` is set by the
- ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ class, which
+ :ref:`copyleft_filter ` class, which
is inherited by the ``archiver`` class.
COPYLEFT_PN_INCLUDE
A list of recipes to include in the source archived by the
- ```archiver`` <#ref-classes-archiver>`__ class. The
+ :ref:`archiver ` class. The
``COPYLEFT_PN_INCLUDE`` variable overrides the license inclusion and
exclusion caused through the
- ```COPYLEFT_LICENSE_INCLUDE`` <#var-COPYLEFT_LICENSE_INCLUDE>`__ and
- ```COPYLEFT_LICENSE_EXCLUDE`` <#var-COPYLEFT_LICENSE_EXCLUDE>`__
+ :term:`COPYLEFT_LICENSE_INCLUDE` and
+ :term:`COPYLEFT_LICENSE_EXCLUDE`
variables, respectively.
The default value, which is "" indicating to not explicitly include
any recipes by name, for ``COPYLEFT_PN_INCLUDE`` is set by the
- ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ class, which
+ :ref:`copyleft_filter ` class, which
is inherited by the ``archiver`` class.
COPYLEFT_RECIPE_TYPES
A space-separated list of recipe types to include in the source
- archived by the ```archiver`` <#ref-classes-archiver>`__ class.
+ archived by the :ref:`archiver ` class.
Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``,
``crosssdk``, and ``cross-canadian``.
The default value, which is "target*", for ``COPYLEFT_RECIPE_TYPES``
- is set by the ```copyleft_filter`` <#ref-classes-copyleft_filter>`__
+ is set by the :ref:`copyleft_filter `
class, which is inherited by the ``archiver`` class.
COPY_LIC_DIRS
If set to "1" along with the
- ```COPY_LIC_MANIFEST`` <#var-COPY_LIC_MANIFEST>`__ variable, the
+ :term:`COPY_LIC_MANIFEST` variable, the
OpenEmbedded build system copies into the image the license files,
which are located in ``/usr/share/common-licenses``, for each
package. The license files are placed in directories within the image
@@ -1304,7 +1304,7 @@ system and gives an overview of their function and contents.
CORE_IMAGE_EXTRA_INSTALL
Specifies the list of packages to be added to the image. You should
only set this variable in the ``local.conf`` configuration file found
- in the `Build Directory <#build-directory>`__.
+ in the :term:`Build Directory`.
This variable replaces ``POKY_EXTRA_INSTALL``, which is no longer
supported.
@@ -1321,7 +1321,7 @@ system and gives an overview of their function and contents.
the ``poky/meta`` layer.
COREBASE_FILES
- Lists files from the ```COREBASE`` <#var-COREBASE>`__ directory that
+ Lists files from the :term:`COREBASE` directory that
should be copied other than the layers listed in the
``bblayers.conf`` file. The ``COREBASE_FILES`` variable exists for
the purpose of copying metadata from the OpenEmbedded build system
@@ -1345,19 +1345,19 @@ system and gives an overview of their function and contents.
Default initialization for ``CPPFLAGS`` varies depending on what is
being built:
- - ```TARGET_CPPFLAGS`` <#var-TARGET_CPPFLAGS>`__ when building for
+ - :term:`TARGET_CPPFLAGS` when building for
the target
- - ```BUILD_CPPFLAGS`` <#var-BUILD_CPPFLAGS>`__ when building for the
+ - :term:`BUILD_CPPFLAGS` when building for the
build host (i.e. ``-native``)
- - ```BUILDSDK_CPPFLAGS`` <#var-BUILDSDK_CPPFLAGS>`__ when building
+ - :term:`BUILDSDK_CPPFLAGS` when building
for an SDK (i.e. ``nativesdk-``)
CROSS_COMPILE
The toolchain binary prefix for the target tools. The
``CROSS_COMPILE`` variable is the same as the
- ```TARGET_PREFIX`` <#var-TARGET_PREFIX>`__ variable.
+ :term:`TARGET_PREFIX` variable.
.. note::
@@ -1381,19 +1381,19 @@ system and gives an overview of their function and contents.
Default initialization for ``CXXFLAGS`` varies depending on what is
being built:
- - ```TARGET_CXXFLAGS`` <#var-TARGET_CXXFLAGS>`__ when building for
+ - :term:`TARGET_CXXFLAGS` when building for
the target
- - ```BUILD_CXXFLAGS`` <#var-BUILD_CXXFLAGS>`__ when building for the
+ - :term:`BUILD_CXXFLAGS` when building for the
build host (i.e. ``-native``)
- - ```BUILDSDK_CXXFLAGS`` <#var-BUILDSDK_CXXFLAGS>`__ when building
+ - :term:`BUILDSDK_CXXFLAGS` when building
for an SDK (i.e. ``nativesdk-``)
D
The destination directory. The location in the `Build
Directory <#build-directory>`__ where components are installed by the
- ```do_install`` <#ref-tasks-install>`__ task. This location defaults
+ :ref:`ref-tasks-install` task. This location defaults
to: ${WORKDIR}/image
.. note::
@@ -1411,7 +1411,7 @@ system and gives an overview of their function and contents.
suitable for timestamps.
DEBIAN_NOAUTONAME
- When the ```debian`` <#ref-classes-debian>`__ class is inherited,
+ When the :ref:`debian ` class is inherited,
which is the default behavior, ``DEBIAN_NOAUTONAME`` specifies a
particular package should not be renamed according to Debian library
package naming. You must use the package name as an override when you
@@ -1419,7 +1419,7 @@ system and gives an overview of their function and contents.
DEBIAN_NOAUTONAME_fontconfig-utils = "1"
DEBIANNAME
- When the ```debian`` <#ref-classes-debian>`__ class is inherited,
+ When the :ref:`debian ` class is inherited,
which is the default behavior, ``DEBIANNAME`` allows you to override
the library name for an individual package. Overriding the library
name in these cases is rare. You must use the package name as an
@@ -1457,12 +1457,12 @@ system and gives an overview of their function and contents.
The default CPU and Application Binary Interface (ABI) tunings (i.e.
the "tune") used by the OpenEmbedded build system. The
``DEFAULTTUNE`` helps define
- ```TUNE_FEATURES`` <#var-TUNE_FEATURES>`__.
+ :term:`TUNE_FEATURES`.
The default tune is either implicitly or explicitly set by the
- machine (```MACHINE`` <#var-MACHINE>`__). However, you can override
+ machine (:term:`MACHINE`). However, you can override
the setting using available tunes as defined with
- ```AVAILTUNES`` <#var-AVAILTUNES>`__.
+ :term:`AVAILTUNES`.
DEPENDS
Lists a recipe's build-time dependencies. These are dependencies on
@@ -1474,12 +1474,12 @@ system and gives an overview of their function and contents.
assignment is that all files installed by bar will be available in
the appropriate staging sysroot, given by the
```STAGING_DIR*`` <#var-STAGING_DIR>`__ variables, by the time the
- ```do_configure`` <#ref-tasks-configure>`__ task for ``foo`` runs.
+ :ref:`ref-tasks-configure` task for ``foo`` runs.
This mechanism is implemented by having ``do_configure`` depend on
- the ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task of
+ the :ref:`ref-tasks-populate_sysroot` task of
each recipe listed in ``DEPENDS``, through a
``[``\ ```deptask`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]``
- declaration in the ```base`` <#ref-classes-base>`__ class.
+ declaration in the :ref:`base ` class.
.. note::
@@ -1492,13 +1492,13 @@ system and gives an overview of their function and contents.
that run on the build machine during the build. For example, a recipe
that makes use of a code generator built by the recipe ``codegen``
might have the following: DEPENDS = "codegen-native" For more
- information, see the ```native`` <#ref-classes-native>`__ class and
- the ```EXTRANATIVEPATH`` <#var-EXTRANATIVEPATH>`__ variable.
+ information, see the :ref:`native ` class and
+ the :term:`EXTRANATIVEPATH` variable.
.. note::
- ``DEPENDS`` is a list of recipe names. Or, to be more precise,
- it is a list of ```PROVIDES`` <#var-PROVIDES>`__ names, which
+ it is a list of :term:`PROVIDES` names, which
usually match recipe names. Putting a package name such as
"foo-dev" in ``DEPENDS`` does not make sense. Use "foo"
instead, as this will put files from all the packages that make
@@ -1524,7 +1524,7 @@ system and gives an overview of their function and contents.
fail to link against ``libfoo``.
For information on runtime dependencies, see the
- ```RDEPENDS`` <#var-RDEPENDS>`__ variable. You can also see the
+ :term:`RDEPENDS` variable. You can also see the
"`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and
"`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the
BitBake User Manual for additional information on tasks and
@@ -1534,7 +1534,7 @@ system and gives an overview of their function and contents.
Points to the general area that the OpenEmbedded build system uses to
place images, packages, SDKs, and other output files that are ready
to be used outside of the build system. By default, this directory
- resides within the `Build Directory <#build-directory>`__ as
+ resides within the :term:`Build Directory` as
``${TMPDIR}/deploy``.
For more information on the structure of the Build Directory, see
@@ -1550,17 +1550,17 @@ system and gives an overview of their function and contents.
Points to the area that the OpenEmbedded build system uses to place
Debian packages that are ready to be used outside of the build
system. This variable applies only when
- ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ contains
+ :term:`PACKAGE_CLASSES` contains
"package_deb".
The BitBake configuration file initially defines the
``DEPLOY_DIR_DEB`` variable as a sub-folder of
- ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__: DEPLOY_DIR_DEB =
+ :term:`DEPLOY_DIR`: DEPLOY_DIR_DEB =
"${DEPLOY_DIR}/deb"
- The ```package_deb`` <#ref-classes-package_deb>`__ class uses the
+ The :ref:`package_deb ` class uses the
``DEPLOY_DIR_DEB`` variable to make sure the
- ```do_package_write_deb`` <#ref-tasks-package_write_deb>`__ task
+ :ref:`ref-tasks-package_write_deb` task
writes Debian packages into the appropriate folder. For more
information on how packaging works, see the "`Package
Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section
@@ -1571,7 +1571,7 @@ system and gives an overview of their function and contents.
images and other associated output files that are ready to be
deployed onto the target machine. The directory is machine-specific
as it contains the ``${MACHINE}`` name. By default, this directory
- resides within the `Build Directory <#build-directory>`__ as
+ resides within the :term:`Build Directory` as
``${DEPLOY_DIR}/images/${MACHINE}/``.
For more information on the structure of the Build Directory, see
@@ -1586,16 +1586,16 @@ system and gives an overview of their function and contents.
Points to the area that the OpenEmbedded build system uses to place
IPK packages that are ready to be used outside of the build system.
This variable applies only when
- ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ contains
+ :term:`PACKAGE_CLASSES` contains
"package_ipk".
The BitBake configuration file initially defines this variable as a
- sub-folder of ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__: DEPLOY_DIR_IPK =
+ sub-folder of :term:`DEPLOY_DIR`: DEPLOY_DIR_IPK =
"${DEPLOY_DIR}/ipk"
- The ```package_ipk`` <#ref-classes-package_ipk>`__ class uses the
+ The :ref:`package_ipk ` class uses the
``DEPLOY_DIR_IPK`` variable to make sure the
- ```do_package_write_ipk`` <#ref-tasks-package_write_ipk>`__ task
+ :ref:`ref-tasks-package_write_ipk` task
writes IPK packages into the appropriate folder. For more information
on how packaging works, see the "`Package
Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section
@@ -1605,16 +1605,16 @@ system and gives an overview of their function and contents.
Points to the area that the OpenEmbedded build system uses to place
RPM packages that are ready to be used outside of the build system.
This variable applies only when
- ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ contains
+ :term:`PACKAGE_CLASSES` contains
"package_rpm".
The BitBake configuration file initially defines this variable as a
- sub-folder of ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__: DEPLOY_DIR_RPM =
+ sub-folder of :term:`DEPLOY_DIR`: DEPLOY_DIR_RPM =
"${DEPLOY_DIR}/rpm"
- The ```package_rpm`` <#ref-classes-package_rpm>`__ class uses the
+ The :ref:`package_rpm ` class uses the
``DEPLOY_DIR_RPM`` variable to make sure the
- ```do_package_write_rpm`` <#ref-tasks-package_write_rpm>`__ task
+ :ref:`ref-tasks-package_write_rpm` task
writes RPM packages into the appropriate folder. For more information
on how packaging works, see the "`Package
Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section
@@ -1624,40 +1624,40 @@ system and gives an overview of their function and contents.
Points to the area that the OpenEmbedded build system uses to place
tarballs that are ready to be used outside of the build system. This
variable applies only when
- ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ contains
+ :term:`PACKAGE_CLASSES` contains
"package_tar".
The BitBake configuration file initially defines this variable as a
- sub-folder of ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__: DEPLOY_DIR_TAR =
+ sub-folder of :term:`DEPLOY_DIR`: DEPLOY_DIR_TAR =
"${DEPLOY_DIR}/tar"
- The ```package_tar`` <#ref-classes-package_tar>`__ class uses the
+ The :ref:`package_tar ` class uses the
``DEPLOY_DIR_TAR`` variable to make sure the
- ```do_package_write_tar`` <#ref-tasks-package_write_tar>`__ task
+ :ref:`ref-tasks-package_write_tar` task
writes TAR packages into the appropriate folder. For more information
on how packaging works, see the "`Package
Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section
in the Yocto Project Overview and Concepts Manual.
DEPLOYDIR
- When inheriting the ```deploy`` <#ref-classes-deploy>`__ class, the
+ When inheriting the :ref:`deploy ` class, the
``DEPLOYDIR`` points to a temporary work area for deployed files that
is set in the ``deploy`` class as follows: DEPLOYDIR =
- "${WORKDIR}/deploy-${```PN`` <#var-PN>`__}"
+ "${WORKDIR}/deploy-${:term:`PN`}"
Recipes inheriting the ``deploy`` class should copy files to be
deployed into ``DEPLOYDIR``, and the class will take care of copying
- them into ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__
+ them into :term:`DEPLOY_DIR_IMAGE`
afterwards.
DESCRIPTION
The package description used by package managers. If not set,
- ``DESCRIPTION`` takes the value of the ```SUMMARY`` <#var-SUMMARY>`__
+ ``DESCRIPTION`` takes the value of the :term:`SUMMARY`
variable.
DISTRO
The short name of the distribution. For information on the long name
- of the distribution, see the ```DISTRO_NAME`` <#var-DISTRO_NAME>`__
+ of the distribution, see the :term:`DISTRO_NAME`
variable.
The ``DISTRO`` variable corresponds to a distribution configuration
@@ -1671,7 +1671,7 @@ system and gives an overview of their function and contents.
follows: DISTRO = "poky"
Distribution configuration files are located in a ``conf/distro``
- directory within the `Metadata <#metadata>`__ that contains the
+ directory within the :term:`Metadata` that contains the
distribution configuration. The value for ``DISTRO`` must not contain
spaces, and is typically all lower-case.
@@ -1709,7 +1709,7 @@ system and gives an overview of their function and contents.
In most cases, the presence or absence of a feature in
``DISTRO_FEATURES`` is translated to the appropriate option supplied
to the configure script during the
- ```do_configure`` <#ref-tasks-configure>`__ task for recipes that
+ :ref:`ref-tasks-configure` task for recipes that
optionally support the feature. For example, specifying "x11" in
``DISTRO_FEATURES``, causes every piece of software built for the
target that can optionally support X11 to have its X11 support
@@ -1744,59 +1744,59 @@ system and gives an overview of their function and contents.
When creating a custom distribution, you might find it useful to be
able to reuse the default
- ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ options without the
+ :term:`DISTRO_FEATURES` options without the
need to write out the full set. Here is an example that uses
``DISTRO_FEATURES_DEFAULT`` from a custom distro configuration file:
DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} myfeature"
DISTRO_FEATURES_FILTER_NATIVE
Specifies a list of features that if present in the target
- ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ value should be
+ :term:`DISTRO_FEATURES` value should be
included in ``DISTRO_FEATURES`` when building native recipes. This
variable is used in addition to the features filtered using the
- ```DISTRO_FEATURES_NATIVE`` <#var-DISTRO_FEATURES_NATIVE>`__
+ :term:`DISTRO_FEATURES_NATIVE`
variable.
DISTRO_FEATURES_FILTER_NATIVESDK
Specifies a list of features that if present in the target
- ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ value should be
+ :term:`DISTRO_FEATURES` value should be
included in ``DISTRO_FEATURES`` when building nativesdk recipes. This
variable is used in addition to the features filtered using the
- ```DISTRO_FEATURES_NATIVESDK`` <#var-DISTRO_FEATURES_NATIVESDK>`__
+ :term:`DISTRO_FEATURES_NATIVESDK`
variable.
DISTRO_FEATURES_NATIVE
Specifies a list of features that should be included in
- ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ when building native
+ :term:`DISTRO_FEATURES` when building native
recipes. This variable is used in addition to the features filtered
using the
- ```DISTRO_FEATURES_FILTER_NATIVE`` <#var-DISTRO_FEATURES_FILTER_NATIVE>`__
+ :term:`DISTRO_FEATURES_FILTER_NATIVE`
variable.
DISTRO_FEATURES_NATIVESDK
Specifies a list of features that should be included in
- ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ when building
+ :term:`DISTRO_FEATURES` when building
nativesdk recipes. This variable is used in addition to the features
filtered using the
- ```DISTRO_FEATURES_FILTER_NATIVESDK`` <#var-DISTRO_FEATURES_FILTER_NATIVESDK>`__
+ :term:`DISTRO_FEATURES_FILTER_NATIVESDK`
variable.
DISTRO_NAME
The long name of the distribution. For information on the short name
- of the distribution, see the ```DISTRO`` <#var-DISTRO>`__ variable.
+ of the distribution, see the :term:`DISTRO` variable.
The ``DISTRO_NAME`` variable corresponds to a distribution
configuration file whose root name is the same as the variable's
argument and whose filename extension is ``.conf``. For example, the
distribution configuration file for the Poky distribution is named
``poky.conf`` and resides in the ``meta-poky/conf/distro`` directory
- of the `Source Directory <#source-directory>`__.
+ of the :term:`Source Directory`.
Within that ``poky.conf`` file, the ``DISTRO_NAME`` variable is set
as follows: DISTRO_NAME = "Poky (Yocto Project Reference Distro)"
Distribution configuration files are located in a ``conf/distro``
- directory within the `Metadata <#metadata>`__ that contains the
+ directory within the :term:`Metadata` that contains the
distribution configuration.
.. note::
@@ -1814,27 +1814,27 @@ system and gives an overview of their function and contents.
DISTROOVERRIDES
A colon-separated list of overrides specific to the current
distribution. By default, this list includes the value of
- ```DISTRO`` <#var-DISTRO>`__.
+ :term:`DISTRO`.
You can extend ``DISTROOVERRIDES`` to add extra overrides that should
apply to the distribution.
The underlying mechanism behind ``DISTROOVERRIDES`` is simply that it
is included in the default value of
- ```OVERRIDES`` <#var-OVERRIDES>`__.
+ :term:`OVERRIDES`.
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
- ```BB_GENERATE_MIRROR_TARBALLS`` <#var-BB_GENERATE_MIRROR_TARBALLS>`__
+ :term:`BB_GENERATE_MIRROR_TARBALLS`
variable.
You can set this directory by defining the ``DL_DIR`` variable in the
``conf/local.conf`` file. This directory is self-maintaining and you
should not have to touch it. By default, the directory is
- ``downloads`` in the `Build Directory <#build-directory>`__. #DL_DIR
+ ``downloads`` in the :term:`Build Directory`. #DL_DIR
?= "${TOPDIR}/downloads" To specify a different download directory,
simply remove the comment from the line and provide your directory.
@@ -1859,7 +1859,7 @@ system and gives an overview of their function and contents.
page.
DOC_COMPRESS
- When inheriting the ```compress_doc`` <#ref-classes-compress_doc>`__
+ When inheriting the :ref:`compress_doc `
class, this variable sets the compression policy used when the
OpenEmbedded build system compresses man pages and info pages. By
default, the compression method used is gz (gzip). Other policies
@@ -1870,12 +1870,12 @@ system and gives an overview of their function and contents.
EFI_PROVIDER
When building bootable images (i.e. where ``hddimg``, ``iso``, or
- ``wic.vmdk`` is in ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__), the
+ ``wic.vmdk`` is in :term:`IMAGE_FSTYPES`), the
``EFI_PROVIDER`` variable specifies the EFI bootloader to use. The
default is "grub-efi", but "systemd-boot" can be used instead.
- See the ```systemd-boot`` <#ref-classes-systemd-boot>`__ and
- ```image-live`` <#ref-classes-image-live>`__ classes for more
+ See the :ref:`systemd-boot ` and
+ :ref:`image-live ` classes for more
information.
ENABLE_BINARY_LOCALE_GENERATION
@@ -1884,13 +1884,13 @@ system and gives an overview of their function and contents.
less).
ERR_REPORT_DIR
- When used with the ```report-error`` <#ref-classes-report-error>`__
+ When used with the :ref:`report-error `
class, specifies the path used for storing the debug files created by
the `error reporting
tool <&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool>`__, which
allows you to submit build errors you encounter to a central
database. By default, the value of this variable is
- ``${``\ ```LOG_DIR`` <#var-LOG_DIR>`__\ ``}/error-report``.
+ ``${``\ :term:`LOG_DIR`\ ``}/error-report``.
You can set ``ERR_REPORT_DIR`` to the path you want the error
reporting tool to store the debug files as follows in your
@@ -1901,7 +1901,7 @@ system and gives an overview of their function and contents.
errors by the OpenEmbedded build system. You set this variable in
your distribution configuration file. For a list of the checks you
can control with this variable, see the
- "```insane.bbclass`` <#ref-classes-insane>`__" section.
+ ":ref:`insane.bbclass `" section.
EXCLUDE_FROM_SHLIBS
Triggers the OpenEmbedded build system's shared libraries resolver to
@@ -1918,7 +1918,7 @@ system and gives an overview of their function and contents.
implicitly define some dependencies between packages.
The ``EXCLUDE_FROM_SHLIBS`` variable is similar to the
- ```PRIVATE_LIBS`` <#var-PRIVATE_LIBS>`__ variable, which excludes a
+ :term:`PRIVATE_LIBS` variable, which excludes a
package's particular libraries only and not the whole package.
Use the ``EXCLUDE_FROM_SHLIBS`` variable by setting it to "1" for a
@@ -1945,13 +1945,13 @@ system and gives an overview of their function and contents.
EXTENDPE
Used with file and pathnames to create a prefix for a recipe's
- version based on the recipe's ```PE`` <#var-PE>`__ value. If ``PE``
+ version based on the recipe's :term:`PE` value. If ``PE``
is set and greater than zero for a recipe, ``EXTENDPE`` becomes that
value (e.g if ``PE`` is equal to "1" then ``EXTENDPE`` becomes "1_").
If a recipe's ``PE`` is not set (the default) or is equal to zero,
``EXTENDPE`` becomes "".
- See the ```STAMP`` <#var-STAMP>`__ variable for an example.
+ See the :term:`STAMP` variable for an example.
EXTENDPKGV
The full package version specification as it appears on the final
@@ -1971,43 +1971,43 @@ system and gives an overview of their function and contents.
any externally installed tools. Setting the ``EXTERNAL_KERNEL_TOOLS``
variable tells the OpenEmbedded build system to prefer the installed
external tools. See the
- ```kernel-yocto`` <#ref-classes-kernel-yocto>`__ class in
+ :ref:`kernel-yocto ` class in
``meta/classes`` to see how the variable is used.
EXTERNALSRC
- When inheriting the ```externalsrc`` <#ref-classes-externalsrc>`__
+ When inheriting the :ref:`externalsrc `
class, this variable points to the source tree, which is outside of
the OpenEmbedded build system. When set, this variable sets the
- ```S`` <#var-S>`__ variable, which is what the OpenEmbedded build
+ :term:`S` variable, which is what the OpenEmbedded build
system uses to locate unpacked recipe source code.
For more information on ``externalsrc.bbclass``, see the
- "```externalsrc.bbclass`` <#ref-classes-externalsrc>`__" section. You
+ ":ref:`externalsrc.bbclass `" section. You
can also find information on how to use this variable in the
"`Building Software from an External
Source <&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source>`__"
section in the Yocto Project Development Tasks Manual.
EXTERNALSRC_BUILD
- When inheriting the ```externalsrc`` <#ref-classes-externalsrc>`__
+ When inheriting the :ref:`externalsrc `
class, this variable points to the directory in which the recipe's
source code is built, which is outside of the OpenEmbedded build
- system. When set, this variable sets the ```B`` <#var-B>`__ variable,
+ system. When set, this variable sets the :term:`B` variable,
which is what the OpenEmbedded build system uses to locate the Build
Directory.
For more information on ``externalsrc.bbclass``, see the
- "```externalsrc.bbclass`` <#ref-classes-externalsrc>`__" section. You
+ ":ref:`externalsrc.bbclass `" section. You
can also find information on how to use this variable in the
"`Building Software from an External
Source <&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source>`__"
section in the Yocto Project Development Tasks Manual.
EXTRA_AUTORECONF
- For recipes inheriting the ```autotools`` <#ref-classes-autotools>`__
+ For recipes inheriting the :ref:`autotools `
class, you can use ``EXTRA_AUTORECONF`` to specify extra options to
pass to the ``autoreconf`` command that is executed during the
- ```do_configure`` <#ref-tasks-configure>`__ task.
+ :ref:`ref-tasks-configure` task.
The default value is "--exclude=autopoint".
@@ -2016,7 +2016,7 @@ system and gives an overview of their function and contents.
more than one feature, separate them with a space.
Typically, you configure this variable in your ``local.conf`` file,
- which is found in the `Build Directory <#build-directory>`__.
+ which is found in the :term:`Build Directory`.
Although you can use this variable from within a recipe, best
practices dictate that you do not.
@@ -2055,7 +2055,7 @@ system and gives an overview of their function and contents.
EXTRA_IMAGECMD
Specifies additional options for the image creation command that has
- been specified in ```IMAGE_CMD`` <#var-IMAGE_CMD>`__. When setting
+ been specified in :term:`IMAGE_CMD`. When setting
this variable, use an override for the associated image type. Here is
an example: EXTRA_IMAGECMD_ext3 ?= "-i 4096"
@@ -2080,7 +2080,7 @@ system and gives an overview of their function and contents.
EXTRANATIVEPATH
A list of subdirectories of
- ``${``\ ```STAGING_BINDIR_NATIVE`` <#var-STAGING_BINDIR_NATIVE>`__\ ``}``
+ ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}``
added to the beginning of the environment variable ``PATH``. As an
example, the following prepends
"${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" to
@@ -2088,11 +2088,11 @@ system and gives an overview of their function and contents.
EXTRA_OECMAKE
Additional `CMake `__ options. See the
- ```cmake`` <#ref-classes-cmake>`__ class for additional information.
+ :ref:`cmake ` class for additional information.
EXTRA_OECONF
Additional ``configure`` script options. See
- ```PACKAGECONFIG_CONFARGS`` <#var-PACKAGECONFIG_CONFARGS>`__ for
+ :term:`PACKAGECONFIG_CONFARGS` for
additional information on passing configure script options.
EXTRA_OEMAKE
@@ -2101,21 +2101,21 @@ system and gives an overview of their function and contents.
Because the ``EXTRA_OEMAKE`` defaults to "", you need to set the
variable to specify any required GNU options.
- ```PARALLEL_MAKE`` <#var-PARALLEL_MAKE>`__ and
- ```PARALLEL_MAKEINST`` <#var-PARALLEL_MAKEINST>`__ also make use of
+ :term:`PARALLEL_MAKE` and
+ :term:`PARALLEL_MAKEINST` also make use of
``EXTRA_OEMAKE`` to pass the required flags.
EXTRA_OESCONS
- When inheriting the ```scons`` <#ref-classes-scons>`__ class, this
+ When inheriting the :ref:`scons ` class, this
variable specifies additional configuration options you want to pass
to the ``scons`` command line.
EXTRA_USERS_PARAMS
- When inheriting the ```extrausers`` <#ref-classes-extrausers>`__
+ When inheriting the :ref:`extrausers `
class, this variable provides image level user and group operations.
This is a more global method of providing user and group
configuration as compared to using the
- ```useradd`` <#ref-classes-useradd>`__ class, which ties user and
+ :ref:`useradd ` class, which ties user and
group configurations to a specific recipe.
The set list of commands you can configure using the
@@ -2127,7 +2127,7 @@ system and gives an overview of their function and contents.
FEATURE_PACKAGES
Defines one or more packages to include in an image when a specific
- item is included in ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__.
+ item is included in :term:`IMAGE_FEATURES`.
When setting the value, ``FEATURE_PACKAGES`` should have the name of
the feature item as an override. Here is an example:
FEATURE_PACKAGES_widget = "package1 package2"
@@ -2161,7 +2161,7 @@ system and gives an overview of their function and contents.
FILES
The list of files and directories that are placed in a package. The
- ```PACKAGES`` <#var-PACKAGES>`__ variable lists the packages
+ :term:`PACKAGES` variable lists the packages
generated by a recipe.
To use the ``FILES`` variable, provide a package name override that
@@ -2183,7 +2183,7 @@ system and gives an overview of their function and contents.
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 `Source Directory <#source-directory>`__. You will also
+ the :term:`Source Directory`. You will also
find the default values of the various ``FILES_*`` variables in
this file.
@@ -2191,12 +2191,12 @@ system and gives an overview of their function and contents.
editable and you know they should not be overwritten during the
package update process by the Package Management System (PMS), you
can identify these files so that the PMS will not overwrite them. See
- the ```CONFFILES`` <#var-CONFFILES>`__ variable for information on
+ the :term:`CONFFILES` variable for information on
how to identify these files to the PMS.
FILES_SOLIBSDEV
Defines the file specification to match
- ```SOLIBSDEV`` <#var-SOLIBSDEV>`__. In other words,
+ :term:`SOLIBSDEV`. In other words,
``FILES_SOLIBSDEV`` defines the full path name of the development
symbolic link (symlink) for shared libraries on the target platform.
@@ -2208,7 +2208,7 @@ system and gives an overview of their function and contents.
Extends the search path the OpenEmbedded build system uses when
looking for files and patches as it processes recipes and append
files. The default directories BitBake uses when it processes recipes
- are initially defined by the ```FILESPATH`` <#var-FILESPATH>`__
+ are initially defined by the :term:`FILESPATH`
variable. You can extend ``FILESPATH`` variable by using
``FILESEXTRAPATHS``.
@@ -2223,7 +2223,7 @@ system and gives an overview of their function and contents.
When extending ``FILESEXTRAPATHS``, be sure to use the immediate
expansion (``:=``) operator. Immediate expansion makes sure that
- BitBake evaluates ```THISDIR`` <#var-THISDIR>`__ at the time the
+ BitBake evaluates :term:`THISDIR` at the time the
directive is encountered rather than at some later time when
expansion might result in a directory that does not contain the
files you need.
@@ -2242,14 +2242,14 @@ system and gives an overview of their function and contents.
FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:"
A final example shows how you can extend the search path and include
- a ```MACHINE`` <#var-MACHINE>`__-specific override, which is useful
+ a :term:`MACHINE`-specific override, which is useful
in a BSP layer: FILESEXTRAPATHS_prepend_intel-x86-common :=
"${THISDIR}/${PN}:" The previous statement appears in the
``linux-yocto-dev.bbappend`` file, which is found in the Yocto
Project `Source
Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ in
``meta-intel/common/recipes-kernel/linux``. Here, the machine
- override is a special ```PACKAGE_ARCH`` <#var-PACKAGE_ARCH>`__
+ override is a special :term:`PACKAGE_ARCH`
definition for multiple ``meta-intel`` machines.
.. note::
@@ -2264,12 +2264,12 @@ system and gives an overview of their function and contents.
recipe to correctly extend the path.
FILESOVERRIDES
- A subset of ```OVERRIDES`` <#var-OVERRIDES>`__ used by the
+ A subset of :term:`OVERRIDES` used by the
OpenEmbedded build system for creating
- ```FILESPATH`` <#var-FILESPATH>`__. The ``FILESOVERRIDES`` variable
+ :term:`FILESPATH`. The ``FILESOVERRIDES`` variable
uses overrides to automatically extend the
- ```FILESPATH`` <#var-FILESPATH>`__ variable. For an example of how
- that works, see the ```FILESPATH`` <#var-FILESPATH>`__ variable
+ :term:`FILESPATH` variable. For an example of how
+ that works, see the :term:`FILESPATH` variable
description. Additionally, you find more information on how overrides
are handled in the "`Conditional Syntax
(Overrides) <&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides>`__"
@@ -2293,7 +2293,7 @@ system and gives an overview of their function and contents.
During the build process, BitBake searches each directory in
``FILESPATH`` in the specified order when looking for files and
patches specified by each ``file://`` URI in a recipe's
- ```SRC_URI`` <#var-SRC_URI>`__ statements.
+ :term:`SRC_URI` statements.
The default value for the ``FILESPATH`` variable is defined in the
``base.bbclass`` class found in ``meta/classes`` in the `Source
@@ -2301,14 +2301,14 @@ system and gives an overview of their function and contents.
"${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \\
"${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" The
``FILESPATH`` variable is automatically extended using the overrides
- from the ```FILESOVERRIDES`` <#var-FILESOVERRIDES>`__ variable.
+ from the :term:`FILESOVERRIDES` variable.
.. note::
- Do not hand-edit the ``FILESPATH`` variable. If you want the
build system to look in directories other than the defaults,
extend the ``FILESPATH`` variable by using the
- ```FILESEXTRAPATHS`` <#var-FILESEXTRAPATHS>`__ variable.
+ :term:`FILESEXTRAPATHS` variable.
- Be aware that the default ``FILESPATH`` directories do not map
to directories in custom layers where append files
@@ -2323,7 +2323,7 @@ system and gives an overview of their function and contents.
files/defconfig files/MACHINEA/defconfig files/MACHINEB/defconfig
Also in the example, the ``SRC_URI`` statement contains
"file://defconfig". Given this scenario, you can set
- ```MACHINE`` <#var-MACHINE>`__ to "MACHINEA" and cause the build
+ :term:`MACHINE` to "MACHINEA" and cause the build
system to use files from ``files/MACHINEA``. Set ``MACHINE`` to
"MACHINEB" and the build system uses files from ``files/MACHINEB``.
Finally, for any machine other than "MACHINEA" and "MACHINEB", the
@@ -2334,7 +2334,7 @@ system and gives an overview of their function and contents.
in the Yocto Project Overview and Concepts Manual and the "`Patching
Code <&YOCTO_DOCS_DEV_URL;#new-recipe-patching-code>`__" section in
the Yocto Project Development Tasks Manual. See the
- ```do_patch`` <#ref-tasks-patch>`__ task as well.
+ :ref:`ref-tasks-patch` task as well.
FILESYSTEM_PERMS_TABLES
Allows you to define your own file permissions settings table as part
@@ -2354,7 +2354,7 @@ system and gives an overview of their function and contents.
Directory <#build-directory>`__, to point to your custom
``fs-perms.txt``. You can specify more than a single file permissions
setting table. The paths you specify to these files must be defined
- within the ```BBPATH`` <#var-BBPATH>`__ variable.
+ within the :term:`BBPATH` variable.
For guidance on how to create your own file permissions settings
table file, examine the existing ``fs-perms.txt``.
@@ -2367,16 +2367,16 @@ system and gives an overview of their function and contents.
For e.g. rsa2048.
FONT_EXTRA_RDEPENDS
- When inheriting the ```fontcache`` <#ref-classes-fontcache>`__ class,
+ When inheriting the :ref:`fontcache ` class,
this variable specifies the runtime dependencies for font packages.
By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils".
FONT_PACKAGES
- When inheriting the ```fontcache`` <#ref-classes-fontcache>`__ class,
+ When inheriting the :ref:`fontcache ` class,
this variable identifies packages containing font files that need to
be cached by Fontconfig. By default, the ``fontcache`` class assumes
that fonts are in the recipe's main package (i.e.
- ``${``\ ```PN`` <#var-PN>`__\ ``}``). Use this variable if fonts you
+ ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you
need are in a package other than that main package.
FORCE_RO_REMOVE
@@ -2429,7 +2429,7 @@ system and gives an overview of their function and contents.
"en_GB.UTF-8 en_US.UTF-8"
GROUPADD_PARAM
- When inheriting the ```useradd`` <#ref-classes-useradd>`__ class,
+ When inheriting the :ref:`useradd ` class,
this variable specifies for a package what parameters should be
passed to the ``groupadd`` command if you wish to add a group to the
system when the package is installed.
@@ -2439,7 +2439,7 @@ system and gives an overview of their function and contents.
``groupadd``, see ` `__.
GROUPMEMS_PARAM
- When inheriting the ```useradd`` <#ref-classes-useradd>`__ class,
+ When inheriting the :ref:`useradd ` class,
this variable specifies for a package what parameters should be
passed to the ``groupmems`` command if you wish to modify the members
of a group when the package is installed.
@@ -2453,7 +2453,7 @@ system and gives an overview of their function and contents.
``local.conf`` or distribution configuration file to enable graphics
and serial in the menu.
- See the ```grub-efi`` <#ref-classes-grub-efi>`__ class for more
+ See the :ref:`grub-efi ` class for more
information on how this variable is used.
GRUB_OPTS
@@ -2462,7 +2462,7 @@ system and gives an overview of their function and contents.
multiple options.
The ``GRUB_OPTS`` variable is optional. See the
- ```grub-efi`` <#ref-classes-grub-efi>`__ class for more information
+ :ref:`grub-efi ` class for more information
on how this variable is used.
GRUB_TIMEOUT
@@ -2470,12 +2470,12 @@ system and gives an overview of their function and contents.
GNU GRand Unified Bootloader (GRUB).
The ``GRUB_TIMEOUT`` variable is optional. See the
- ```grub-efi`` <#ref-classes-grub-efi>`__ class for more information
+ :ref:`grub-efi ` class for more information
on how this variable is used.
GTKIMMODULES_PACKAGES
When inheriting the
- ```gtk-immodules-cache`` <#ref-classes-gtk-immodules-cache>`__ class,
+ :ref:`gtk-immodules-cache ` class,
this variable specifies the packages that contain the GTK+ input
method modules being installed when the modules are in packages other
than the main package.
@@ -2486,7 +2486,7 @@ system and gives an overview of their function and contents.
HOST_ARCH
The name of the target architecture, which is normally the same as
- ```TARGET_ARCH`` <#var-TARGET_ARCH>`__. The OpenEmbedded build system
+ :term:`TARGET_ARCH`. The OpenEmbedded build system
supports many architectures. Here is an example list of architectures
supported. This list is by no means complete as the architecture is
configurable: arm i586 x86_64 powerpc powerpc64 mips mipsel
@@ -2498,7 +2498,7 @@ system and gives an overview of their function and contents.
Default initialization for ``HOST_CC_ARCH`` varies depending on what
is being built:
- - ```TARGET_CC_ARCH`` <#var-TARGET_CC_ARCH>`__ when building for the
+ - :term:`TARGET_CC_ARCH` when building for the
target
- ``BUILD_CC_ARCH`` when building for the build host (i.e.
@@ -2509,14 +2509,14 @@ system and gives an overview of their function and contents.
HOST_OS
Specifies the name of the target operating system, which is normally
- the same as the ```TARGET_OS`` <#var-TARGET_OS>`__. The variable can
+ the same as the :term:`TARGET_OS`. The variable can
be set to "linux" for ``glibc``-based systems and to "linux-musl" for
``musl``. For ARM/EABI targets, there are also "linux-gnueabi" and
"linux-musleabi" values possible.
HOST_PREFIX
Specifies the prefix for the cross-compile toolchain. ``HOST_PREFIX``
- is normally the same as ```TARGET_PREFIX`` <#var-TARGET_PREFIX>`__.
+ is normally the same as :term:`TARGET_PREFIX`.
HOST_SYS
Specifies the system, including the architecture and the operating
@@ -2524,9 +2524,9 @@ system and gives an overview of their function and contents.
current recipe.
The OpenEmbedded build system automatically sets this variable based
- on ```HOST_ARCH`` <#var-HOST_ARCH>`__,
- ```HOST_VENDOR`` <#var-HOST_VENDOR>`__, and
- ```HOST_OS`` <#var-HOST_OS>`__ variables.
+ on :term:`HOST_ARCH`,
+ :term:`HOST_VENDOR`, and
+ :term:`HOST_OS` variables.
.. note::
@@ -2549,25 +2549,25 @@ system and gives an overview of their function and contents.
is not started.
For additional information, see
- ```HOSTTOOLS_NONFATAL`` <#var-HOSTTOOLS_NONFATAL>`__.
+ :term:`HOSTTOOLS_NONFATAL`.
HOSTTOOLS_NONFATAL
A space-separated list (filter) of tools on the build host that
should be allowed to be called from within build tasks. Using this
filter helps reduce the possibility of host contamination. Unlike
- ```HOSTTOOLS`` <#var-HOSTTOOLS>`__, the OpenEmbedded build system
+ :term:`HOSTTOOLS`, the OpenEmbedded build system
does not produce an error if a tool specified in the value of
``HOSTTOOLS_NONFATAL`` is not found on the build host. Thus, you can
use ``HOSTTOOLS_NONFATAL`` to filter optional host tools.
HOST_VENDOR
Specifies the name of the vendor. ``HOST_VENDOR`` is normally the
- same as ```TARGET_VENDOR`` <#var-TARGET_VENDOR>`__.
+ same as :term:`TARGET_VENDOR`.
ICECC_DISABLED
Disables or enables the ``icecc`` (Icecream) function. For more
information on this function and best practices for using this
- variable, see the "```icecc.bbclass`` <#ref-classes-icecc>`__"
+ variable, see the ":ref:`icecc.bbclass `"
section.
Setting this variable to "1" in your ``local.conf`` disables the
@@ -2576,7 +2576,7 @@ system and gives an overview of their function and contents.
ICECC_ENV_EXEC
Points to the ``icecc-create-env`` script that you provide. This
- variable is used by the ```icecc`` <#ref-classes-icecc>`__ class. You
+ variable is used by the :ref:`icecc ` class. You
set this variable in your ``local.conf`` file.
If you do not point to a script that you provide, the OpenEmbedded
@@ -2586,7 +2586,7 @@ system and gives an overview of their function and contents.
ICECC_PARALLEL_MAKE
Extra options passed to the ``make`` command during the
- ```do_compile`` <#ref-tasks-compile>`__ task that specify parallel
+ :ref:`ref-tasks-compile` task that specify parallel
compilation. This variable usually takes the form of "-j x", where x
represents the maximum number of parallel threads ``make`` can run.
@@ -2602,7 +2602,7 @@ system and gives an overview of their function and contents.
performance could take some experimentation since machine speed,
network lag, available memory, and existing machine loads can all
affect build time. Consequently, unlike the
- ```PARALLEL_MAKE`` <#var-PARALLEL_MAKE>`__ variable, there is no
+ :term:`PARALLEL_MAKE` variable, there is no
rule-of-thumb for setting ``ICECC_PARALLEL_MAKE`` to achieve optimal
performance.
@@ -2613,13 +2613,13 @@ system and gives an overview of their function and contents.
ICECC_PATH
The location of the ``icecc`` binary. You can set this variable in
your ``local.conf`` file. If your ``local.conf`` file does not define
- this variable, the ```icecc`` <#ref-classes-icecc>`__ class attempts
+ this variable, the :ref:`icecc ` class attempts
to define it by locating ``icecc`` using ``which``.
ICECC_USER_CLASS_BL
Identifies user classes that you do not want the Icecream distributed
compile support to consider. This variable is used by the
- ```icecc`` <#ref-classes-icecc>`__ class. You set this variable in
+ :ref:`icecc ` class. You set this variable in
your ``local.conf`` file.
When you list classes using this variable, you are "blacklisting"
@@ -2629,7 +2629,7 @@ system and gives an overview of their function and contents.
ICECC_USER_PACKAGE_BL
Identifies user recipes that you do not want the Icecream distributed
compile support to consider. This variable is used by the
- ```icecc`` <#ref-classes-icecc>`__ class. You set this variable in
+ :ref:`icecc ` class. You set this variable in
your ``local.conf`` file.
When you list packages using this variable, you are "blacklisting"
@@ -2638,15 +2638,15 @@ system and gives an overview of their function and contents.
ICECC_USER_PACKAGE_WL
Identifies user recipes that use an empty
- ```PARALLEL_MAKE`` <#var-PARALLEL_MAKE>`__ variable that you want to
+ :term:`PARALLEL_MAKE` variable that you want to
force remote distributed compilation on using the Icecream
distributed compile support. This variable is used by the
- ```icecc`` <#ref-classes-icecc>`__ class. You set this variable in
+ :ref:`icecc ` class. You set this variable in
your ``local.conf`` file.
IMAGE_BASENAME
The base name of image output files. This variable defaults to the
- recipe name (``${``\ ```PN`` <#var-PN>`__\ ``}``).
+ recipe name (``${``\ :term:`PN`\ ``}``).
IMAGE_BOOT_FILES
A space-separated list of files installed into the boot partition
@@ -2656,7 +2656,7 @@ system and gives an overview of their function and contents.
installed under the same name as the source files. To change the
installed name, separate it from the original name with a semi-colon
(;). Source files need to be located in
- ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__. Here are two
+ :term:`DEPLOY_DIR_IMAGE`. Here are two
examples: IMAGE_BOOT_FILES = "u-boot.img uImage;kernel"
IMAGE_BOOT_FILES = "u-boot.${UBOOT_SUFFIX} ${KERNEL_IMAGETYPE}"
@@ -2687,12 +2687,12 @@ system and gives an overview of their function and contents.
configuration file.
For more information, see ``meta/classes/image_types.bbclass`` in the
- `Source Directory <#source-directory>`__.
+ :term:`Source Directory`.
IMAGE_CMD
Specifies the command to create the image file for a specific image
type, which corresponds to the value set set in
- ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__, (e.g. ``ext3``,
+ :term:`IMAGE_FSTYPES`, (e.g. ``ext3``,
``btrfs``, and so forth). When setting this variable, you should use
an override for the associated type. Here is an example:
IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \\ --faketime
@@ -2701,7 +2701,7 @@ system and gives an overview of their function and contents.
You typically do not need to set this variable unless you are adding
support for a new image type. For more examples on how to set this
- variable, see the ```image_types`` <#ref-classes-image_types>`__
+ variable, see the :ref:`image_types `
class file, which is ``meta/classes/image_types.bbclass``.
IMAGE_DEVICE_TABLES
@@ -2710,7 +2710,7 @@ system and gives an overview of their function and contents.
These files list basic device nodes that should be created under
``/dev`` within the image. If ``IMAGE_DEVICE_TABLES`` is not set,
``files/device_table-minimal.txt`` is used, which is located by
- ```BBPATH`` <#var-BBPATH>`__. For details on how you should write
+ :term:`BBPATH`. For details on how you should write
device table files, see ``meta/files/device_table-minimal.txt`` as an
example.
@@ -2744,7 +2744,7 @@ system and gives an overview of their function and contents.
IMAGE_FSTYPES = "ext3 tar.bz2"
For the complete list of supported image formats from which you can
- choose, see ```IMAGE_TYPES`` <#var-IMAGE_TYPES>`__.
+ choose, see :term:`IMAGE_TYPES`.
.. note::
@@ -2759,13 +2759,13 @@ system and gives an overview of their function and contents.
IMAGE_INSTALL
Used by recipes to specify the packages to install into an image
- through the ```image`` <#ref-classes-image>`__ class. Use the
+ through the :ref:`image ` class. Use the
``IMAGE_INSTALL`` variable with care to avoid ordering issues.
Image recipes set ``IMAGE_INSTALL`` to specify the packages to
install into an image through ``image.bbclass``. Additionally,
"helper" classes such as the
- ```core-image`` <#ref-classes-core-image>`__ class exist that can
+ :ref:`core-image ` class exist that can
take lists used with ``IMAGE_FEATURES`` and turn them into
auto-generated entries in ``IMAGE_INSTALL`` in addition to its
default contents.
@@ -2781,7 +2781,7 @@ system and gives an overview of their function and contents.
```core-image-minimal-initramfs`` <#images-core-image-minimal-initramfs>`__
image, do not use the ``IMAGE_INSTALL`` variable to specify
packages for installation. Instead, use the
- ```PACKAGE_INSTALL`` <#var-PACKAGE_INSTALL>`__ variable, which
+ :term:`PACKAGE_INSTALL` variable, which
allows the initial RAM filesystem (initramfs) recipe to use a
fixed set of packages and not be affected by ``IMAGE_INSTALL``.
For information on creating an initramfs, see the "`Building an
@@ -2820,7 +2820,7 @@ system and gives an overview of their function and contents.
only provide locale files by language and not by country-specific
language).
- See the ```GLIBC_GENERATE_LOCALES`` <#var-GLIBC_GENERATE_LOCALES>`__
+ See the :term:`GLIBC_GENERATE_LOCALES`
variable for information on generating GLIBC locales.
IMAGE_MANIFEST
@@ -2829,19 +2829,19 @@ system and gives an overview of their function and contents.
information on a line-per-package basis as follows: packagename
packagearch version
- The ```image`` <#ref-classes-image>`__ class defines the manifest
+ The :ref:`image ` class defines the manifest
file as follows: IMAGE_MANIFEST =
"${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest" The location is
- derived using the ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__
- and ```IMAGE_NAME`` <#var-IMAGE_NAME>`__ variables. You can find
+ derived using the :term:`DEPLOY_DIR_IMAGE`
+ and :term:`IMAGE_NAME` variables. You can find
information on how the image is created in the "`Image
Generation <&YOCTO_DOCS_OM_URL;#image-generation-dev-environment>`__"
section in the Yocto Project Overview and Concepts Manual.
IMAGE_NAME
The name of the output image files minus the extension. This variable
- is derived using the ```IMAGE_BASENAME`` <#var-IMAGE_BASENAME>`__,
- ```MACHINE`` <#var-MACHINE>`__, and ```DATETIME`` <#var-DATETIME>`__
+ is derived using the :term:`IMAGE_BASENAME`,
+ :term:`MACHINE`, and :term:`DATETIME`
variables: IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}"
IMAGE_OVERHEAD_FACTOR
@@ -2874,10 +2874,10 @@ system and gives an overview of their function and contents.
IMAGE_PKGTYPE
Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the
OpenEmbedded build system. The variable is defined appropriately by
- the ```package_deb`` <#ref-classes-package_deb>`__,
- ```package_rpm`` <#ref-classes-package_rpm>`__,
- ```package_ipk`` <#ref-classes-package_ipk>`__, or
- ```package_tar`` <#ref-classes-package_tar>`__ class.
+ the :ref:`package_deb `,
+ :ref:`package_rpm `,
+ :ref:`package_ipk `, or
+ :ref:`package_tar ` class.
.. note::
@@ -2887,13 +2887,13 @@ system and gives an overview of their function and contents.
do not use it.
The ```populate_sdk_*`` <#ref-classes-populate-sdk-*>`__ and
- ```image`` <#ref-classes-image>`__ classes use the ``IMAGE_PKGTYPE``
+ :ref:`image ` classes use the ``IMAGE_PKGTYPE``
for packaging up images and SDKs.
You should not set the ``IMAGE_PKGTYPE`` manually. Rather, the
variable is set indirectly through the appropriate
```package_*`` <#ref-classes-package>`__ class using the
- ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ variable. The
+ :term:`PACKAGE_CLASSES` variable. The
OpenEmbedded build system uses the first package type (e.g. DEB, RPM,
or IPK) that appears with the variable
@@ -2913,7 +2913,7 @@ system and gives an overview of their function and contents.
If you need to pass the root filesystem path to a command within the
function, you can use ``${IMAGE_ROOTFS}``, which points to the
directory that becomes the root filesystem image. See the
- ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more
+ :term:`IMAGE_ROOTFS` variable for more
information.
IMAGE_PREPROCESS_COMMAND
@@ -2925,19 +2925,19 @@ system and gives an overview of their function and contents.
If you need to pass the root filesystem path to a command within the
function, you can use ``${IMAGE_ROOTFS}``, which points to the
directory that becomes the root filesystem image. See the
- ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more
+ :term:`IMAGE_ROOTFS` variable for more
information.
IMAGE_ROOTFS
The location of the root filesystem while it is under construction
- (i.e. during the ```do_rootfs`` <#ref-tasks-rootfs>`__ task). This
+ (i.e. during the :ref:`ref-tasks-rootfs` task). This
variable is not configurable. Do not change it.
IMAGE_ROOTFS_ALIGNMENT
Specifies the alignment for the output image file in Kbytes. If the
size of the image is not a multiple of this value, then the size is
rounded up to the nearest multiple of the value. The default value is
- "1". See ```IMAGE_ROOTFS_SIZE`` <#var-IMAGE_ROOTFS_SIZE>`__ for
+ "1". See :term:`IMAGE_ROOTFS_SIZE` for
additional information.
IMAGE_ROOTFS_EXTRA_SPACE
@@ -2971,17 +2971,17 @@ system and gives an overview of their function and contents.
internal-rootfs-size = Initial root filesystem size before any
modifications. xspace = IMAGE_ROOTFS_EXTRA_SPACE
- See the ```IMAGE_OVERHEAD_FACTOR`` <#var-IMAGE_OVERHEAD_FACTOR>`__
- and ```IMAGE_ROOTFS_EXTRA_SPACE`` <#var-IMAGE_ROOTFS_EXTRA_SPACE>`__
+ See the :term:`IMAGE_OVERHEAD_FACTOR`
+ and :term:`IMAGE_ROOTFS_EXTRA_SPACE`
variables for related information.
IMAGE_TYPEDEP
Specifies a dependency from one image type on another. Here is an
- example from the ```image-live`` <#ref-classes-image-live>`__ class:
+ example from the :ref:`image-live ` class:
IMAGE_TYPEDEP_live = "ext3"
In the previous example, the variable ensures that when "live" is
- listed with the ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable,
+ listed with the :term:`IMAGE_FSTYPES` variable,
the OpenEmbedded build system produces an ``ext3`` image first since
one of the components of the live image is an ``ext3`` formatted
partition containing the root filesystem.
@@ -3005,7 +3005,7 @@ system and gives an overview of their function and contents.
Suppose, for example, you have a set of recipes that are used across
several projects. And, within each of those recipes the revision (its
- ```PR`` <#var-PR>`__ value) is set accordingly. In this case, when
+ :term:`PR` value) is set accordingly. In this case, when
the revision of those recipes changes, the burden is on you to find
all those recipes and be sure that they get changed to reflect the
updated version of the recipe. In this scenario, it can get
@@ -3034,7 +3034,7 @@ system and gives an overview of their function and contents.
INCOMPATIBLE_LICENSE
Specifies a space-separated list of license names (as they would
- appear in ```LICENSE`` <#var-LICENSE>`__) that should be excluded
+ appear in :term:`LICENSE`) that should be excluded
from the build. Recipes that provide no alternatives to listed
incompatible licenses are not built. Packages that are individually
licensed with the specified incompatible licenses will be deleted.
@@ -3095,7 +3095,7 @@ system and gives an overview of their function and contents.
INHIBIT_DEFAULT_DEPS
Prevents the default dependencies, namely the C compiler and standard
- C library (libc), from being added to ```DEPENDS`` <#var-DEPENDS>`__.
+ C library (libc), from being added to :term:`DEPENDS`.
This variable is usually used within recipes that do not require any
compilation using the C compiler.
@@ -3106,9 +3106,9 @@ system and gives an overview of their function and contents.
Prevents the OpenEmbedded build system from splitting out debug
information during packaging. By default, the build system splits out
debugging information during the
- ```do_package`` <#ref-tasks-package>`__ task. For more information on
+ :ref:`ref-tasks-package` task. For more information on
how debug information is split out, see the
- ```PACKAGE_DEBUG_SPLIT_STYLE`` <#var-PACKAGE_DEBUG_SPLIT_STYLE>`__
+ :term:`PACKAGE_DEBUG_SPLIT_STYLE`
variable.
To prevent the build system from splitting out debug information
@@ -3121,7 +3121,7 @@ system and gives an overview of their function and contents.
files.
By default, the OpenEmbedded build system strips binaries and puts
- the debugging symbols into ``${``\ ```PN`` <#var-PN>`__\ ``}-dbg``.
+ the debugging symbols into ``${``\ :term:`PN`\ ``}-dbg``.
Consequently, you should not set ``INHIBIT_PACKAGE_STRIP`` when you
plan to debug in general.
@@ -3135,7 +3135,7 @@ system and gives an overview of their function and contents.
this stripping.
If you want to use this variable, include the
- ```staging`` <#ref-classes-staging>`__ class. This class uses a
+ :ref:`staging ` class. This class uses a
``sys_strip()`` function to test for the variable and acts
accordingly.
@@ -3153,7 +3153,7 @@ system and gives an overview of their function and contents.
Defines the format for the output image of an initial RAM filesystem
(initramfs), which is used during boot. Supported formats are the
same as those supported by the
- ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable.
+ :term:`IMAGE_FSTYPES` variable.
The default value of this variable, which is set in the
``meta/conf/bitbake.conf`` configuration file in the `Source
@@ -3163,14 +3163,14 @@ system and gives an overview of their function and contents.
an optionally compressed cpio archive.
INITRAMFS_IMAGE
- Specifies the ```PROVIDES`` <#var-PROVIDES>`__ name of an image
+ Specifies the :term:`PROVIDES` name of an image
recipe that is used to build an initial RAM filesystem (initramfs)
image. In other words, the ``INITRAMFS_IMAGE`` variable causes an
additional recipe to be built as a dependency to whatever root
filesystem recipe you might be using (e.g. ``core-image-sato``). The
initramfs image recipe you provide should set
- ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ to
- ```INITRAMFS_FSTYPES`` <#var-INITRAMFS_FSTYPES>`__.
+ :term:`IMAGE_FSTYPES` to
+ :term:`INITRAMFS_FSTYPES`.
An initramfs image provides a temporary root filesystem used for
early system initialization (e.g. loading of modules needed to locate
@@ -3189,15 +3189,15 @@ system and gives an overview of their function and contents.
You can also find more information by referencing the
``meta-poky/conf/local.conf.sample.extended`` configuration file in
- the Source Directory, the ```image`` <#ref-classes-image>`__ class,
- and the ```kernel`` <#ref-classes-kernel>`__ class to see how to use
+ the Source Directory, the :ref:`image ` class,
+ and the :ref:`kernel ` class to see how to use
the ``INITRAMFS_IMAGE`` variable.
If ``INITRAMFS_IMAGE`` is empty, which is the default, then no
initramfs image is built.
For more information, you can also see the
- ```INITRAMFS_IMAGE_BUNDLE`` <#var-INITRAMFS_IMAGE_BUNDLE>`__
+ :term:`INITRAMFS_IMAGE_BUNDLE`
variable, which allows the generated image to be bundled inside the
kernel image. Additionally, for information on creating an initramfs
image, see the "`Building an Initial RAM Filesystem (initramfs)
@@ -3206,13 +3206,13 @@ system and gives an overview of their function and contents.
INITRAMFS_IMAGE_BUNDLE
Controls whether or not the image recipe specified by
- ```INITRAMFS_IMAGE`` <#var-INITRAMFS_IMAGE>`__ is run through an
+ :term:`INITRAMFS_IMAGE` is run through an
extra pass
- (```do_bundle_initramfs`` <#ref-tasks-bundle_initramfs>`__) during
+ (:ref:`ref-tasks-bundle_initramfs`) during
kernel compilation in order to build a single binary that contains
both the kernel image and the initial RAM filesystem (initramfs)
image. This makes use of the
- ```CONFIG_INITRAMFS_SOURCE`` <#var-CONFIG_INITRAMFS_SOURCE>`__ kernel
+ :term:`CONFIG_INITRAMFS_SOURCE` kernel
feature.
.. note::
@@ -3225,13 +3225,13 @@ system and gives an overview of their function and contents.
since the initramfs is bundled inside the kernel image.
The combined binary is deposited into the ``tmp/deploy`` directory,
- which is part of the `Build Directory <#build-directory>`__.
+ which is part of the :term:`Build Directory`.
Setting the variable to "1" in a configuration file causes the
OpenEmbedded build system to generate a kernel image with the
initramfs specified in ``INITRAMFS_IMAGE`` bundled within:
INITRAMFS_IMAGE_BUNDLE = "1" By default, the
- ```kernel`` <#ref-classes-kernel>`__ class sets this variable to a
+ :ref:`kernel ` class sets this variable to a
null string as follows: INITRAMFS_IMAGE_BUNDLE ?= ""
.. note::
@@ -3257,14 +3257,14 @@ system and gives an overview of their function and contents.
file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?=
"${MACHINE}"
- See the ```MACHINE`` <#var-MACHINE>`__ variable for additional
+ See the :term:`MACHINE` variable for additional
information.
INITRAMFS_NAME
The base name of the initial RAM filesystem image. This variable is
set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
follows: INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" The
- value of the ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__
+ value of the :term:`KERNEL_ARTIFACT_NAME`
variable, which is set in the same file, has the following value:
KERNEL_ARTIFACT_NAME ?=
"${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
@@ -3274,16 +3274,16 @@ system and gives an overview of their function and contents.
initial RAM disk (``initrd``).
The ``INITRD`` variable is an optional variable used with the
- ```image-live`` <#ref-classes-image-live>`__ class.
+ :ref:`image-live ` class.
INITRD_IMAGE
When building a "live" bootable image (i.e. when
- ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ contains "live"),
+ :term:`IMAGE_FSTYPES` contains "live"),
``INITRD_IMAGE`` specifies the image recipe that should be built to
provide the initial RAM disk image. The default value is
"core-image-minimal-initramfs".
- See the ```image-live`` <#ref-classes-image-live>`__ class for more
+ See the :ref:`image-live ` class for more
information.
INITSCRIPT_NAME
@@ -3299,7 +3299,7 @@ system and gives an overview of their function and contents.
``INITSCRIPT_*`` as an override.
This variable is used in recipes when using ``update-rc.d.bbclass``.
- The variable is optional and defaults to the ```PN`` <#var-PN>`__
+ The variable is optional and defaults to the :term:`PN`
variable.
INITSCRIPT_PARAMS
@@ -3310,7 +3310,7 @@ system and gives an overview of their function and contents.
in initlevels 2 and 5, and stops the script in levels 0, 1 and 6.
The variable's default value is "defaults", which is set in the
- ```update-rc.d`` <#ref-classes-update-rc.d>`__ class.
+ :ref:`update-rc.d ` class.
The value in ``INITSCRIPT_PARAMS`` is passed through to the
``update-rc.d`` command. For more information on valid parameters,
@@ -3324,7 +3324,7 @@ system and gives an overview of their function and contents.
recipe. The package name override must be used, which in this example
is ``${PN}``: INSANE_SKIP_${PN} += "dev-so"
- See the "```insane.bbclass`` <#ref-classes-insane>`__" section for a
+ See the ":ref:`insane.bbclass `" section for a
list of the valid QA checks you can specify using this variable.
INSTALL_TIMEZONE_FILE
@@ -3376,7 +3376,7 @@ system and gives an overview of their function and contents.
BSP.
KBUILD_DEFCONFIG
- When used with the ```kernel-yocto`` <#ref-classes-kernel-yocto>`__
+ When used with the :ref:`kernel-yocto `
class, specifies an "in-tree" kernel configuration file for use
during a kernel build.
@@ -3386,7 +3386,7 @@ system and gives an overview of their function and contents.
"out-of-tree"). However, if you want to use a ``defconfig`` file that
is part of the kernel tree (i.e. "in-tree"), you can use the
``KBUILD_DEFCONFIG`` variable and append the
- ```KMACHINE`` <#var-KMACHINE>`__ variable to point to the
+ :term:`KMACHINE` variable to point to the
``defconfig`` file.
To use the variable, set it in the append file for your kernel recipe
@@ -3404,7 +3404,7 @@ system and gives an overview of their function and contents.
KERNEL_ALT_IMAGETYPE
Specifies an alternate kernel image type for creation in addition to
the kernel image type specified using the
- ```KERNEL_IMAGETYPE`` <#var-KERNEL_IMAGETYPE>`__ variable.
+ :term:`KERNEL_IMAGETYPE` variable.
KERNEL_ARTIFACT_NAME
Specifies the name of all of the build artifacts. You can change the
@@ -3416,8 +3416,8 @@ system and gives an overview of their function and contents.
following default value: KERNEL_ARTIFACT_NAME ?=
"${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
- See the ```PKGE`` <#var-PKGE>`__, ```PKGV`` <#var-PKGV>`__,
- ```PKGR`` <#var-PKGR>`__, and ```MACHINE`` <#var-MACHINE>`__
+ See the :term:`PKGE`, :term:`PKGV`,
+ :term:`PKGR`, and :term:`MACHINE`
variables for additional information.
.. note::
@@ -3430,7 +3430,7 @@ system and gives an overview of their function and contents.
KERNEL_CLASSES
A list of classes defining kernel image types that the
- ```kernel`` <#ref-classes-kernel>`__ class should inherit. You
+ :ref:`kernel ` class should inherit. You
typically append this variable to enable extended image types. An
example is the "kernel-fitimage", which enables fitImage support and
resides in ``meta/classes/kernel-fitimage.bbclass``. You can register
@@ -3449,7 +3449,7 @@ system and gives an overview of their function and contents.
file is preferred.
In order to use this variable, the
- ```kernel-devicetree`` <#ref-classes-kernel-devicetree>`__ class must
+ :ref:`kernel-devicetree ` class must
be inherited.
KERNEL_DTB_LINK_NAME
@@ -3460,14 +3460,14 @@ system and gives an overview of their function and contents.
the same file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?=
"${MACHINE}"
- See the ```MACHINE`` <#var-MACHINE>`__ variable for additional
+ See the :term:`MACHINE` variable for additional
information.
KERNEL_DTB_NAME
The base name of the kernel device tree binary (DTB). This variable
is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
follows: KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" The value of
- the ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__
+ the :term:`KERNEL_ARTIFACT_NAME`
variable, which is set in the same file, has the following value:
KERNEL_ARTIFACT_NAME ?=
"${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
@@ -3479,8 +3479,8 @@ system and gives an overview of their function and contents.
KERNEL_FEATURES
Includes additional kernel metadata. In the OpenEmbedded build
system, the default Board Support Packages (BSPs)
- `Metadata <#metadata>`__ is provided through the
- ```KMACHINE`` <#var-KMACHINE>`__ and ```KBRANCH`` <#var-KBRANCH>`__
+ :term:`Metadata` is provided through the
+ :term:`KMACHINE` and :term:`KBRANCH`
variables. You can use the ``KERNEL_FEATURES`` variable from within
the kernel recipe or kernel append file to further add metadata for
all BSPs or specific BSPs.
@@ -3511,14 +3511,14 @@ system and gives an overview of their function and contents.
file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?=
"${MACHINE}"
- See the ```MACHINE`` <#var-MACHINE>`__ variable for additional
+ See the :term:`MACHINE` variable for additional
information.
KERNEL_FIT_NAME
The base name of the kernel flattened image tree (FIT) image. This
variable is set in the ``meta/classes/kernel-artifact-names.bbclass``
file as follows: KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" The
- value of the ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__
+ value of the :term:`KERNEL_ARTIFACT_NAME`
variable, which is set in the same file, has the following value:
KERNEL_ARTIFACT_NAME ?=
"${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
@@ -3531,14 +3531,14 @@ system and gives an overview of their function and contents.
file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?=
"${MACHINE}"
- See the ```MACHINE`` <#var-MACHINE>`__ variable for additional
+ See the :term:`MACHINE` variable for additional
information.
KERNEL_IMAGE_MAXSIZE
Specifies the maximum size of the kernel image file in kilobytes. If
``KERNEL_IMAGE_MAXSIZE`` is set, the size of the kernel image file is
checked against the set value during the
- ```do_sizecheck`` <#ref-tasks-sizecheck>`__ task. The task fails if
+ :ref:`ref-tasks-sizecheck` task. The task fails if
the kernel image file is larger than the setting.
``KERNEL_IMAGE_MAXSIZE`` is useful for target devices that have a
@@ -3551,7 +3551,7 @@ system and gives an overview of their function and contents.
The base name of the kernel image. This variable is set in the
``meta/classes/kernel-artifact-names.bbclass`` file as follows:
KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}" The value of the
- ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__ variable,
+ :term:`KERNEL_ARTIFACT_NAME` variable,
which is set in the same file, has the following value:
KERNEL_ARTIFACT_NAME ?=
"${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
@@ -3563,7 +3563,7 @@ system and gives an overview of their function and contents.
build.
If you want to build an alternate kernel image type, use the
- ```KERNEL_ALT_IMAGETYPE`` <#var-KERNEL_ALT_IMAGETYPE>`__ variable.
+ :term:`KERNEL_ALT_IMAGETYPE` variable.
KERNEL_MODULE_AUTOLOAD
Lists kernel modules that need to be auto-loaded during boot.
@@ -3591,7 +3591,7 @@ system and gives an overview of their function and contents.
For information on how to populate the ``modname.conf`` file with
``modprobe.d`` syntax lines, see the
- ```KERNEL_MODULE_PROBECONF`` <#var-KERNEL_MODULE_PROBECONF>`__
+ :term:`KERNEL_MODULE_PROBECONF`
variable.
KERNEL_MODULE_PROBECONF
@@ -3603,29 +3603,29 @@ system and gives an overview of their function and contents.
KERNEL_PATH
The location of the kernel sources. This variable is set to the value
- of the ```STAGING_KERNEL_DIR`` <#var-STAGING_KERNEL_DIR>`__ within
- the ```module`` <#ref-classes-module>`__ class. For information on
+ of the :term:`STAGING_KERNEL_DIR` within
+ the :ref:`module ` class. For information on
how this variable is used, see the "`Incorporating Out-of-Tree
Modules <&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules>`__"
section in the Yocto Project Linux Kernel Development Manual.
To help maximize compatibility with out-of-tree drivers used to build
modules, the OpenEmbedded build system also recognizes and uses the
- ```KERNEL_SRC`` <#var-KERNEL_SRC>`__ variable, which is identical to
+ :term:`KERNEL_SRC` variable, which is identical to
the ``KERNEL_PATH`` variable. Both variables are common variables
used by external Makefiles to point to the kernel source directory.
KERNEL_SRC
The location of the kernel sources. This variable is set to the value
- of the ```STAGING_KERNEL_DIR`` <#var-STAGING_KERNEL_DIR>`__ within
- the ```module`` <#ref-classes-module>`__ class. For information on
+ of the :term:`STAGING_KERNEL_DIR` within
+ the :ref:`module ` class. For information on
how this variable is used, see the "`Incorporating Out-of-Tree
Modules <&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules>`__"
section in the Yocto Project Linux Kernel Development Manual.
To help maximize compatibility with out-of-tree drivers used to build
modules, the OpenEmbedded build system also recognizes and uses the
- ```KERNEL_PATH`` <#var-KERNEL_PATH>`__ variable, which is identical
+ :term:`KERNEL_PATH` variable, which is identical
to the ``KERNEL_SRC`` variable. Both variables are common variables
used by external Makefiles to point to the kernel source directory.
@@ -3638,7 +3638,7 @@ system and gives an overview of their function and contents.
KERNELDEPMODDEPEND
Specifies whether the data referenced through
- ```PKGDATA_DIR`` <#var-PKGDATA_DIR>`__ is needed or not. The
+ :term:`PKGDATA_DIR` is needed or not. The
``KERNELDEPMODDEPEND`` does not control whether or not that data
exists, but simply whether or not it is used. If you do not need to
use the data, set the ``KERNELDEPMODDEPEND`` variable in your
@@ -3690,13 +3690,13 @@ system and gives an overview of their function and contents.
You define the ``KTYPE`` variable in the `BSP
Descriptions <&YOCTO_DOCS_KERNEL_DEV_URL;#bsp-descriptions>`__. The
value you use must match the value used for the
- ```LINUX_KERNEL_TYPE`` <#var-LINUX_KERNEL_TYPE>`__ value used by the
+ :term:`LINUX_KERNEL_TYPE` value used by the
kernel recipe.
LABELS
Provides a list of targets for automatic configuration.
- See the ```grub-efi`` <#ref-classes-grub-efi>`__ class for more
+ See the :ref:`grub-efi ` class for more
information on how this variable is used.
LAYERDEPENDS
@@ -3705,7 +3705,7 @@ system and gives an overview of their function and contents.
by adding it to the end of the layer name. Here is an example:
LAYERDEPENDS_mylayer = "anotherlayer (=3)" In this previous example,
version 3 of "anotherlayer" is compared against
- ```LAYERVERSION`` <#var-LAYERVERSION>`__\ ``_anotherlayer``.
+ :term:`LAYERVERSION`\ ``_anotherlayer``.
An error is produced if any dependency is missing or the version
numbers (if specified) do not match exactly. This variable is used in
@@ -3733,7 +3733,7 @@ system and gives an overview of their function and contents.
``LAYERRECOMMENDS_mylayer``).
LAYERSERIES_COMPAT
- Lists the versions of the `OpenEmbedded-Core <#oe-core>`__ for which
+ Lists the versions of the :term:`OpenEmbedded-Core (OE-Core)` for which
a layer is compatible. Using the ``LAYERSERIES_COMPAT`` variable
allows the layer maintainer to indicate which combinations of the
layer and OE-Core can be expected to work. The variable gives the
@@ -3762,7 +3762,7 @@ system and gives an overview of their function and contents.
LAYERVERSION
Optionally specifies the version of a layer as a single number. You
- can use this within ```LAYERDEPENDS`` <#var-LAYERDEPENDS>`__ for
+ can use this within :term:`LAYERDEPENDS` for
another layer in order to depend on a specific version of the layer.
This variable is used in the ``conf/layer.conf`` file and must be
suffixed with the name of the specific layer (e.g.
@@ -3779,18 +3779,18 @@ system and gives an overview of their function and contents.
Default initialization for ``LDFLAGS`` varies depending on what is
being built:
- - ```TARGET_LDFLAGS`` <#var-TARGET_LDFLAGS>`__ when building for the
+ - :term:`TARGET_LDFLAGS` when building for the
target
- - ```BUILD_LDFLAGS`` <#var-BUILD_LDFLAGS>`__ when building for the
+ - :term:`BUILD_LDFLAGS` when building for the
build host (i.e. ``-native``)
- - ```BUILDSDK_LDFLAGS`` <#var-BUILDSDK_LDFLAGS>`__ when building for
+ - :term:`BUILDSDK_LDFLAGS` when building for
an SDK (i.e. ``nativesdk-``)
LEAD_SONAME
Specifies the lead (or primary) compiled library file (i.e. ``.so``)
- that the ```debian`` <#ref-classes-debian>`__ class applies its
+ that the :ref:`debian ` class applies its
naming policy to given a recipe that packages multiple libraries.
This variable works in conjunction with the ``debian`` class.
@@ -3804,7 +3804,7 @@ system and gives an overview of their function and contents.
license change.
This variable must be defined for all recipes (unless
- ```LICENSE`` <#var-LICENSE>`__ is set to "CLOSED").
+ :term:`LICENSE` is set to "CLOSED").
For more information, see the "`Tracking License
Changes <&YOCTO_DOCS_DEV_URL;#usingpoky-configuring-LIC_FILES_CHKSUM>`__"
@@ -3825,7 +3825,7 @@ system and gives an overview of their function and contents.
- For standard licenses, use the names of the files in
``meta/files/common-licenses/`` or the
- ```SPDXLICENSEMAP`` <#var-SPDXLICENSEMAP>`__ flag names defined in
+ :term:`SPDXLICENSEMAP` flag names defined in
``meta/conf/licenses.conf``.
Here are some examples: LICENSE = "LGPLv2.1 \| GPLv3" LICENSE =
@@ -3847,34 +3847,34 @@ system and gives an overview of their function and contents.
LICENSE_CREATE_PACKAGE
Setting ``LICENSE_CREATE_PACKAGE`` to "1" causes the OpenEmbedded
build system to create an extra package (i.e.
- ``${``\ ```PN`` <#var-PN>`__\ ``}-lic``) for each recipe and to add
+ ``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add
those packages to the
- ```RRECOMMENDS`` <#var-RRECOMMENDS>`__\ ``_${PN}``.
+ :term:`RRECOMMENDS`\ ``_${PN}``.
The ``${PN}-lic`` package installs a directory in
``/usr/share/licenses`` named ``${PN}``, which is the recipe's base
name, and installs files in that directory that contain license and
copyright information (i.e. copies of the appropriate license files
from ``meta/common-licenses`` that match the licenses specified in
- the ```LICENSE`` <#var-LICENSE>`__ variable of the recipe metadata
+ the :term:`LICENSE` variable of the recipe metadata
and copies of files marked in
- ```LIC_FILES_CHKSUM`` <#var-LIC_FILES_CHKSUM>`__ as containing
+ :term:`LIC_FILES_CHKSUM` as containing
license text).
For related information on providing license text, see the
- ```COPY_LIC_DIRS`` <#var-COPY_LIC_DIRS>`__ variable, the
- ```COPY_LIC_MANIFEST`` <#var-COPY_LIC_MANIFEST>`__ variable, and the
+ :term:`COPY_LIC_DIRS` variable, the
+ :term:`COPY_LIC_MANIFEST` variable, and the
"`Providing License
Text <&YOCTO_DOCS_DEV_URL;#providing-license-text>`__" section in the
Yocto Project Development Tasks Manual.
LICENSE_FLAGS
Specifies additional flags for a recipe you must whitelist through
- ```LICENSE_FLAGS_WHITELIST`` <#var-LICENSE_FLAGS_WHITELIST>`__ in
+ :term:`LICENSE_FLAGS_WHITELIST` in
order to allow the recipe to be built. When providing multiple flags,
separate them with spaces.
- This value is independent of ```LICENSE`` <#var-LICENSE>`__ and is
+ This value is independent of :term:`LICENSE` and is
typically used to mark recipes that might require additional licenses
in order to be used in a commercial product. For more information,
see the "`Enabling Commercially Licensed
@@ -3883,7 +3883,7 @@ system and gives an overview of their function and contents.
LICENSE_FLAGS_WHITELIST
Lists license flags that when specified in
- ```LICENSE_FLAGS`` <#var-LICENSE_FLAGS>`__ within a recipe should not
+ :term:`LICENSE_FLAGS` within a recipe should not
prevent that recipe from being built. This practice is otherwise
known as "whitelisting" license flags. For more information, see the
"`Enabling Commercially Licensed
@@ -3907,10 +3907,10 @@ system and gives an overview of their function and contents.
kernel types.
If you do not specify a ``LINUX_KERNEL_TYPE``, it defaults to
- "standard". Together with ```KMACHINE`` <#var-KMACHINE>`__, the
+ "standard". Together with :term:`KMACHINE`, the
``LINUX_KERNEL_TYPE`` variable defines the search arguments used by
the kernel tools to find the appropriate description within the
- kernel `Metadata <#metadata>`__ with which to build out the sources
+ kernel :term:`Metadata` with which to build out the sources
and configuration.
LINUX_VERSION
@@ -3921,7 +3921,7 @@ system and gives an overview of their function and contents.
``meta/recipes-kernel/linux`` defines the variables as follows:
LINUX_VERSION ?= "3.4.24"
- The ``LINUX_VERSION`` variable is used to define ```PV`` <#var-PV>`__
+ The ``LINUX_VERSION`` variable is used to define :term:`PV`
for the recipe: PV = "${LINUX_VERSION}+git${SRCPV}"
LINUX_VERSION_EXTENSION
@@ -3929,7 +3929,7 @@ system and gives an overview of their function and contents.
kernel built with the OpenEmbedded build system. You define this
variable in the kernel recipe. For example, the linux-yocto kernel
recipes all define the variable as follows: LINUX_VERSION_EXTENSION
- ?= "-yocto-${`LINUX_KERNEL_TYPE <#var-LINUX_KERNEL_TYPE>`__}"
+ ?= "-yocto-${:term:`LINUX_KERNEL_TYPE`}"
Defining this variable essentially sets the Linux kernel
configuration item ``CONFIG_LOCALVERSION``, which is visible through
@@ -3941,7 +3941,7 @@ system and gives an overview of their function and contents.
overall log files. The default directory is ``${TMPDIR}/log``.
For the directory containing logs specific to each task, see the
- ```T`` <#var-T>`__ variable.
+ :term:`T` variable.
MACHINE
Specifies the target device for which the image is built. You define
@@ -3954,7 +3954,7 @@ system and gives an overview of their function and contents.
name, through which machine-specific configurations are set. Thus,
when ``MACHINE`` is set to "qemux86" there exists the corresponding
``qemux86.conf`` machine configuration file, which can be found in
- the `Source Directory <#source-directory>`__ in
+ the :term:`Source Directory` in
``meta/conf/machine``.
The list of machines supported by the Yocto Project as shipped
@@ -3974,8 +3974,8 @@ system and gives an overview of their function and contents.
MACHINE_ARCH
Specifies the name of the machine-specific architecture. This
- variable is set automatically from ```MACHINE`` <#var-MACHINE>`__ or
- ```TUNE_PKGARCH`` <#var-TUNE_PKGARCH>`__. You should not hand-edit
+ variable is set automatically from :term:`MACHINE` or
+ :term:`TUNE_PKGARCH`. You should not hand-edit
the ``MACHINE_ARCH`` variable.
MACHINE_ESSENTIAL_EXTRA_RDEPENDS
@@ -4094,11 +4094,11 @@ system and gives an overview of their function and contents.
MACHINE_FEATURES
Specifies the list of hardware features the
- ```MACHINE`` <#var-MACHINE>`__ is capable of supporting. For related
+ :term:`MACHINE` is capable of supporting. For related
information on enabling features, see the
- ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__,
- ```COMBINED_FEATURES`` <#var-COMBINED_FEATURES>`__, and
- ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ variables.
+ :term:`DISTRO_FEATURES`,
+ :term:`COMBINED_FEATURES`, and
+ :term:`IMAGE_FEATURES` variables.
For a list of hardware features supported by the Yocto Project as
shipped, see the "`Machine Features <#ref-features-machine>`__"
@@ -4124,7 +4124,7 @@ system and gives an overview of their function and contents.
MACHINEOVERRIDES
A colon-separated list of overrides that apply to the current
machine. By default, this list includes the value of
- ```MACHINE`` <#var-MACHINE>`__.
+ :term:`MACHINE`.
You can extend ``MACHINEOVERRIDES`` to add extra overrides that
should apply to a machine. For example, all machines emulated in QEMU
@@ -4136,7 +4136,7 @@ system and gives an overview of their function and contents.
recipe: SRC_URI_append_qemuall = "file://wired.config \\
file://wired-setup \\ " The underlying mechanism behind
``MACHINEOVERRIDES`` is simply that it is included in the default
- value of ```OVERRIDES`` <#var-OVERRIDES>`__.
+ value of :term:`OVERRIDES`.
MAINTAINER
The email address of the distribution maintainer.
@@ -4146,18 +4146,18 @@ system and gives an overview of their function and contents.
gets source code. When 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`` <#var-PREMIRRORS>`__, the upstream source, and then
+ :term:`PREMIRRORS`, the upstream source, and then
locations specified by ``MIRRORS`` in that order.
- Assuming your distribution (```DISTRO`` <#var-DISTRO>`__) is "poky",
+ Assuming your distribution (:term:`DISTRO`) is "poky",
the default value for ``MIRRORS`` is defined in the
``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository.
MLPREFIX
- Specifies a prefix has been added to ```PN`` <#var-PN>`__ to create a
+ Specifies a prefix has been added to :term:`PN` to create a
special version of a recipe or package (i.e. a Multilib version). The
variable is used in places where the prefix needs to be added to or
- removed from a the name (e.g. the ```BPN`` <#var-BPN>`__ variable).
+ removed from a the name (e.g. the :term:`BPN` variable).
``MLPREFIX`` gets set when a prefix has been added to ``PN``.
.. note::
@@ -4174,10 +4174,10 @@ system and gives an overview of their function and contents.
for it as well.
To help understand when ``MLPREFIX`` might be needed, consider when
- ```BBCLASSEXTEND`` <#var-BBCLASSEXTEND>`__ is used to provide a
+ :term:`BBCLASSEXTEND` is used to provide a
``nativesdk`` version of a recipe in addition to the target version.
If that recipe declares build-time dependencies on tasks in other
- recipes by using ```DEPENDS`` <#var-DEPENDS>`__, then a dependency on
+ recipes by using :term:`DEPENDS`, then a dependency on
"foo" will automatically get rewritten to a dependency on
"nativesdk-foo". However, dependencies like the following will not
get rewritten automatically: do_foo[depends] += "recipe:do_foo" If
@@ -4191,7 +4191,7 @@ system and gives an overview of their function and contents.
module_autoload_rfcomm = "rfcomm"
should now be replaced with: KERNEL_MODULE_AUTOLOAD += "rfcomm" See
- the ```KERNEL_MODULE_AUTOLOAD`` <#var-KERNEL_MODULE_AUTOLOAD>`__
+ the :term:`KERNEL_MODULE_AUTOLOAD`
variable for more information.
module_conf
@@ -4204,7 +4204,7 @@ system and gives an overview of their function and contents.
configuration file, a distribution configuration file, an append file
for the recipe, or the recipe itself). If you use this variable, you
must also be sure to list the module name in the
- ```KERNEL_MODULE_AUTOLOAD`` <#var-KERNEL_MODULE_AUTOLOAD>`__
+ :term:`KERNEL_MODULE_AUTOLOAD`
variable.
Here is the general syntax: module_conf_module_name =
@@ -4221,7 +4221,7 @@ system and gives an overview of their function and contents.
For information on how to specify kernel modules to auto-load on
boot, see the
- ```KERNEL_MODULE_AUTOLOAD`` <#var-KERNEL_MODULE_AUTOLOAD>`__
+ :term:`KERNEL_MODULE_AUTOLOAD`
variable.
MODULE_TARBALL_DEPLOY
@@ -4237,14 +4237,14 @@ system and gives an overview of their function and contents.
same file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?=
"${MACHINE}"
- See the ```MACHINE`` <#var-MACHINE>`__ variable for additional
+ See the :term:`MACHINE` variable for additional
information.
MODULE_TARBALL_NAME
The base name of the kernel module tarball. This variable is set in
the ``meta/classes/kernel-artifact-names.bbclass`` file as follows:
MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" The value of the
- ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__ variable,
+ :term:`KERNEL_ARTIFACT_NAME` variable,
which is set in the same file, has the following value:
KERNEL_ARTIFACT_NAME ?=
"${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
@@ -4257,11 +4257,11 @@ system and gives an overview of their function and contents.
The default value of this variable is:
${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS} Some classes (e.g.
- ```cross-canadian`` <#ref-classes-cross-canadian>`__) modify the
+ :ref:`cross-canadian `) modify the
``MULTIMACH_TARGET_SYS`` value.
- See the ```STAMP`` <#var-STAMP>`__ variable for an example. See the
- ```STAGING_DIR_TARGET`` <#var-STAGING_DIR_TARGET>`__ variable for
+ See the :term:`STAMP` variable for an example. See the
+ :term:`STAGING_DIR_TARGET` variable for
more information.
NATIVELSBSTRING
@@ -4276,7 +4276,7 @@ system and gives an overview of their function and contents.
packages for different distributions (e.g. to avoid problems with
``glibc`` version incompatibilities). Additionally, the variable is
checked against
- ```SANITY_TESTED_DISTROS`` <#var-SANITY_TESTED_DISTROS>`__ if that
+ :term:`SANITY_TESTED_DISTROS` if that
variable is set.
NM
@@ -4300,7 +4300,7 @@ system and gives an overview of their function and contents.
NO_RECOMMENDATIONS
Prevents installation of all "recommended-only" packages.
Recommended-only packages are packages installed only through the
- ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ variable). Setting the
+ :term:`RRECOMMENDS` variable). Setting the
``NO_RECOMMENDATIONS`` variable to "1" turns this feature on:
NO_RECOMMENDATIONS = "1"
@@ -4310,7 +4310,7 @@ system and gives an overview of their function and contents.
It is important to realize that if you choose to not install packages
using this variable and some other packages are dependent on them
- (i.e. listed in a recipe's ```RDEPENDS`` <#var-RDEPENDS>`__
+ (i.e. listed in a recipe's :term:`RDEPENDS`
variable), the OpenEmbedded build system ignores your request and
will install the packages to avoid dependency errors.
@@ -4325,8 +4325,8 @@ system and gives an overview of their function and contents.
Support for this variable exists only when using the IPK and RPM
packaging backend. Support does not exist for DEB.
- See the ```BAD_RECOMMENDATIONS`` <#var-BAD_RECOMMENDATIONS>`__ and
- the ```PACKAGE_EXCLUDE`` <#var-PACKAGE_EXCLUDE>`__ variables for
+ See the :term:`BAD_RECOMMENDATIONS` and
+ the :term:`PACKAGE_EXCLUDE` variables for
related information.
NOAUTOPACKAGEDEBUG
@@ -4345,7 +4345,7 @@ system and gives an overview of their function and contents.
The minimal command and arguments to run ``objdump``.
OE_BINCONFIG_EXTRA_MANGLE
- When inheriting the ```binconfig`` <#ref-classes-binconfig>`__ class,
+ When inheriting the :ref:`binconfig ` class,
this variable specifies additional arguments passed to the "sed"
command. The sed command alters any paths in configuration scripts
that have been set up during compilation. Inheriting this class
@@ -4357,7 +4357,7 @@ system and gives an overview of their function and contents.
Directory <#source-directory>`__ for details on how this class
applies these additional sed command arguments. For general
information on the ``binconfig`` class, see the
- "```binconfig.bbclass`` <#ref-classes-binconfig>`__" section.
+ ":ref:`binconfig.bbclass `" section.
OE_IMPORTS
An internal variable used to tell the OpenEmbedded build system what
@@ -4424,9 +4424,9 @@ system and gives an overview of their function and contents.
overrides mechanism.
The default value of ``OVERRIDES`` includes the values of the
- ```CLASSOVERRIDE`` <#var-CLASSOVERRIDE>`__,
- ```MACHINEOVERRIDES`` <#var-MACHINEOVERRIDES>`__, and
- ```DISTROOVERRIDES`` <#var-DISTROOVERRIDES>`__ variables. Another
+ :term:`CLASSOVERRIDE`,
+ :term:`MACHINEOVERRIDES`, and
+ :term:`DISTROOVERRIDES` variables. Another
important override included by default is ``pn-${PN}``. This override
allows variables to be set for a single recipe within configuration
(``.conf``) files. Here is an example: FOO_pn-myrecipe =
@@ -4468,8 +4468,8 @@ system and gives an overview of their function and contents.
The architecture of the resulting package or packages.
By default, the value of this variable is set to
- ```TUNE_PKGARCH`` <#var-TUNE_PKGARCH>`__ when building for the
- target, ```BUILD_ARCH`` <#var-BUILD_ARCH>`__ when building for the
+ :term:`TUNE_PKGARCH` when building for the
+ target, :term:`BUILD_ARCH` when building for the
build host, and "${SDK_ARCH}-${SDKPKGSUFFIX}" when building for the
SDK.
@@ -4482,7 +4482,7 @@ system and gives an overview of their function and contents.
However, if your recipe's output packages are built specific to the
target machine rather than generally for the architecture of the
machine, you should set ``PACKAGE_ARCH`` to the value of
- ```MACHINE_ARCH`` <#var-MACHINE_ARCH>`__ in the recipe as follows:
+ :term:`MACHINE_ARCH` in the recipe as follows:
PACKAGE_ARCH = "${MACHINE_ARCH}"
PACKAGE_ARCHS
@@ -4524,7 +4524,7 @@ system and gives an overview of their function and contents.
For information on packaging and build performance effects as a
result of the package manager in use, see the
- "```package.bbclass`` <#ref-classes-package>`__" section.
+ ":ref:`package.bbclass