poky: subtree update:9d1b332292..2834c2f853
Alex Stewart (3):
opkg-utils: upgrade to version 0.4.5
opkg: upgrade to version 0.4.5
opkg: add QA check for openssl feed verification
Alexander Kanavin (37):
virglrenderer: explicitly depend on libgbm
elfutils: update 0.183 -> 0.185
libcap: update 2.49 -> 2.50
perl: split perl-cross into its own recipe
perl-cross: 1.3.5 -> 1.3.6
perl: update 5.32.1 -> 5.34.0
libgcrypt: upgrade 1.9.2 -> 1.9.3
erofs-utils: correct upstream version check
m4: correct ptest failures
ovmf: update 2021.02 -> 2021.05
apt: update 2.2.3 -> 2.2.4
util-linux: update 2.36.2 -> 2.37
cross-canadian: correct the location of pkg-config files
nettle: update 3.7.2 -> 3.7.3
glib-2.0: update 2.68.2 -> 2.68.3
meson: upgrade 0.58.0 -> 0.58.1
ell: upgrade 0.40 -> 0.41
erofs-utils: upgrade 1.2.1 -> 1.3
grub: upgrade 2.04+2.06~rc1 -> 2.06
gptfdisk: upgrade 1.0.7 -> 1.0.8
connman: update 1.39 -> 1.40
libksba: upgrade 1.5.1 -> 1.6.0
libnss-mdns: upgrade 0.15 -> 0.15.1
libwpe: upgrade 1.10.0 -> 1.10.1
puzzles: upgrade to latest revision
rng-tools: upgrade 6.12 -> 6.13
stress-ng: upgrade 0.12.09 -> 0.12.10
python3-magic: upgrade 0.4.23 -> 0.4.24
sudo: upgrade 1.9.7 -> 1.9.7p1
wpebackend-fdo: upgrade 1.8.4 -> 1.10.0
xkeyboard-config: upgrade 2.32 -> 2.33
bitbake.conf: enable debuginfod in native/nativesdk
gdb-cross: enable debuginfod
util-linux: backport a patch to address mkswap hangs
selftest: do not hardcode /tmp/sdk
glibc: do not enable memory tagging on aarch64 just yet
mesa: enable gallium intel drivers when building for x86
Alexandre Belloni (1):
runqemu: time the copy to tmpfs
Alexey Brodkin (3):
gcc: Fixes for ARC
gdb: Add native GDB support for ARC
gcc: Apply multilib fix to ARC as well
Alistair Francis (3):
recipes-bsp/opensbi: Disable FW_PIC
recipes-bsp/u-boot: Allow deploying the u-boot DTB
recipes-bsp/opensbi: Add support for specifying a device tree
Anders Wallin (1):
coreutils: remove NOSTAT_LEAF_OPTIMIZATION
Andrea Adami (1):
kernel.bbclass: fix do_sizecheck() comparison
Andreas Müller (19):
mesa: upgrade 21.1.1 -> 21.1.2
systemd: Add more ugly casts to fix build with musl
alsa-lib: upgrade 1.2.4 -> 1.2.5
alsa-plugins: upgrade 1.2.2 -> 1.2.5
alsa-tools: upgrade 1.2.2 -> 1.2.5
alsa-topology-conf: upgrade 1.2.4 -> 1.2.5
alsa-ucm-conf: upgrade 1.2.4 -> 1.2.5
alsa-utils(-scripts): upgrade 1.2.4 -> 1.2.5
libinput: upgrade 1.17.3 -> 1.18.0
xf86-input-libinput: upgrade 0.30.0 -> 1.0.1
epiphany: upgrade 40.1 -> 40.2
vala: upgrade 0.52.3 -> 0.52.4
p11-kit: upgrade 0.23.22 -> 0.23.24
xorgproto: upgrade 2021.4.99.1 -> 2021.4.99.2
mpg123: 1.27.2 -> 1.28.0
libx11: upgrade 1.7.1 -> 1.7.2
libx11: remove CPPFLAGS_FOR_BUILD += "-D_GNU_SOURCE"
libpcap: upgrade 1.10.0 -> 1.10.1
mesa: upgrade 21.1.2 -> 21.1.3
Bruce Ashfield (10):
linux-yocto/5.10: update to v5.10.42
linux-yocto/5.10: temporarily revert aufs
linux-yocto-dev: base AUTOREV on specified version
linux-yocto/5.4: update to v5.4.124
linux-yocto/5.10: restore aufs
linux-yocto/5.10: update to v5.10.43
linux-yocto/5.4: update to v5.4.125
linux-yocto/5.10: cgroup1: fix leaked context root causing sporadic NULL deref in LTP
btrfs-tools: include linux/const.h to fix build with 5.12+ headers
bsps/5.10: update to v5.10.43
Changqing Li (1):
libjpeg-turbo: fix do_compile error on arm
Chris Laplante (1):
bitbake: build: warn on setting noexec/nostamp/fakeroot flag to any value besides '1'
Daniel Wagenknecht (5):
ref-manual: variables: update examples refering to DEPLOY_DIR_IMAGE
ref-manual: variables: document IMGDEPLOYDIR
ref-manual: migration-2.2: add note about IMGDEPLOYDIR
ref-manual: variables: fixup example in IMAGE_CMD
ref-manual: variables: fixup class reference in IMAGE_MANIFEST
Joe Slater (1):
tcf-agent: change license to EPL/EDL
Joshua Watt (2):
classes/buildhistory: Add option to strip path prefix
classes/reproducible_build: Use atomic rename for SDE file
Justin Bronder (1):
populate_sdk_ext: copy BBMULTICONFIG files
Kai Kang (1):
valgrind: fix a typo
Khem Raj (14):
harfbuzz: Fix unused-variable warning
arch-armv4: Allow -march=armv4
ffmpeg: Link in libatomic on riscv32
libssp-nonshared: Use a different implementation for __stack_chk_fail
qemuriscv: Enable 4 core emulation
gcompat: Add recipe
musl: Do not package glibc loader
musl: Set UPSTREAM_CHECK_COMMITS
Revert "libgcc-initial: Do not build fp128 to decimal ppc functions"
qemu: Provide float128 via hwcaps2 on ppc64le
linuxloader: Be aware of riscv32 ldso
linuxloader.bbclass: Add entry for ppc64 LE glibc loader
gcompat: Create symlinks to glibc ldso locations
sdk: Enable do_populate_sdk with multilibs
Luca Boccassi (1):
systemd: install new sysext tool via systemd-extra-utils
Marcus Comstedt (1):
conf/machine-sdk: Add ppc64 SDK machine
Matt Spencer (1):
systemd-conf: Prevent systemd-network from managing veth interfaces
Michael Halstead (1):
releases: update to include 3.1.8
Michael Opdenacker (12):
bitbake: docs: Add BB_HASHSERVE definition to glossary
bitbake: doc: bitbake-user-manual: fix erroneous statement in glossary intro
manuals: fix epub export warnings
ref-manual: move migration guides to separate document
releases: clarify supported and outdated releases
releases: put release number after "Release Series"
sdk-manual: fix broken references
migration guides: remove index reference to BB_SETSCENE_VERIFY_FUNCTION2
manuals: fix issues related to trailing dots
sdk-manual: add missing quoting around "devtool upgrade"
sdk-manual: fix wrong word
sdk-manual: add missing index references
Ming Liu (2):
u-boot-tools: fix a mkimage signature issue
uboot-sign.bbclass: fix some install commands
Mingli Yu (2):
sysstat: make the service start automatically
boost: fix wrong type for mutex in regex v5
Nicolas Dechesne (3):
index: remove the link/section to 'mega manual' from main page
index: remove links to releases manual and index
index: split releases manuals and indexes into two sections in the tree
Paul Barker (2):
bitbake: asyncrpc: Add ping method
bitbake: asyncrpc: Reduce verbosity
Quentin Schulz (6):
docs: ref-manual: migration-3.0: remove reference to non-existing BB_SETSCENE_VERIFY_FUNCTION2
docs: ref-manual: variables: add missing links to terms glossary
bitbake: doc: user-manual: remove mentions to BBVERSIONS
bitbake: doc: user-manual: ref-manual: remove mentions to BB_SETSCENE_VERIFY_FUNCTION2
documentation: Makefile: turn warnings into errors by default
docs: replace ``FOO`` by :term:`FOO` where possible
Richard Purdie (11):
lttng-tools: upgrade 2.12.3 -> 2.12.4
qemurunner: Try to ensure mmap'd libs are paged in
qemurunner: Increase startup timeout 120 -> 300
build-appliance-image: Update to master head revision
test-manual: add initial reproducible builds documentation
test-manual: Add initial YP Compatible documentation
README: Tweak as the website isn't really new now
README: Move to using markdown as the format
perf: Use python3targetconfig to ensure we use target libraries
ltp: Reinstate 'hanging' tests for evaluation
README.poky: Formatting and content cleanup
Richard Weinberger (1):
Document erofs filesystem targets
Robert P. J. Day (2):
ref-manual: add SRCTREECOVEREDTASKS to variable glossary
ref-manual: add glossary entry for NON_MULTILIB_RECIPES
Ross Burton (11):
mx: remove from Openembedded Core
core-image-weston: remove Clutter examples
Remove Clutter and Cogl
oeqa: remove Clutter usage
meta-poky: remove clutter references
Remove Clutter references
gcc: enable branch protection by standard
image_types: add zsync conversions
avahi: apply fix for CVE-2021-3468
qemu: fix virtio vhost-user-gpu CVEs
gcc: replace gdb helper install revert with the upstream fix
Sakib Sajal (3):
oeqa/core/target/qemu.py: display contents of dumped files
oe-time-dd-test.sh: improve output formatting
oe-time-dd-test.sh: add iostat command
Saul Wold (1):
qemurunner: add second qmp port
Scott Weaver (1):
bitbake: fetch2: add check for empty SRC_URI hash string
Tim Orling (8):
maintainers.inc: update email address
python3-scons: upgrade 3.1.2 -> 4.1.0; simplify
python3-hypothesis: upgrade 6.13.7 -> 6.13.14
at-spi2-core: upgrade 2.40.1 -> 2.40.2
python3-importlib-metadata: upgrade 4.4.0 -> 4.5.0
python3-manifest: add statistics subpackage
python3-hypothesis: upgrade 6.13.14 -> 6.14.0
python3: skip tests requiring tools-sdk
Tony Battersby (1):
glibc: fix path to place zdump in the tzcode package
Tony Tascioglu (3):
valgrind: Improve non-deterministic ptest reliability
valgrind: remove buggy ptest from arm64
valgrind: Actually install list of non-deterministic ptests
hongxu (1):
nativesdk-libdnf: fix installed and not shipped files
wangmy (21):
cmake: upgrade 3.20.2 -> 3.20.3
mtools: upgrade 4.0.27 -> 4.0.29
python3-magic: upgrade 0.4.22 -> 0.4.23
less: upgrade 586 -> 589
python3-libarchive-c: upgrade 3.0 -> 3.1
diffoscope: upgrade 175 -> 177
dtc: upgrade 1.6.0 -> 1.6.1
git: upgrade 2.31.1 -> 2.32.0
gnutls: upgrade 3.7.1 -> 3.7.2
go: upgrade 1.16.4 -> 1.16.5
less: upgrade 589 -> 590
ethtool: upgrade 5.10 -> 5.12
m4: upgrade 1.4.18 -> 1.4.19
alsa-lib: upgrade 1.2.5 -> 1.2.5.1
alsa-utils: upgrade 1.2.5 -> 1.2.5.1
alsa-topology-conf: upgrade 1.2.5 -> 1.2.5.1
alsa-ucm-conf: upgrade 1.2.5 -> 1.2.5.1
blktrace: upgrade 1.2.0 -> 1.3.0
enchant2: upgrade 2.2.15 -> 2.3.0
librepo: upgrade 1.14.0 -> 1.14.1
createrepo-c: upgrade 0.17.2 -> 0.17.3
zangrc (1):
python3-pycairo: upgrade 1.20.0 -> 1.20.1
zhengruoqin (6):
python3-importlib-metadata: upgrade 4.3.0 -> 4.4.0
libogg: upgrade 1.3.4 -> 1.3.5
liburcu: upgrade 0.12.2 -> 0.13.0
libcomps: upgrade 0.1.16 -> 0.1.17
python3-dbusmock: upgrade 0.23.0 -> 0.23.1
nfs-utils: upgrade 2.5.3 -> 2.5.4
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: Iac124e214336beb9cab7fb3b67a6968d4e34d06f
diff --git a/poky/documentation/ref-manual/classes.rst b/poky/documentation/ref-manual/classes.rst
index 6dd0cbb..09878c4 100644
--- a/poky/documentation/ref-manual/classes.rst
+++ b/poky/documentation/ref-manual/classes.rst
@@ -50,7 +50,7 @@
``do_package_write_*`` tasks to
have different signatures for the machines with different tunings.
Additionally, unnecessary rebuilds occur every time an image for a
- different ``MACHINE`` is built even when the recipe never changes.
+ different :term:`MACHINE` is built even when the recipe never changes.
By default, all recipes inherit the :ref:`base <ref-classes-base>` and
:ref:`package <ref-classes-package>` classes, which enable
@@ -110,7 +110,7 @@
- :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``
+ additional parameters to ``configure`` through the :term:`EXTRA_OECONF`
or :term:`PACKAGECONFIG_CONFARGS`
variables.
@@ -168,7 +168,7 @@
the "subpath" parameter limits the checkout to a specific subpath
of the tree. Here is an example where ``${BP}`` is used so that the files
are extracted into the subdirectory expected by the default value of
- ``S``::
+ :term:`S`::
SRC_URI = "git://example.com/downloads/somepackage.rpm;subpath=${BP}"
@@ -256,7 +256,7 @@
: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.
+remove "buildstats" from the :term:`USER_CLASSES` list.
.. _ref-classes-buildstats-summary:
@@ -289,21 +289,6 @@
``cross-canadian`` recipes to change ``RPATH`` records within binaries
in order to make them relocatable.
-.. _ref-classes-clutter:
-
-``clutter.bbclass``
-===================
-
-The ``clutter`` class consolidates the major and minor version naming
-and other common items used by Clutter and related recipes.
-
-.. note::
-
- Unlike some other classes related to specific libraries, recipes
- building other software that uses Clutter do not need to inherit this
- class unless they use the same recipe versioning scheme that the
- Clutter and related recipes do.
-
.. _ref-classes-cmake:
``cmake.bbclass``
@@ -448,7 +433,7 @@
add the task at the appropriate place, which is usually after
:ref:`ref-tasks-compile` or
:ref:`ref-tasks-install`. The class then takes care of
-staging the files from ``DEPLOYDIR`` to ``DEPLOY_DIR_IMAGE``.
+staging the files from :term:`DEPLOYDIR` to :term:`DEPLOY_DIR_IMAGE`.
.. _ref-classes-devshell:
@@ -489,7 +474,7 @@
currently only supports creating a development variant of the target
recipe, not ``native`` or ``nativesdk`` variants.
-The ``BBCLASSEXTEND`` syntax (i.e. ``devupstream:target``) provides
+The :term:`BBCLASSEXTEND` syntax (i.e. ``devupstream:target``) provides
support for ``native`` and ``nativesdk`` variants. Consequently, this
functionality can be added in a future release.
@@ -534,13 +519,13 @@
``externalsrc`` class, you use the
:term:`EXTERNALSRC` and
:term:`EXTERNALSRC_BUILD` variables to
-ultimately define ``S`` and ``B``.
+ultimately define :term:`S` and :term:`B`.
By default, this class expects the source code to support recipe builds
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``)::
+from the recipes. By default, the :term:`B` directory is set to the
+following, which is separate from the source directory (:term:`S`)::
${WORKDIR}/${BPN}/{PV}/
@@ -704,8 +689,8 @@
.. note::
This functionality is backfilled by default and, if not applicable,
- should be disabled through ``DISTRO_FEATURES_BACKFILL_CONSIDERED`` or
- ``MACHINE_FEATURES_BACKFILL_CONSIDERED``, respectively.
+ should be disabled through :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` or
+ :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`, respectively.
.. _ref-classes-grub-efi:
@@ -853,7 +838,7 @@
Inheriting the ``icecc`` class changes all sstate signatures.
Consequently, if a development team has a dedicated build system that
populates :term:`SSTATE_MIRRORS` and they want to
-reuse sstate from ``SSTATE_MIRRORS``, then all developers and the build
+reuse sstate from :term:`SSTATE_MIRRORS`, then all developers and the build
system need to either inherit the ``icecc`` class or nobody should.
At the distribution level, you can inherit the ``icecc`` class to be
@@ -881,10 +866,10 @@
``rootfs*.bbclass`` files (depending on the package format used) and
then one or more image files are created.
-- The ``IMAGE_FSTYPES`` variable controls the types of images to
+- The :term:`IMAGE_FSTYPES` variable controls the types of images to
generate.
-- The ``IMAGE_INSTALL`` variable controls the list of packages to
+- The :term:`IMAGE_INSTALL` variable controls the list of packages to
install into the image.
For information on customizing images, see the
@@ -931,7 +916,7 @@
.. note::
To build a VMware VMDK image, you need to add "wic.vmdk" to
- ``IMAGE_FSTYPES``. This would also be similar for Virtual Box Virtual Disk
+ :term:`IMAGE_FSTYPES`. This would also be similar for Virtual Box Virtual Disk
Image ("vdi") and QEMU Copy On Write Version 2 ("qcow2") images.
.. _ref-classes-image-live:
@@ -1009,7 +994,7 @@
are meant to detect real or potential problems in the packaged
output. So exercise caution when disabling these checks.
-Here are the tests you can list with the ``WARN_QA`` and
+Here are the tests you can list with the :term:`WARN_QA` and
``ERROR_QA`` variables:
- ``already-stripped:`` Checks that produced binaries have not
@@ -1142,13 +1127,13 @@
PACKAGECONFIG[foo] = "..."
-- ``la:`` Checks ``.la`` files for any ``TMPDIR`` paths. Any ``.la``
+- ``la:`` Checks ``.la`` files for any :term:`TMPDIR` paths. Any ``.la``
file containing these paths is incorrect since ``libtool`` adds the
correct sysroot prefix when using the files automatically itself.
- ``ldflags:`` Ensures that the binaries were linked with the
:term:`LDFLAGS` options provided by the build system.
- If this test fails, check that the ``LDFLAGS`` variable is being
+ If this test fails, check that the :term:`LDFLAGS` variable is being
passed to the linker command.
- ``libdir:`` Checks for libraries being installed into incorrect
@@ -1188,7 +1173,7 @@
invalid characters (i.e. characters other than 0-9, a-z, ., +, and
-).
-- ``pkgv-undefined:`` Checks to see if the ``PKGV`` variable is
+- ``pkgv-undefined:`` Checks to see if the :term:`PKGV` variable is
undefined during :ref:`ref-tasks-package`.
- ``pkgvarcheck:`` Checks through the variables
@@ -1208,8 +1193,8 @@
- ``pn-overrides:`` Checks that a recipe does not have 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 :term:`MACHINE` or
+ its :term:`PN` value matches something already in :term:`OVERRIDES` (e.g.
+ :term:`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"``.
@@ -1740,7 +1725,7 @@
SOURCE_MIRROR_URL = "http://example.com/my-source-mirror"
You can specify only a single URL
-in ``SOURCE_MIRROR_URL``.
+in :term:`SOURCE_MIRROR_URL`.
.. _ref-classes-package:
@@ -1764,7 +1749,7 @@
use this class.
You can control the list of resulting package formats by using the
-``PACKAGE_CLASSES`` variable defined in your ``conf/local.conf``
+:term:`PACKAGE_CLASSES` variable defined in your ``conf/local.conf``
configuration file, which is located in the :term:`Build Directory`.
When defining the variable, you can
specify one or more package types. Since images are generated from
@@ -1785,7 +1770,7 @@
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 :term:`Metadata` than the IPK package
-manager. Consequently, you might consider setting ``PACKAGE_CLASSES`` to
+manager. Consequently, you might consider setting :term:`PACKAGE_CLASSES` to
"package_ipk" if you are building smaller systems.
Before making your package manager decision, however, you should
@@ -1867,7 +1852,7 @@
.. note::
You cannot specify the ``package_tar`` class first using the
- ``PACKAGE_CLASSES`` variable. You must use ``.deb``, ``.ipk``, or ``.rpm``
+ :term:`PACKAGE_CLASSES` variable. You must use ``.deb``, ``.ipk``, or ``.rpm``
file formats for your image or SDK.
.. _ref-classes-packagedata:
@@ -1889,7 +1874,7 @@
========================
The ``packagegroup`` class sets default values appropriate for package
-group recipes (e.g. ``PACKAGES``, ``PACKAGE_ARCH``, ``ALLOW_EMPTY``, and
+group recipes (e.g. :term:`PACKAGES`, :term:`PACKAGE_ARCH`, :term:`ALLOW_EMPTY`, and
so forth). It is highly recommended that all package group recipes
inherit this class.
@@ -2208,7 +2193,7 @@
recipe, enabling ``rm_work`` will potentially result in your changes to
the source being lost. To exclude some recipes from having their work
directories deleted by ``rm_work``, you can add the names of the recipe
-or recipes you are working on to the ``RM_WORK_EXCLUDE`` variable, which
+or recipes you are working on to the :term:`RM_WORK_EXCLUDE` variable, which
can also be set in your ``local.conf`` file. Here is an example::
RM_WORK_EXCLUDE += "busybox glibc"
@@ -2323,11 +2308,11 @@
values available. The ``meta/site directory`` contains test results
sorted into different categories such as architecture, endianness, and
the ``libc`` used. Site information provides a list of files containing
-data relevant to the current build in the ``CONFIG_SITE`` variable that
+data relevant to the current build in the :term:`CONFIG_SITE` variable that
Autotools automatically picks up.
-The class also provides variables like ``SITEINFO_ENDIANNESS`` and
-``SITEINFO_BITS`` that can be used elsewhere in the metadata.
+The class also provides variables like :term:`SITEINFO_ENDIANNESS` and
+:term:`SITEINFO_BITS` that can be used elsewhere in the metadata.
.. _ref-classes-sstate:
@@ -2378,7 +2363,7 @@
.. note::
Additionally, a recipe can customize the files further by
- declaring a processing function in the ``SYSROOT_PREPROCESS_FUNCS``
+ declaring a processing function in the :term:`SYSROOT_PREPROCESS_FUNCS`
variable.
A shared state (sstate) object is built from these files and the
@@ -2420,11 +2405,11 @@
recommended for general use, the files do allow some issues such
as user creation and module indexes to be addressed.
- Because recipes can have other dependencies outside of ``DEPENDS``
+ Because recipes can have other dependencies outside of :term:`DEPENDS`
(e.g. ``do_unpack[depends] += "tar-native:do_populate_sysroot"``),
the sysroot creation function ``extend_recipe_sysroot`` is also added
as a pre-function for those tasks whose dependencies are not through
- ``DEPENDS`` but operate similarly.
+ :term:`DEPENDS` but operate similarly.
When installing dependencies into the sysroot, the code traverses the
dependency graph and processes dependencies in exactly the same way
@@ -2750,8 +2735,8 @@
system takes care of details such as making sure the script is stopped
before a package is removed and started when the package is installed.
-Three variables control this class: ``INITSCRIPT_PACKAGES``,
-``INITSCRIPT_NAME`` and ``INITSCRIPT_PARAMS``. See the variable links
+Three variables control this class: :term:`INITSCRIPT_PACKAGES`,
+:term:`INITSCRIPT_NAME` and :term:`INITSCRIPT_PARAMS`. See the variable links
for details.
.. _ref-classes-useradd:
@@ -2805,9 +2790,9 @@
.. note::
You do not use the ``useradd-staticids`` class directly. You either enable
- or disable the class by setting the ``USERADDEXTENSION`` variable. If you
+ or disable the class by setting the :term:`USERADDEXTENSION` variable. If you
enable or disable the class in a configured system, :term:`TMPDIR` might
- contain incorrect ``uid`` and ``gid`` values. Deleting the ``TMPDIR``
+ contain incorrect ``uid`` and ``gid`` values. Deleting the :term:`TMPDIR`
directory will correct this condition.
.. _ref-classes-utility-tasks:
diff --git a/poky/documentation/ref-manual/faq.rst b/poky/documentation/ref-manual/faq.rst
index f1b564a..640ef77 100644
--- a/poky/documentation/ref-manual/faq.rst
+++ b/poky/documentation/ref-manual/faq.rst
@@ -108,10 +108,10 @@
but the package is being marked as machine-specific in all cases, how do
I prevent this?
-**A:** Set ``SRC_URI_OVERRIDES_PACKAGE_ARCH`` = "0" in the ``.bb`` file
+**A:** Set :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` = "0" in the ``.bb`` file
but make sure the package is manually marked as machine-specific for the
case that needs it. The code that handles
-``SRC_URI_OVERRIDES_PACKAGE_ARCH`` is in the
+:term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` is in the
``meta/classes/base.bbclass`` file.
**Q:** I'm behind a firewall and need to use a proxy server. How do I do
@@ -250,7 +250,7 @@
: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``.
+ :term:`IMAGE_ROOTFS_SIZE`.
**Q:** Why don't you support directories with spaces in the pathnames?
@@ -262,11 +262,11 @@
**Q:** How do I use an external toolchain?
**A:** The toolchain configuration is very flexible and customizable. It
-is primarily controlled with the ``TCMODE`` variable. This variable
+is primarily controlled with the :term:`TCMODE` variable. This variable
controls which ``tcmode-*.inc`` file to include from the
``meta/conf/distro/include`` directory within the :term:`Source Directory`.
-The default value of ``TCMODE`` is "default", which tells the
+The default value of :term:`TCMODE` is "default", which tells the
OpenEmbedded build system to use its internally built toolchain (i.e.
``tcmode-default.inc``). However, other patterns are accepted. In
particular, "external-\*" refers to external toolchains. One example is
@@ -325,7 +325,7 @@
BB_FETCH_PREMIRRORONLY = "1"
This statement
-limits the build system to pulling source from the ``PREMIRRORS`` only.
+limits the build system to pulling source from the :term:`PREMIRRORS` only.
Again, this technique is useful for reproducing builds.
Here is another technique::
@@ -339,7 +339,7 @@
Finally, consider an example where you are behind an HTTP-only firewall.
You could make the following changes to the ``local.conf`` configuration
-file as long as the ``PREMIRRORS`` server is current::
+file as long as the :term:`PREMIRRORS` server is current::
PREMIRRORS_prepend = "\
ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
@@ -349,7 +349,7 @@
These changes would cause the build system to successfully fetch source
over HTTP and any network accesses to anything other than the
-``PREMIRRORS`` would fail.
+:term:`PREMIRRORS` would fail.
The build system also honors the standard shell environment variables
``http_proxy``, ``ftp_proxy``, ``https_proxy``, and ``all_proxy`` to
diff --git a/poky/documentation/ref-manual/features.rst b/poky/documentation/ref-manual/features.rst
index 31d24b8..ded6532 100644
--- a/poky/documentation/ref-manual/features.rst
+++ b/poky/documentation/ref-manual/features.rst
@@ -10,10 +10,10 @@
Features provide a mechanism for working out which packages should be
included in the generated images. Distributions can select which
-features they want to support through the ``DISTRO_FEATURES`` variable,
+features they want to support through the :term:`DISTRO_FEATURES` variable,
which is set or appended to in a distribution's configuration file such
as ``poky.conf``, ``poky-tiny.conf``, ``poky-lsb.conf`` and so forth.
-Machine features are set in the ``MACHINE_FEATURES`` variable, which is
+Machine features are set in the :term:`MACHINE_FEATURES` variable, which is
set in the machine configuration file and specifies the hardware
features for a given machine.
@@ -267,7 +267,7 @@
- *ssh-server-openssh:* Installs the OpenSSH SSH server, which is more
full-featured than Dropbear. Note that if both the OpenSSH SSH server
and the Dropbear minimal SSH server are present in
- ``IMAGE_FEATURES``, then OpenSSH will take precedence and Dropbear
+ :term:`IMAGE_FEATURES`, then OpenSSH will take precedence and Dropbear
will not be installed.
- *tools-debug:* Installs debugging tools such as ``strace`` and
@@ -323,27 +323,27 @@
- *The "pulseaudio" distro feature option*: Previously, PulseAudio
support was enabled within the Qt and GStreamer frameworks. Because
of this, the feature is backfilled and thus enabled for all distros
- through the ``DISTRO_FEATURES_BACKFILL`` variable in the
+ through the :term:`DISTRO_FEATURES_BACKFILL` variable in the
``meta/conf/bitbake.conf`` file. However, your distro needs to
disable the feature. You can disable the feature without affecting
other existing distro configurations that need PulseAudio support by
- adding "pulseaudio" to ``DISTRO_FEATURES_BACKFILL_CONSIDERED`` in
+ adding "pulseaudio" to :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` in
your distro's ``.conf`` file. Adding the feature to this variable
- when it also exists in the ``DISTRO_FEATURES_BACKFILL`` variable
+ when it also exists in the :term:`DISTRO_FEATURES_BACKFILL` variable
prevents the build system from adding the feature to your
- configuration's ``DISTRO_FEATURES``, effectively disabling the
+ configuration's :term:`DISTRO_FEATURES`, effectively disabling the
feature for that particular distro.
- *The "rtc" machine feature option*: Previously, real time clock (RTC)
support was enabled for all target devices. Because of this, the
feature is backfilled and thus enabled for all machines through the
- ``MACHINE_FEATURES_BACKFILL`` variable in the
+ :term:`MACHINE_FEATURES_BACKFILL` variable in the
``meta/conf/bitbake.conf`` file. However, your target device does not
have this capability. You can disable RTC support for your device
without affecting other machines that need RTC support by adding the
- feature to your machine's ``MACHINE_FEATURES_BACKFILL_CONSIDERED``
+ feature to your machine's :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`
list in the machine's ``.conf`` file. Adding the feature to this
- variable when it also exists in the ``MACHINE_FEATURES_BACKFILL``
+ variable when it also exists in the :term:`MACHINE_FEATURES_BACKFILL`
variable prevents the build system from adding the feature to your
- configuration's ``MACHINE_FEATURES``, effectively disabling RTC
+ configuration's :term:`MACHINE_FEATURES`, effectively disabling RTC
support for that particular machine.
diff --git a/poky/documentation/ref-manual/images.rst b/poky/documentation/ref-manual/images.rst
index b2db1a7..c6a7239 100644
--- a/poky/documentation/ref-manual/images.rst
+++ b/poky/documentation/ref-manual/images.rst
@@ -46,10 +46,6 @@
- ``core-image-base``: A console-only image that fully supports the
target device hardware.
-- ``core-image-clutter``: An image with support for the Open GL-based
- toolkit Clutter, which enables development of rich and animated
- graphical user interfaces.
-
- ``core-image-full-cmdline``: A console-only image with more
full-featured Linux system functionality installed.
diff --git a/poky/documentation/ref-manual/index.rst b/poky/documentation/ref-manual/index.rst
index deb0383..5cf10c5 100644
--- a/poky/documentation/ref-manual/index.rst
+++ b/poky/documentation/ref-manual/index.rst
@@ -13,7 +13,6 @@
system-requirements
terms
release-process
- migration
structure
classes
tasks
diff --git a/poky/documentation/ref-manual/kickstart.rst b/poky/documentation/ref-manual/kickstart.rst
index 8308fff..a7443f9 100644
--- a/poky/documentation/ref-manual/kickstart.rst
+++ b/poky/documentation/ref-manual/kickstart.rst
@@ -106,13 +106,15 @@
- ``--fstype``: Sets the file system type for the partition. Valid
values are:
- - ``ext4``
+ - ``btrfs``
- - ``ext3``
+ - ``erofs``
- ``ext2``
- - ``btrfs``
+ - ``ext3``
+
+ - ``ext4``
- ``squashfs``
diff --git a/poky/documentation/ref-manual/migration-1.3.rst b/poky/documentation/ref-manual/migration-1.3.rst
deleted file mode 100644
index b90767f..0000000
--- a/poky/documentation/ref-manual/migration-1.3.rst
+++ /dev/null
@@ -1,194 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-
-Moving to the Yocto Project 1.3 Release (danny)
-===============================================
-
-This section provides migration information for moving to the Yocto
-Project 1.3 Release (codename "danny") from the prior release.
-
-.. _1.3-local-configuration:
-
-Local Configuration
--------------------
-
-Differences include changes for
-:term:`SSTATE_MIRRORS` and ``bblayers.conf``.
-
-.. _migration-1.3-sstate-mirrors:
-
-SSTATE_MIRRORS
-~~~~~~~~~~~~~~
-
-The shared state cache (sstate-cache), as pointed to by
-: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
-: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://.* http://someserver.tld/share/sstate/PATH"
-
-.. _migration-1.3-bblayers-conf:
-
-bblayers.conf
-~~~~~~~~~~~~~
-
-The ``meta-yocto`` layer consists of two parts that correspond to the
-Poky reference distribution and the reference hardware Board Support
-Packages (BSPs), respectively: ``meta-yocto`` and ``meta-yocto-bsp``.
-When running BitBake for the first time after upgrading, your
-``conf/bblayers.conf`` file will be updated to handle this change and
-you will be asked to re-run or restart for the changes to take effect.
-
-.. _1.3-recipes:
-
-Recipes
--------
-
-Differences include changes for the following:
-
-.. _migration-1.3-python-function-whitespace:
-
-Python Function Whitespace
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-All Python functions must now use four spaces for indentation.
-Previously, an inconsistent mix of spaces and tabs existed, which made
-extending these functions using ``_append`` or ``_prepend`` complicated
-given that Python treats whitespace as syntactically significant. If you
-are defining or extending any Python functions (e.g.
-``populate_packages``, ``do_unpack``, ``do_patch`` and so forth) in
-custom recipes or classes, you need to ensure you are using consistent
-four-space indentation.
-
-.. _migration-1.3-proto=-in-src-uri:
-
-proto= in SRC_URI
-~~~~~~~~~~~~~~~~~
-
-Any use of ``proto=`` in :term:`SRC_URI` needs to be
-changed to ``protocol=``. In particular, this applies to the following
-URIs:
-
-- ``svn://``
-
-- ``bzr://``
-
-- ``hg://``
-
-- ``osc://``
-
-Other URIs were already using ``protocol=``. This change improves
-consistency.
-
-.. _migration-1.3-nativesdk:
-
-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 :term:`SDK_ARCH`, and any references need to
-be updated to use ``nativesdk-*`` instead of ``*-nativesdk``.
-
-.. _migration-1.3-task-recipes:
-
-Task Recipes
-~~~~~~~~~~~~
-
-"Task" recipes are now known as "Package groups" and have been renamed
-from ``task-*.bb`` to ``packagegroup-*.bb``. Existing references to the
-previous ``task-*`` names should work in most cases as there is an
-automatic upgrade path for most packages. However, you should update
-references in your own recipes and configurations as they could be
-removed in future releases. You should also rename any custom ``task-*``
-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
-:term:`LIC_FILES_CHKSUM`, and so forth. See the
-":ref:`packagegroup.bbclass <ref-classes-packagegroup>`" section for
-further details.
-
-.. _migration-1.3-image-features:
-
-IMAGE_FEATURES
-~~~~~~~~~~~~~~
-
-Image recipes that previously included ``apps-console-core`` in
-: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``
-features have been removed.
-
-.. _migration-1.3-removed-recipes:
-
-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
-:term:`Metadata`. However, you should check your metadata
-against this list to be sure:
-
-- ``libx11-trim``: Replaced by ``libx11``, which has a negligible
- size difference with modern Xorg.
-
-- ``xserver-xorg-lite``: Use ``xserver-xorg``, which has a negligible
- size difference when DRI and GLX modules are not installed.
-
-- ``xserver-kdrive``: Effectively unmaintained for many years.
-
-- ``mesa-xlib``: No longer serves any purpose.
-
-- ``galago``: Replaced by telepathy.
-
-- ``gail``: Functionality was integrated into GTK+ 2.13.
-
-- ``eggdbus``: No longer needed.
-
-- ``gcc-*-intermediate``: The build has been restructured to avoid
- the need for this step.
-
-- ``libgsmd``: Unmaintained for many years. Functionality now
- provided by ``ofono`` instead.
-
-- *contacts, dates, tasks, eds-tools*: Largely unmaintained PIM
- application suite. It has been moved to ``meta-gnome`` in
- ``meta-openembedded``.
-
-In addition to the previously listed changes, the ``meta-demoapps``
-directory has also been removed because the recipes in it were not being
-maintained and many had become obsolete or broken. Additionally, these
-recipes were not parsed in the default configuration. Many of these
-recipes are already provided in an updated and maintained form within
-the OpenEmbedded community layers such as ``meta-oe`` and
-``meta-gnome``. For the remainder, you can now find them in the
-``meta-extras`` repository, which is in the
-:yocto_git:`Source Repositories <>` at
-:yocto_git:`/meta-extras/`.
-
-.. _1.3-linux-kernel-naming:
-
-Linux Kernel Naming
--------------------
-
-The naming scheme for kernel output binaries has been changed to now
-include :term:`PE` as part of the filename::
-
- KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PE}-${PV}-${PR}-${MACHINE}-${DATETIME}"
-
-Because the ``PE`` variable is not set by default, these binary files
-could result with names that include two dash characters. Here is an
-example::
-
- bzImage--3.10.9+git0+cd502a8814_7144bcc4b8-r0-qemux86-64-20130830085431.bin
-
-
diff --git a/poky/documentation/ref-manual/migration-1.4.rst b/poky/documentation/ref-manual/migration-1.4.rst
deleted file mode 100644
index deb8487..0000000
--- a/poky/documentation/ref-manual/migration-1.4.rst
+++ /dev/null
@@ -1,235 +0,0 @@
-Moving to the Yocto Project 1.4 Release (dylan)
-===============================================
-
-This section provides migration information for moving to the Yocto
-Project 1.4 Release (codename "dylan") from the prior release.
-
-.. _migration-1.4-bitbake:
-
-BitBake
--------
-
-Differences include the following:
-
-- *Comment Continuation:* If a comment ends with a line continuation
- (\\) character, then the next line must also be a comment. Any
- instance where this is not the case, now triggers a warning. You must
- either remove the continuation character, or be sure the next line is
- a comment.
-
-- *Package Name Overrides:* The runtime package specific variables
- :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
- instead of ``RDEPENDS``. BitBake uses more strict checks when it
- parses recipes.
-
-.. _migration-1.4-build-behavior:
-
-Build Behavior
---------------
-
-Differences include the following:
-
-- *Shared State Code:* The shared state code has been optimized to
- avoid running unnecessary tasks. For example, the following no longer
- populates the target sysroot since that is not necessary::
-
- $ bitbake -c rootfs some-image
-
- Instead, the system just needs to extract the
- output package contents, re-create the packages, and construct the
- root filesystem. This change is unlikely to cause any problems unless
- you have missing declared dependencies.
-
-- *Scanning Directory Names:* When scanning for files 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 :term:`MACHINEOVERRIDES` or
- :term:`DISTROOVERRIDES` variables, as
- appropriate. For more related changes, see the
- ":ref:`ref-manual/migration-1.4:variables`" section.
-
-.. _migration-1.4-proxies-and-fetching-source:
-
-Proxies and Fetching Source
----------------------------
-
-A new ``oe-git-proxy`` script has been added to replace previous methods
-of handling proxies and fetching source from Git. See the
-``meta-yocto/conf/site.conf.sample`` file for information on how to use
-this script.
-
-.. _migration-1.4-custom-interfaces-file-netbase-change:
-
-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 :term:`Source Directory` at
-``meta/recipes-core/init-ifupdown``. For information on how to use
-append files, see the
-":ref:`dev-manual/common-tasks:using .bbappend files in your layer`"
-section in the Yocto Project Development Tasks Manual.
-
-.. _migration-1.4-remote-debugging:
-
-Remote Debugging
-----------------
-
-Support for remote debugging with the Eclipse IDE is now separated into
-an image feature (``eclipse-debug``) that corresponds to the
-``packagegroup-core-eclipse-debug`` package group. Previously, the
-debugging feature was included through the ``tools-debug`` image
-feature, which corresponds to the ``packagegroup-core-tools-debug``
-package group.
-
-.. _migration-1.4-variables:
-
-Variables
----------
-
-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,
- :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 ``${``\ :term:`PN`\ ``}``,
- ``${``\ :term:`PF`\ ``}``,
- ``${``\ :term:`P`\ ``}``, and ``FILE_DIRNAME`` directories
- have been dropped from the default value of the
- :term:`FILESPATH` variable, which is used as the
- search path for finding files referred to in
- :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 ``${``\ :term:`BP`\ ``}``,
- ``${``\ :term:`BPN`\ ``}``, and "files", which all remain in the default value of
- :term:`FILESPATH`.
-
-.. _migration-target-package-management-with-rpm:
-
-Target Package Management with RPM
-----------------------------------
-
-If runtime package management is enabled and the RPM backend is
-selected, Smart is now installed for package download, dependency
-resolution, and upgrades instead of Zypper. For more information on how
-to use Smart, run the following command on the target::
-
- smart --help
-
-.. _migration-1.4-recipes-moved:
-
-Recipes Moved
--------------
-
-The following recipes were moved from their previous locations because
-they are no longer used by anything in the OpenEmbedded-Core:
-
-- ``clutter-box2d``: Now resides in the ``meta-oe`` layer.
-
-- ``evolution-data-server``: Now resides in the ``meta-gnome`` layer.
-
-- ``gthumb``: Now resides in the ``meta-gnome`` layer.
-
-- ``gtkhtml2``: Now resides in the ``meta-oe`` layer.
-
-- ``gupnp``: Now resides in the ``meta-multimedia`` layer.
-
-- ``gypsy``: Now resides in the ``meta-oe`` layer.
-
-- ``libcanberra``: Now resides in the ``meta-gnome`` layer.
-
-- ``libgdata``: Now resides in the ``meta-gnome`` layer.
-
-- ``libmusicbrainz``: Now resides in the ``meta-multimedia`` layer.
-
-- ``metacity``: Now resides in the ``meta-gnome`` layer.
-
-- ``polkit``: Now resides in the ``meta-oe`` layer.
-
-- ``zeroconf``: Now resides in the ``meta-networking`` layer.
-
-.. _migration-1.4-removals-and-renames:
-
-Removals and Renames
---------------------
-
-The following list shows what has been removed or renamed:
-
-- ``evieext``: Removed because it has been removed from ``xserver``
- since 2008.
-
-- *Gtk+ DirectFB:* Removed support because upstream Gtk+ no longer
- supports it as of version 2.18.
-
-- ``libxfontcache / xfontcacheproto``: Removed because they were
- removed from the Xorg server in 2008.
-
-- ``libxp / libxprintapputil / libxprintutil / printproto``: Removed
- because the XPrint server was removed from Xorg in 2008.
-
-- ``libxtrap / xtrapproto``: Removed because their functionality was
- broken upstream.
-
-- *linux-yocto 3.0 kernel:* Removed with linux-yocto 3.8 kernel being
- added. The linux-yocto 3.2 and linux-yocto 3.4 kernels remain as part
- of the release.
-
-- ``lsbsetup``: Removed with functionality now provided by
- ``lsbtest``.
-
-- ``matchbox-stroke``: Removed because it was never more than a
- proof-of-concept.
-
-- ``matchbox-wm-2 / matchbox-theme-sato-2``: Removed because they are
- not maintained. However, ``matchbox-wm`` and ``matchbox-theme-sato``
- are still provided.
-
-- ``mesa-dri``: Renamed to ``mesa``.
-
-- ``mesa-xlib``: Removed because it was no longer useful.
-
-- ``mutter``: Removed because nothing ever uses it and the recipe is
- very old.
-
-- ``orinoco-conf``: Removed because it has become obsolete.
-
-- ``update-modules``: Removed because it is no longer used. The
- kernel module ``postinstall`` and ``postrm`` scripts can now do the
- same task without the use of this script.
-
-- ``web``: Removed because it is not maintained. Superseded by
- ``web-webkit``.
-
-- ``xf86bigfontproto``: Removed because upstream it has been disabled
- by default since 2007. Nothing uses ``xf86bigfontproto``.
-
-- ``xf86rushproto``: Removed because its dependency in ``xserver``
- was spurious and it was removed in 2005.
-
-- ``zypper / libzypp / sat-solver``: Removed and been functionally
- replaced with Smart (``python-smartpm``) when RPM packaging is used
- and package management is enabled on the target.
-
diff --git a/poky/documentation/ref-manual/migration-1.5.rst b/poky/documentation/ref-manual/migration-1.5.rst
deleted file mode 100644
index c772e51..0000000
--- a/poky/documentation/ref-manual/migration-1.5.rst
+++ /dev/null
@@ -1,353 +0,0 @@
-Moving to the Yocto Project 1.5 Release (dora)
-==============================================
-
-This section provides migration information for moving to the Yocto
-Project 1.5 Release (codename "dora") from the prior release.
-
-.. _migration-1.5-host-dependency-changes:
-
-Host Dependency Changes
------------------------
-
-The OpenEmbedded build system now has some additional requirements on
-the host system:
-
-- Python 2.7.3+
-
-- Tar 1.24+
-
-- Git 1.7.8+
-
-- Patched version of Make if you are using 3.82. Most distributions
- that provide Make 3.82 use the patched version.
-
-If the Linux distribution you are using on your build host does not
-provide packages for these, you can install and use the Buildtools
-tarball, which provides an SDK-like environment containing them.
-
-For more information on this requirement, see the
-":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`"
-section.
-
-.. _migration-1.5-atom-pc-bsp:
-
-``atom-pc`` Board Support Package (BSP)
----------------------------------------
-
-The ``atom-pc`` hardware reference BSP has been replaced by a
-``genericx86`` BSP. This BSP is not necessarily guaranteed to work on
-all x86 hardware, but it will run on a wider range of systems than the
-``atom-pc`` did.
-
-.. note::
-
- Additionally, a ``genericx86-64`` BSP has been added for 64-bit Atom
- systems.
-
-.. _migration-1.5-bitbake:
-
-BitBake
--------
-
-The following changes have been made that relate to BitBake:
-
-- BitBake now supports a ``_remove`` operator. The addition of this
- operator means you will have to rename any items in recipe space
- (functions, variables) whose names currently contain ``_remove_`` or
- end with ``_remove`` to avoid unexpected behavior.
-
-- BitBake's global method pool has been removed. This method is not
- particularly useful and led to clashes between recipes containing
- functions that had the same name.
-
-- The "none" server backend has been removed. The "process" server
- backend has been serving well as the default for a long time now.
-
-- The ``bitbake-runtask`` script has been removed.
-
-- ``${``\ :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
- resolves dependencies.
-
-.. _migration-1.5-qa-warnings:
-
-QA Warnings
------------
-
-The following changes have been made to the package QA checks:
-
-- 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 ":ref:`insane.bbclass <ref-classes-insane>`"
- 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 :ref:`ref-tasks-install` if "make
- install" is installing it.
-
-- If you are using the ``buildhistory`` class, the check for the package
- version going backwards is now controlled using a standard QA check.
- Thus, if you have customized your ``ERROR_QA`` or ``WARN_QA`` values
- and still wish to have this check performed, you should add
- "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
- ":ref:`insane.bbclass <ref-classes-insane>`" section.
-
-.. _migration-1.5-directory-layout-changes:
-
-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 :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
- :term:`DEPLOY_DIR_IMAGE` variable continues
- to point to the directory containing images for the current
- :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
- :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 :term:`IMAGE_NAME`.
-
-- The ``pkgdata`` directory produced as part of the packaging process
- has been collapsed into a single machine-specific directory. This
- directory is located under ``sysroots`` and uses a machine-specific
- name (i.e. ``tmp/sysroots/machine/pkgdata``).
-
-.. _migration-1.5-shortened-git-srcrev-values:
-
-Shortened Git ``SRCREV`` Values
--------------------------------
-
-BitBake will now shorten revisions from Git repositories from the normal
-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
-major issue in the way the values are used.
-
-.. _migration-1.5-image-features:
-
-``IMAGE_FEATURES``
-------------------
-
-The following changes have been made that relate to
-: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
- :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,
- :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.
-
-- The previously deprecated "apps-console-core" ``IMAGE_FEATURES`` item
- is no longer supported. Add "splash" to ``IMAGE_FEATURES`` if you
- wish to have the splash screen enabled, since this is all that
- apps-console-core was doing.
-
-.. _migration-1.5-run:
-
-``/run``
---------
-
-The ``/run`` directory from the Filesystem Hierarchy Standard 3.0 has
-been introduced. You can find some of the implications for this change
-:oe_git:`here </openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873>`.
-The change also means that recipes that install files to ``/var/run``
-must be changed. You can find a guide on how to make these changes
-`here <https://www.mail-archive.com/openembedded-devel@lists.openembedded.org/msg31649.html>`__.
-
-.. _migration-1.5-removal-of-package-manager-database-within-image-recipes:
-
-Removal of Package Manager Database Within Image Recipes
---------------------------------------------------------
-
-The image ``core-image-minimal`` no longer adds
-``remove_packaging_data_files`` to
-:term:`ROOTFS_POSTPROCESS_COMMAND`.
-This addition is now handled automatically when "package-management" is
-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.
-
-.. _migration-1.5-images-now-rebuild-only-on-changes-instead-of-every-time:
-
-Images Now Rebuild Only on Changes Instead of Every Time
---------------------------------------------------------
-
-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
-requested rather when necessary.
-
-.. _migration-1.5-task-recipes:
-
-Task Recipes
-------------
-
-The previously deprecated ``task.bbclass`` has now been dropped. For
-recipes that previously inherited from this class, you should rename
-them from ``task-*`` to ``packagegroup-*`` and inherit packagegroup
-instead.
-
-For more information, see the
-":ref:`packagegroup.bbclass <ref-classes-packagegroup>`" section.
-
-.. _migration-1.5-busybox:
-
-BusyBox
--------
-
-By default, we now split BusyBox into two binaries: one that is suid
-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
-:term:`BUSYBOX_SPLIT_SUID` to "0".
-
-.. _migration-1.5-automated-image-testing:
-
-Automated Image Testing
------------------------
-
-A new automated image testing framework has been added through the
-:ref:`testimage.bbclass <ref-classes-testimage*>` class. This
-framework replaces the older ``imagetest-qemu`` framework.
-
-You can learn more about performing automated image tests in the
-":ref:`dev-manual/common-tasks:performing automated runtime testing`"
-section in the Yocto Project Development Tasks Manual.
-
-.. _migration-1.5-build-history:
-
-Build History
--------------
-
-Following are changes to Build History:
-
-- Installed package sizes: ``installed-package-sizes.txt`` for an image
- now records the size of the files installed by each package instead
- of the size of each compressed package archive file.
-
-- The dependency graphs (``depends*.dot``) now use the actual package
- names instead of replacing dashes, dots and plus signs with
- underscores.
-
-- The ``buildhistory-diff`` and ``buildhistory-collect-srcrevs``
- utilities have improved command-line handling. Use the ``--help``
- option for each utility for more information on the new syntax.
-
-For more information on Build History, see the
-":ref:`dev-manual/common-tasks:maintaining build output quality`"
-section in the Yocto Project Development Tasks Manual.
-
-.. _migration-1.5-udev:
-
-``udev``
---------
-
-Following are changes to ``udev``:
-
-- ``udev`` no longer brings in ``udev-extraconf`` automatically through
- :term:`RRECOMMENDS`, since this was originally
- intended to be optional. If you need the extra rules, then add
- ``udev-extraconf`` to your image.
-
-- ``udev`` no longer brings in ``pciutils-ids`` or ``usbutils-ids``
- through ``RRECOMMENDS``. These are not needed by ``udev`` itself and
- removing them saves around 350KB.
-
-.. _migration-1.5-removed-renamed-recipes:
-
-Removed and Renamed Recipes
----------------------------
-
-- The ``linux-yocto`` 3.2 kernel has been removed.
-
-- ``libtool-nativesdk`` has been renamed to ``nativesdk-libtool``.
-
-- ``tinylogin`` has been removed. It has been replaced by a suid
- portion of Busybox. See the ":ref:`migration-1.5-busybox`"
- section for more information.
-
-- ``external-python-tarball`` has been renamed to
- ``buildtools-tarball``.
-
-- ``web-webkit`` has been removed. It has been functionally replaced by
- ``midori``.
-
-- ``imake`` has been removed. It is no longer needed by any other
- recipe.
-
-- ``transfig-native`` has been removed. It is no longer needed by any
- other recipe.
-
-- ``anjuta-remote-run`` has been removed. Anjuta IDE integration has
- not been officially supported for several releases.
-
-.. _migration-1.5-other-changes:
-
-Other Changes
--------------
-
-Following is a list of short entries describing other changes:
-
-- ``run-postinsts``: Make this generic.
-
-- ``base-files``: Remove the unnecessary ``media/``\ xxx directories.
-
-- ``alsa-state``: Provide an empty ``asound.conf`` by default.
-
-- ``classes/image``: Ensure
- :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
- :term:`DISTRO_FEATURES`.
-
-- ``systemd``: Remove ``init.d`` dir if ``systemd`` unit file is
- present and ``sysvinit`` is not a distro feature.
-
-- ``libpam``: Deny all services for the ``OTHER`` entries.
-
-- ``image.bbclass``: Move ``runtime_mapping_rename`` to avoid conflict
- with ``multilib``. See :yocto_bugs:`YOCTO #4993 </show_bug.cgi?id=4993>`
- in Bugzilla for more information.
-
-- ``linux-dtb``: Use kernel build system to generate the ``dtb`` files.
-
-- ``kern-tools``: Switch from guilt to new ``kgit-s2q`` tool.
-
diff --git a/poky/documentation/ref-manual/migration-1.6.rst b/poky/documentation/ref-manual/migration-1.6.rst
deleted file mode 100644
index 5a18d63..0000000
--- a/poky/documentation/ref-manual/migration-1.6.rst
+++ /dev/null
@@ -1,414 +0,0 @@
-Moving to the Yocto Project 1.6 Release (daisy)
-===============================================
-
-This section provides migration information for moving to the Yocto
-Project 1.6 Release (codename "daisy") from the prior release.
-
-.. _migration-1.6-archiver-class:
-
-``archiver`` Class
-------------------
-
-The :ref:`archiver <ref-classes-archiver>` class has been rewritten
-and its configuration has been simplified. For more details on the
-source archiver, see the
-":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`"
-section in the Yocto Project Development Tasks Manual.
-
-.. _migration-1.6-packaging-changes:
-
-Packaging Changes
------------------
-
-The following packaging changes have been made:
-
-- The ``binutils`` recipe no longer produces a ``binutils-symlinks``
- package. ``update-alternatives`` is now used to handle the preferred
- ``binutils`` variant on the target instead.
-
-- The tc (traffic control) utilities have been split out of the main
- ``iproute2`` package and put into the ``iproute2-tc`` package.
-
-- The ``gtk-engines`` schemas have been moved to a dedicated
- ``gtk-engines-schemas`` package.
-
-- The ``armv7a`` with thumb package architecture suffix has changed.
- The suffix for these packages with the thumb optimization enabled is
- "t2" as it should be. Use of this suffix was not the case in the 1.5
- release. Architecture names will change within package feeds as a
- result.
-
-.. _migration-1.6-bitbake:
-
-BitBake
--------
-
-The following changes have been made to :term:`BitBake`.
-
-.. _migration-1.6-matching-branch-requirement-for-git-fetching:
-
-Matching Branch Requirement for Git Fetching
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-When fetching source from a Git repository using
-: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.
-
-Alternatively, if you need to bypass this check (e.g. if you are
-fetching a revision corresponding to a tag that is not on any branch),
-you can add ";nobranch=1" to the end of the URL within ``SRC_URI``.
-
-.. _migration-1.6-bitbake-deps:
-
-Python Definition substitutions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-BitBake had some previously deprecated Python definitions within its
-``bb`` module removed. You should use their sub-module counterparts
-instead:
-
-- ``bb.MalformedUrl``: Use ``bb.fetch.MalformedUrl``.
-
-- ``bb.encodeurl``: Use ``bb.fetch.encodeurl``.
-
-- ``bb.decodeurl``: Use ``bb.fetch.decodeurl``
-
-- ``bb.mkdirhier``: Use ``bb.utils.mkdirhier``.
-
-- ``bb.movefile``: Use ``bb.utils.movefile``.
-
-- ``bb.copyfile``: Use ``bb.utils.copyfile``.
-
-- ``bb.which``: Use ``bb.utils.which``.
-
-- ``bb.vercmp_string``: Use ``bb.utils.vercmp_string``.
-
-- ``bb.vercmp``: Use ``bb.utils.vercmp``.
-
-.. _migration-1.6-bitbake-fetcher:
-
-SVK Fetcher
-~~~~~~~~~~~
-
-The SVK fetcher has been removed from BitBake.
-
-.. _migration-1.6-bitbake-console-output:
-
-Console Output Error Redirection
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The BitBake console UI will now output errors to ``stderr`` instead of
-``stdout``. Consequently, if you are piping or redirecting the output of
-``bitbake`` to somewhere else, and you wish to retain the errors, you
-will need to add ``2>&1`` (or something similar) to the end of your
-``bitbake`` command line.
-
-.. _migration-1.6-task-taskname-overrides:
-
-``task-``\ taskname Overrides
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-``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 :ref:`ref-tasks-populate_sdk` is
-``task-populate-sdk``.
-
-.. _migration-1.6-variable-changes:
-
-Changes to Variables
---------------------
-
-The following variables have changed. For information on the
-OpenEmbedded build system variables, see the ":doc:`/ref-manual/variables`" Chapter.
-
-.. _migration-1.6-variable-changes-TMPDIR:
-
-``TMPDIR``
-~~~~~~~~~~
-
-: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``.
-
-The check for this occurs on startup. If ``TMPDIR`` is detected on an
-NFS mount, an error occurs.
-
-.. _migration-1.6-variable-changes-PRINC:
-
-``PRINC``
-~~~~~~~~~
-
-The ``PRINC`` variable has been deprecated and triggers a warning if
-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 ":ref:`dev-manual/common-tasks:working with a pr service`"
-section in the Yocto Project Development Tasks Manual.
-
-.. _migration-1.6-variable-changes-IMAGE_TYPES:
-
-``IMAGE_TYPES``
-~~~~~~~~~~~~~~~
-
-The "sum.jffs2" option for :term:`IMAGE_TYPES` has
-been replaced by the "jffs2.sum" option, which fits the processing
-order.
-
-.. _migration-1.6-variable-changes-COPY_LIC_MANIFEST:
-
-``COPY_LIC_MANIFEST``
-~~~~~~~~~~~~~~~~~~~~~
-
-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:
-
-``COPY_LIC_DIRS``
-~~~~~~~~~~~~~~~~~
-
-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:
-
-``PACKAGE_GROUP``
-~~~~~~~~~~~~~~~~~
-
-The ``PACKAGE_GROUP`` variable has been renamed to
-: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.
-
-.. _migration-1.6-variable-changes-variable-entry-behavior:
-
-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:
-
- - :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
- }
- ROOTFS_POSTPROCESS_COMMAND += "my_postprocess_function; "
-
-.. _migration-1.6-package-test-ptest:
-
-Package Test (ptest)
---------------------
-
-Package Tests (ptest) are built but not installed by default. For
-information on using Package Tests, see the
-":ref:`dev-manual/common-tasks:testing packages with ptest`"
-section in the Yocto Project Development Tasks Manual. For information on the
-``ptest`` class, see the ":ref:`ptest.bbclass <ref-classes-ptest>`"
-section.
-
-.. _migration-1.6-build-changes:
-
-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 :ref:`cmake <ref-classes-cmake>` class. In
-future releases the :ref:`autotools <ref-classes-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
-:ref:`autotools-brokensep <ref-classes-autotools>` class instead of
-the ``autotools`` or ``autotools_stage``\ classes.
-
-.. _migration-1.6-building-qemu-native:
-
-``qemu-native``
----------------
-
-``qemu-native`` now builds without SDL-based graphical output support by
-default. The following additional lines are needed in your
-``local.conf`` to enable it::
-
- PACKAGECONFIG_pn-qemu-native = "sdl"
- ASSUME_PROVIDED += "libsdl-native"
-
-.. note::
-
- The default ``local.conf`` contains these statements. Consequently, if you
- are building a headless system and using a default ``local.conf``
- file, you will need comment these two lines out.
-
-.. _migration-1.6-core-image-basic:
-
-``core-image-basic``
---------------------
-
-``core-image-basic`` has been renamed to ``core-image-full-cmdline``.
-
-In addition to ``core-image-basic`` being renamed,
-``packagegroup-core-basic`` has been renamed to
-``packagegroup-core-full-cmdline`` to match.
-
-.. _migration-1.6-licensing:
-
-Licensing
----------
-
-The top-level ``LICENSE`` file has been changed to better describe the
-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
-: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
-``LIC_FILES_CHKSUM`` point to a file describing the license that is
-distributed with the source that the recipe is building, if possible,
-rather than pointing to ``${COREBASE}/LICENSE``.
-
-.. _migration-1.6-cflags-options:
-
-``CFLAGS`` Options
-------------------
-
-The "-fpermissive" option has been removed from the default
-: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.
-
-.. _migration-1.6-custom-images:
-
-Custom Image Output Types
--------------------------
-
-Custom image output types, as selected using
-:term:`IMAGE_FSTYPES`, must declare their
-dependencies on other image types (if any) using a new
-:term:`IMAGE_TYPEDEP` variable.
-
-.. _migration-1.6-do-package-write-task:
-
-Tasks
------
-
-The ``do_package_write`` task has been removed. The task is no longer
-needed.
-
-.. _migration-1.6-update-alternatives-provider:
-
-``update-alternative`` Provider
--------------------------------
-
-The default ``update-alternatives`` provider has been changed from
-``opkg`` to ``opkg-utils``. This change resolves some troublesome
-circular dependencies. The runtime package has also been renamed from
-``update-alternatives-cworth`` to ``update-alternatives-opkg``.
-
-.. _migration-1.6-virtclass-overrides:
-
-``virtclass`` Overrides
------------------------
-
-The ``virtclass`` overrides are now deprecated. Use the equivalent class
-overrides instead (e.g. ``virtclass-native`` becomes ``class-native``.)
-
-.. _migration-1.6-removed-renamed-recipes:
-
-Removed and Renamed Recipes
----------------------------
-
-The following recipes have been removed:
-
-- ``packagegroup-toolset-native`` - This recipe is largely unused.
-
-- ``linux-yocto-3.8`` - Support for the Linux yocto 3.8 kernel has been
- dropped. Support for the 3.10 and 3.14 kernels have been added with
- the ``linux-yocto-3.10`` and ``linux-yocto-3.14`` recipes.
-
-- ``ocf-linux`` - This recipe has been functionally replaced using
- ``cryptodev-linux``.
-
-- ``genext2fs`` - ``genext2fs`` is no longer used by the build system
- and is unmaintained upstream.
-
-- ``js`` - This provided an ancient version of Mozilla's javascript
- engine that is no longer needed.
-
-- ``zaurusd`` - The recipe has been moved to the ``meta-handheld``
- layer.
-
-- ``eglibc 2.17`` - Replaced by the ``eglibc 2.19`` recipe.
-
-- ``gcc 4.7.2`` - Replaced by the now stable ``gcc 4.8.2``.
-
-- ``external-sourcery-toolchain`` - this recipe is now maintained in
- the ``meta-sourcery`` layer.
-
-- ``linux-libc-headers-yocto 3.4+git`` - Now using version 3.10 of the
- ``linux-libc-headers`` by default.
-
-- ``meta-toolchain-gmae`` - This recipe is obsolete.
-
-- ``packagegroup-core-sdk-gmae`` - This recipe is obsolete.
-
-- ``packagegroup-core-standalone-gmae-sdk-target`` - This recipe is
- obsolete.
-
-.. _migration-1.6-removed-classes:
-
-Removed Classes
----------------
-
-The following classes have become obsolete and have been removed:
-
-- ``module_strip``
-
-- ``pkg_metainfo``
-
-- ``pkg_distribute``
-
-- ``image-empty``
-
-.. _migration-1.6-reference-bsps:
-
-Reference Board Support Packages (BSPs)
----------------------------------------
-
-The following reference BSPs changes occurred:
-
-- The BeagleBoard (``beagleboard``) ARM reference hardware has been
- replaced by the BeagleBone (``beaglebone``) hardware.
-
-- The RouterStation Pro (``routerstationpro``) MIPS reference hardware
- has been replaced by the EdgeRouter Lite (``edgerouter``) hardware.
-
-The previous reference BSPs for the ``beagleboard`` and
-``routerstationpro`` machines are still available in a new
-``meta-yocto-bsp-old`` layer in the
-:yocto_git:`Source Repositories <>` at
-:yocto_git:`/meta-yocto-bsp-old/`.
-
-
diff --git a/poky/documentation/ref-manual/migration-1.7.rst b/poky/documentation/ref-manual/migration-1.7.rst
deleted file mode 100644
index 46bf126..0000000
--- a/poky/documentation/ref-manual/migration-1.7.rst
+++ /dev/null
@@ -1,221 +0,0 @@
-Moving to the Yocto Project 1.7 Release (dizzy)
-===============================================
-
-This section provides migration information for moving to the Yocto
-Project 1.7 Release (codename "dizzy") from the prior release.
-
-.. _migration-1.7-changes-to-setting-qemu-packageconfig-options:
-
-Changes to Setting QEMU ``PACKAGECONFIG`` Options in ``local.conf``
--------------------------------------------------------------------
-
-The QEMU recipe now uses a number of
-: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 modified to
-append to ``PACKAGECONFIG`` for ``qemu-native`` and ``nativesdk-qemu``
-instead of setting it. In other words, to enable graphical output for
-QEMU, you should now have these lines in ``local.conf``::
-
- PACKAGECONFIG_append_pn-qemu-native = " sdl"
- PACKAGECONFIG_append_pn-nativesdk-qemu = " sdl"
-
-.. _migration-1.7-minimum-git-version:
-
-Minimum Git version
--------------------
-
-The minimum :ref:`overview-manual/development-environment:git`
-version required on the
-build host is now 1.7.8 because the ``--list`` option is now required by
-BitBake's Git fetcher. As always, if your host distribution does not
-provide a version of Git that meets this requirement, you can use the
-``buildtools-tarball`` that does. See the
-":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`"
-section for more information.
-
-.. _migration-1.7-autotools-class-changes:
-
-Autotools Class Changes
------------------------
-
-The following :ref:`autotools <ref-classes-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
- (: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
- directory separate from the source, you do not need to do anything.
- However, if the software is not capable of being built in this
- manner, you will need to either patch the software so that it can
- build separately, or you will need to change the recipe to inherit
- the :ref:`autotools-brokensep <ref-classes-autotools>` class
- instead of the ``autotools`` or ``autotools_stage`` classes.
-
-- The ``--foreign`` option is no longer passed to ``automake`` when
- running ``autoconf``: This option tells ``automake`` that a
- particular software package does not follow the GNU standards and
- therefore should not be expected to distribute certain files such as
- ``ChangeLog``, ``AUTHORS``, and so forth. Because the majority of
- upstream software packages already tell ``automake`` to enable
- foreign mode themselves, the option is mostly superfluous. However,
- some recipes will need patches for this change. You can easily make
- the change by patching ``configure.ac`` so that it passes "foreign"
- to ``AM_INIT_AUTOMAKE()``. See :oe_git:`this
- commit </openembedded-core/commit/?id=01943188f85ce6411717fb5bf702d609f55813f2>`
- for an example showing how to make the patch.
-
-.. _migration-1.7-binary-configuration-scripts-disabled:
-
-Binary Configuration Scripts Disabled
--------------------------------------
-
-Some of the core recipes that package binary configuration scripts now
-disable the scripts due to the scripts previously requiring error-prone
-path substitution. Software that links against these libraries using
-these scripts should use the much more robust ``pkg-config`` instead.
-The list of recipes changed in this version (and their configuration
-scripts) is as follows::
-
- directfb (directfb-config)
- freetype (freetype-config)
- gpgme (gpgme-config)
- libassuan (libassuan-config)
- libcroco (croco-6.0-config)
- libgcrypt (libgcrypt-config)
- libgpg-error (gpg-error-config)
- libksba (ksba-config)
- libpcap (pcap-config)
- libpcre (pcre-config)
- libpng (libpng-config, libpng16-config)
- libsdl (sdl-config)
- libusb-compat (libusb-config)
- libxml2 (xml2-config)
- libxslt (xslt-config)
- ncurses (ncurses-config)
- neon (neon-config)
- npth (npth-config)
- pth (pth-config)
- taglib (taglib-config)
-
-Additionally, support for ``pkg-config`` has been added to some recipes in the
-previous list in the rare cases where the upstream software package does
-not already provide it.
-
-.. _migration-1.7-glibc-replaces-eglibc:
-
-``eglibc 2.19`` Replaced with ``glibc 2.20``
---------------------------------------------
-
-Because ``eglibc`` and ``glibc`` were already fairly close, this
-replacement should not require any significant changes to other software
-that links to ``eglibc``. However, there were a number of minor changes
-in ``glibc 2.20`` upstream that could require patching some software
-(e.g. the removal of the ``_BSD_SOURCE`` feature test macro).
-
-``glibc 2.20`` requires version 2.6.32 or greater of the Linux kernel.
-Thus, older kernels will no longer be usable in conjunction with it.
-
-For full details on the changes in ``glibc 2.20``, see the upstream
-release notes
-`here <https://sourceware.org/ml/libc-alpha/2014-09/msg00088.html>`__.
-
-.. _migration-1.7-kernel-module-autoloading:
-
-Kernel Module Autoloading
--------------------------
-
-The :term:`module_autoload_* <module_autoload>` variable is now
-deprecated and a new
-:term:`KERNEL_MODULE_AUTOLOAD` variable
-should be used instead. Also, :term:`module_conf_* <module_conf>`
-must now be used in conjunction with a new
-: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
-incorporated into task signatures and thus trigger the appropriate tasks
-to re-execute when changed. You should replace any references to
-``module_autoload_*`` with ``KERNEL_MODULE_AUTOLOAD``, and add any
-modules for which ``module_conf_*`` is specified to
-``KERNEL_MODULE_PROBECONF``.
-
-.. _migration-1.7-qa-check-changes:
-
-QA Check Changes
-----------------
-
-The following changes have occurred to the QA check process:
-
-- Additional QA checks ``file-rdeps`` and ``build-deps`` have been
- added in order to verify that file dependencies are satisfied (e.g.
- package contains a script requiring ``/bin/bash``) and build-time
- dependencies are declared, respectively. For more information, please
- see the ":doc:`/ref-manual/qa-checks`" chapter.
-
-- Package QA checks are now performed during a new
- :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
- :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
- not overwrite these files.
-
- 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 :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
- as normal.
-
-.. _migration-1.7-removed-recipes:
-
-Removed Recipes
----------------
-
-The following recipes have been removed:
-
-- ``x-load``: This recipe has been superseded by U-Boot SPL for all
- Cortex-based TI SoCs. For legacy boards, the ``meta-ti`` layer, which
- contains a maintained recipe, should be used instead.
-
-- ``ubootchart``: This recipe is obsolete. A ``bootchart2`` recipe has
- been added to functionally replace it.
-
-- ``linux-yocto 3.4``: Support for the linux-yocto 3.4 kernel has been
- dropped. Support for the 3.10 and 3.14 kernels remains, while support
- for version 3.17 has been added.
-
-- ``eglibc`` has been removed in favor of ``glibc``. See the
- ":ref:`migration-1.7-glibc-replaces-eglibc`" section for more information.
-
-.. _migration-1.7-miscellaneous-changes:
-
-Miscellaneous Changes
----------------------
-
-The following miscellaneous change occurred:
-
-- The build history feature now writes ``build-id.txt`` instead of
- ``build-id``. Additionally, ``build-id.txt`` now contains the full
- build header as printed by BitBake upon starting the build. You
- should manually remove old "build-id" files from your existing build
- history repositories to avoid confusion. For information on the build
- history feature, see the
- ":ref:`dev-manual/common-tasks:maintaining build output quality`"
- section in the Yocto Project Development Tasks Manual.
-
-
diff --git a/poky/documentation/ref-manual/migration-1.8.rst b/poky/documentation/ref-manual/migration-1.8.rst
deleted file mode 100644
index 68d5dcf..0000000
--- a/poky/documentation/ref-manual/migration-1.8.rst
+++ /dev/null
@@ -1,183 +0,0 @@
-Moving to the Yocto Project 1.8 Release (fido)
-==============================================
-
-This section provides migration information for moving to the Yocto
-Project 1.8 Release (codename "fido") from the prior release.
-
-.. _migration-1.8-removed-recipes:
-
-Removed Recipes
----------------
-
-The following recipes have been removed:
-
-- ``owl-video``: Functionality replaced by ``gst-player``.
-
-- ``gaku``: Functionality replaced by ``gst-player``.
-
-- ``gnome-desktop``: This recipe is now available in ``meta-gnome`` and
- is no longer needed.
-
-- ``gsettings-desktop-schemas``: This recipe is now available in
- ``meta-gnome`` and is no longer needed.
-
-- ``python-argparse``: The ``argparse`` module is already provided in
- the default Python distribution in a package named
- ``python-argparse``. Consequently, the separate ``python-argparse``
- recipe is no longer needed.
-
-- ``telepathy-python, libtelepathy, telepathy-glib, telepathy-idle, telepathy-mission-control``:
- All these recipes have moved to ``meta-oe`` and are consequently no
- longer needed by any recipes in OpenEmbedded-Core.
-
-- ``linux-yocto_3.10`` and ``linux-yocto_3.17``: Support for the
- linux-yocto 3.10 and 3.17 kernels has been dropped. Support for the
- 3.14 kernel remains, while support for 3.19 kernel has been added.
-
-- ``poky-feed-config-opkg``: This recipe has become obsolete and is no
- longer needed. Use ``distro-feed-config`` from ``meta-oe`` instead.
-
-- ``libav 0.8.x``: ``libav 9.x`` is now used.
-
-- ``sed-native``: No longer needed. A working version of ``sed`` is
- expected to be provided by the host distribution.
-
-.. _migration-1.8-bluez:
-
-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
-:term:`DISTRO_FEATURES` value. If you had
-previously added append files (``*.bbappend``) to make this selection,
-you can now remove them.
-
-Additionally, a ``bluetooth`` class has been added to make selection of
-the appropriate bluetooth support within a recipe a little easier. If
-you wish to make use of this class in a recipe, add something such as
-the following::
-
- inherit bluetooth
- PACKAGECONFIG ??= "${@bb.utils.contains('DISTRO_FEATURES', 'bluetooth', '${BLUEZ}', '', d)}"
- PACKAGECONFIG[bluez4] = "--enable-bluetooth,--disable-bluetooth,bluez4"
- PACKAGECONFIG[bluez5] = "--enable-bluez5,--disable-bluez5,bluez5"
-
-.. _migration-1.8-kernel-build-changes:
-
-Kernel Build Changes
---------------------
-
-The kernel build process was changed to place the source in a common
-shared work area and to place build artifacts separately in the source
-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
-: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
-:oe_git:`commit </meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>`
-where the ``linux.inc`` file in ``meta-oe`` was updated.
-
-Recipes that rely on the kernel source code and do not inherit the
-module classes might need to add explicit dependencies on the
-``do_shared_workdir`` kernel task, for example::
-
- do_configure[depends] += "virtual/kernel:do_shared_workdir"
-
-.. _migration-1.8-ssl:
-
-SSL 3.0 is Now Disabled in OpenSSL
-----------------------------------
-
-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
-:term:`EXTRA_OECONF`.
-
-.. _migration-1.8-default-sysroot-poisoning:
-
-Default Sysroot Poisoning
--------------------------
-
-``gcc's`` default sysroot and include directories are now "poisoned". In
-other words, the sysroot and include directories are being redirected to
-a non-existent location in order to catch when host directories are
-being used due to the correct options not being passed. This poisoning
-applies both to the cross-compiler used within the build and to the
-cross-compiler produced in the SDK.
-
-If this change causes something in the build to fail, it almost
-certainly means the various compiler flags and commands are not being
-passed correctly to the underlying piece of software. In such cases, you
-need to take corrective steps.
-
-.. _migration-1.8-rebuild-improvements:
-
-Rebuild Improvements
---------------------
-
-Changes have been made to the :ref:`base <ref-classes-base>`,
-:ref:`autotools <ref-classes-autotools>`, and
-:ref:`cmake <ref-classes-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
-:term:`CLEANBROKEN` to "1" within the recipe, for example::
-
- CLEANBROKEN = "1"
-
-.. _migration-1.8-qa-check-and-validation-changes:
-
-QA Check and Validation Changes
--------------------------------
-
-The following QA Check and Validation Changes have occurred:
-
-- Usage of ``PRINC`` previously triggered a warning. It now triggers an
- error. You should remove any remaining usage of ``PRINC`` in any
- recipe or append file.
-
-- An additional QA check has been added to detect usage of ``${D}`` in
- :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}``.
-
-- :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 :ref:`ref-tasks-unpack` task
- finishes, a warning will be shown.
-
-- :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.
-
-.. _migration-1.8-miscellaneous-changes:
-
-Miscellaneous Changes
----------------------
-
-The following miscellaneous changes have occurred:
-
-- The ``send-error-report`` script now expects a "-s" option to be
- specified before the server address. This assumes a server address is
- being specified.
-
-- 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 :term:`PKGDATA_DIR` from the
- build environment.
-
-
diff --git a/poky/documentation/ref-manual/migration-2.0.rst b/poky/documentation/ref-manual/migration-2.0.rst
deleted file mode 100644
index 8319b0e..0000000
--- a/poky/documentation/ref-manual/migration-2.0.rst
+++ /dev/null
@@ -1,278 +0,0 @@
-Moving to the Yocto Project 2.0 Release (jethro)
-================================================
-
-This section provides migration information for moving to the Yocto
-Project 2.0 Release (codename "jethro") from the prior release.
-
-.. _migration-2.0-gcc-5:
-
-GCC 5
------
-
-The default compiler is now GCC 5.2. This change has required fixes for
-compilation errors in a number of other recipes.
-
-One important example is a fix for when the Linux kernel freezes at boot
-time on ARM when built with GCC 5. If you are using your own kernel
-recipe or source tree and building for ARM, you will likely need to
-apply this
-`patch <https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit?id=a077224fd35b2f7fbc93f14cf67074fc792fbac2>`__.
-The standard ``linux-yocto`` kernel source tree already has a workaround
-for the same issue.
-
-For further details, see https://gcc.gnu.org/gcc-5/changes.html
-and the porting guide at
-https://gcc.gnu.org/gcc-5/porting_to.html.
-
-Alternatively, you can switch back to GCC 4.9 or 4.8 by setting
-``GCCVERSION`` in your configuration, as follows::
-
- GCCVERSION = "4.9%"
-
-.. _migration-2.0-Gstreamer-0.10-removed:
-
-Gstreamer 0.10 Removed
-----------------------
-
-Gstreamer 0.10 has been removed in favor of Gstreamer 1.x. As part of
-the change, recipes for Gstreamer 0.10 and related software are now
-located in ``meta-multimedia``. This change results in Qt4 having Phonon
-and Gstreamer support in QtWebkit disabled by default.
-
-.. _migration-2.0-removed-recipes:
-
-Removed Recipes
----------------
-
-The following recipes have been moved or removed:
-
-- ``bluez4``: The recipe is obsolete and has been moved due to
- ``bluez5`` becoming fully integrated. The ``bluez4`` recipe now
- resides in ``meta-oe``.
-
-- ``gamin``: The recipe is obsolete and has been removed.
-
-- ``gnome-icon-theme``: The recipe's functionally has been replaced by
- ``adwaita-icon-theme``.
-
-- Gstreamer 0.10 Recipes: Recipes for Gstreamer 0.10 have been removed
- in favor of the recipes for Gstreamer 1.x.
-
-- ``insserv``: The recipe is obsolete and has been removed.
-
-- ``libunique``: The recipe is no longer used and has been moved to
- ``meta-oe``.
-
-- ``midori``: The recipe's functionally has been replaced by
- ``epiphany``.
-
-- ``python-gst``: The recipe is obsolete and has been removed since it
- only contains bindings for Gstreamer 0.10.
-
-- ``qt-mobility``: The recipe is obsolete and has been removed since it
- requires ``Gstreamer 0.10``, which has been replaced.
-
-- ``subversion``: All 1.6.x versions of this recipe have been removed.
-
-- ``webkit-gtk``: The older 1.8.3 version of this recipe has been
- removed in favor of ``webkitgtk``.
-
-.. _migration-2.0-bitbake-datastore-improvements:
-
-BitBake datastore improvements
-------------------------------
-
-The method by which BitBake's datastore handles overrides has changed.
-Overrides are now applied dynamically and ``bb.data.update_data()`` is
-now a no-op. Thus, ``bb.data.update_data()`` is no longer required in
-order to apply the correct overrides. In practice, this change is
-unlikely to require any changes to Metadata. However, these minor
-changes in behavior exist:
-
-- All potential overrides are now visible in the variable history as
- seen when you run the following::
-
- $ bitbake -e
-
-- ``d.delVar('VARNAME')`` and
- ``d.setVar('VARNAME', None)`` result in the variable and all
- of its overrides being cleared out. Before the change, only the
- non-overridden values were cleared.
-
-.. _migration-2.0-shell-message-function-changes:
-
-Shell Message Function Changes
-------------------------------
-
-The shell versions of the BitBake message functions (i.e. ``bbdebug``,
-``bbnote``, ``bbwarn``, ``bbplain``, ``bberror``, and ``bbfatal``) are
-now connected through to their BitBake equivalents ``bb.debug()``,
-``bb.note()``, ``bb.warn()``, ``bb.plain()``, ``bb.error()``, and
-``bb.fatal()``, respectively. Thus, those message functions that you
-would expect to be printed by the BitBake UI are now actually printed.
-In practice, this change means two things:
-
-- If you now see messages on the console that you did not previously
- see as a result of this change, you might need to clean up the calls
- to ``bbwarn``, ``bberror``, and so forth. Or, you might want to
- simply remove the calls.
-
-- The ``bbfatal`` message function now suppresses the full error log in
- the UI, which means any calls to ``bbfatal`` where you still wish to
- see the full error log should be replaced by ``die`` or
- ``bbfatal_log``.
-
-.. _migration-2.0-extra-development-debug-package-cleanup:
-
-Extra Development/Debug Package Cleanup
----------------------------------------
-
-The following recipes have had extra ``dev/dbg`` packages removed:
-
-- ``acl``
-
-- ``apmd``
-
-- ``aspell``
-
-- ``attr``
-
-- ``augeas``
-
-- ``bzip2``
-
-- ``cogl``
-
-- ``curl``
-
-- ``elfutils``
-
-- ``gcc-target``
-
-- ``libgcc``
-
-- ``libtool``
-
-- ``libxmu``
-
-- ``opkg``
-
-- ``pciutils``
-
-- ``rpm``
-
-- ``sysfsutils``
-
-- ``tiff``
-
-- ``xz``
-
-All of the above recipes now conform to the standard packaging scheme
-where a single ``-dev``, ``-dbg``, and ``-staticdev`` package exists per
-recipe.
-
-.. _migration-2.0-recipe-maintenance-tracking-data-moved-to-oe-core:
-
-Recipe Maintenance Tracking Data Moved to OE-Core
--------------------------------------------------
-
-Maintenance tracking data for recipes that was previously part of
-``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
-relevant recipes.
-
-.. _migration-2.0-automatic-stale-sysroot-file-cleanup:
-
-Automatic Stale Sysroot File Cleanup
-------------------------------------
-
-Stale files from recipes that no longer exist in the current
-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 :term:`DISTRO_FEATURES`
-changes.
-
-Additionally, work directories for old versions of recipes are now
-pruned. If you wish to disable pruning old work directories, you can set
-the following variable in your configuration::
-
- SSTATE_PRUNE_OBSOLETEWORKDIR = "0"
-
-.. _migration-2.0-linux-yocto-kernel-metadata-repository-now-split-from-source:
-
-``linux-yocto`` Kernel Metadata Repository Now Split from Source
-----------------------------------------------------------------
-
-The ``linux-yocto`` tree has up to now been a combined set of kernel
-changes and configuration (meta) data carried in a single tree. While
-this format is effective at keeping kernel configuration and source
-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
-:ref:`kernel-yocto <ref-classes-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
-change, ``linux-yocto`` is no longer able to process combined trees.
-Thus, if you need to have your own combined kernel repository, you must
-do the split there as well and update your recipes accordingly. See the
-``meta/recipes-kernel/linux/linux-yocto_4.1.bb`` recipe for an example.
-
-.. _migration-2.0-additional-qa-checks:
-
-Additional QA checks
---------------------
-
-The following QA checks have been added:
-
-- Added a "host-user-contaminated" check for ownership issues for
- packaged files outside of ``/home``. The check looks for files that
- are incorrectly owned by the user that ran BitBake instead of owned
- by a valid user in the target system.
-
-- Added an "invalid-chars" check for invalid (non-UTF8) characters in
- recipe metadata variable values (i.e.
- :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
- :term:`PACKAGECONFIG` that do not match any
- ``PACKAGECONFIG`` option defined for the recipe.
-
-.. _migration-2.0-miscellaneous:
-
-Miscellaneous Changes
----------------------
-
-These additional changes exist:
-
-- ``gtk-update-icon-cache`` has been renamed to ``gtk-icon-utils``.
-
-- 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
- resource-constrained targets. However, this aid has not been widely
- used and is not likely to be used going forward due to the more
- powerful target platforms and the existence of better
- cross-compilation tools.
-
-- The :term:`IMAGE_FSTYPES` variable's default
- value now specifies ``ext4`` instead of ``ext3``.
-
-- All support for the ``PRINC`` variable has been removed.
-
-- The ``packagegroup-core-full-cmdline`` packagegroup no longer brings
- in ``lighttpd`` due to the fact that bringing in ``lighttpd`` is not
- really in line with the packagegroup's purpose, which is to add full
- versions of command-line tools that by default are provided by
- ``busybox``.
-
-
diff --git a/poky/documentation/ref-manual/migration-2.1.rst b/poky/documentation/ref-manual/migration-2.1.rst
deleted file mode 100644
index 32d193f..0000000
--- a/poky/documentation/ref-manual/migration-2.1.rst
+++ /dev/null
@@ -1,432 +0,0 @@
-Moving to the Yocto Project 2.1 Release (krogoth)
-=================================================
-
-This section provides migration information for moving to the Yocto
-Project 2.1 Release (codename "krogoth") from the prior release.
-
-.. _migration-2.1-variable-expansion-in-python-functions:
-
-Variable Expansion in Python Functions
---------------------------------------
-
-Variable expressions, such as ``${VARNAME}`` no longer expand
-automatically within Python functions. Suppressing expansion was done to
-allow Python functions to construct shell scripts or other code for
-situations in which you do not want such expressions expanded. For any
-existing code that relies on these expansions, you need to change the
-expansions to expand the value of individual variables through
-``d.getVar()``. To alternatively expand more complex expressions, use
-``d.expand()``.
-
-.. _migration-2.1-overrides-must-now-be-lower-case:
-
-Overrides Must Now be Lower-Case
---------------------------------
-
-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 :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).
-
-.. _migration-2.1-expand-parameter-to-getvar-and-getvarflag-now-mandatory:
-
-Expand Parameter to ``getVar()`` and ``getVarFlag()`` is Now Mandatory
-----------------------------------------------------------------------
-
-The expand parameter to ``getVar()`` and ``getVarFlag()`` previously
-defaulted to False if not specified. Now, however, no default exists so
-one must be specified. You must change any ``getVar()`` calls that do
-not specify the final expand parameter to calls that do specify the
-parameter. You can run the following ``sed`` command at the base of a
-layer to make this change::
-
- sed -e 's:\(\.getVar([^,()]*\)):\1, False):g' -i `grep -ril getVar *`
- sed -e 's:\(\.getVarFlag([^,()]*,[^,()]*\)):\1, False):g' -i `grep -ril getVarFlag *`
-
-.. note::
-
- The reason for this change is that it prepares the way for changing
- the default to True in a future Yocto Project release. This future
- change is a much more sensible default than False. However, the
- change needs to be made gradually as a sudden change of the default
- would potentially cause side-effects that would be difficult to
- detect.
-
-.. _migration-2.1-makefile-environment-changes:
-
-Makefile Environment Changes
-----------------------------
-
-: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
-to work with sensible build systems. When upgrading to the release, you
-must edit any recipe that relies upon this old default by either setting
-``EXTRA_OEMAKE`` back to "-e MAKEFLAGS=" or by explicitly setting any
-required variable value overrides using ``EXTRA_OEMAKE``, which is
-typically only needed when a Makefile sets a default value for a
-variable that is inappropriate for cross-compilation using the "="
-operator rather than the "?=" operator.
-
-.. _migration-2.1-libexecdir-reverted-to-prefix-libexec:
-
-``libexecdir`` Reverted to ``${prefix}/libexec``
-------------------------------------------------
-
-The use of ``${libdir}/${BPN}`` as ``libexecdir`` is different as
-compared to all other mainstream distributions, which either uses
-``${prefix}/libexec`` or ``${libdir}``. The use is also contrary to the
-GNU Coding Standards (i.e.
-https://www.gnu.org/prep/standards/html_node/Directory-Variables.html)
-that suggest ``${prefix}/libexec`` and also notes that any
-package-specific nesting should be done by the package itself. Finally,
-having ``libexecdir`` change between recipes makes it very difficult for
-different recipes to invoke binaries that have been installed into
-``libexecdir``. The Filesystem Hierarchy Standard (i.e.
-https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html) now
-recognizes the use of ``${prefix}/libexec/``, giving distributions the
-choice between ``${prefix}/lib`` or ``${prefix}/libexec`` without
-breaking FHS.
-
-.. _migration-2.1-ac-cv-sizeof-off-t-no-longer-cached-in-site-files:
-
-``ac_cv_sizeof_off_t`` is No Longer Cached in Site Files
---------------------------------------------------------
-
-For recipes inheriting the :ref:`autotools <ref-classes-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 :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``.
-
-The best course of action is to patch the software as necessary to allow
-the default implementation from the ``autotools`` class to work such
-that ``autoreconf`` succeeds and produces a working configure script,
-and to remove the overridden ``do_configure`` task such that the default
-implementation does get used.
-
-.. _migration-2.1-image-generation-split-out-from-filesystem-generation:
-
-Image Generation is Now Split Out from Filesystem Generation
-------------------------------------------------------------
-
-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 :ref:`ref-tasks-image` tasks for clarity both in
-operation and in the code.
-
-For most cases, this change does not present any problems. However, if
-you have made customizations that directly modify the ``do_rootfs`` task
-or that mention ``do_rootfs``, you might need to update those changes.
-In particular, if you had added any tasks after ``do_rootfs``, you
-should make edits so that those tasks are after the
-:ref:`ref-tasks-image-complete` task rather than
-after ``do_rootfs`` so that your added tasks run at the correct
-time.
-
-A minor part of this restructuring is that the post-processing
-definitions and functions have been moved from the
-:ref:`image <ref-classes-image>` class to the
-:ref:`rootfs-postcommands <ref-classes-rootfs*>` class. Functionally,
-however, they remain unchanged.
-
-.. _migration-2.1-removed-recipes:
-
-Removed Recipes
----------------
-
-The following recipes have been removed in the 2.1 release:
-
-- ``gcc`` version 4.8: Versions 4.9 and 5.3 remain.
-
-- ``qt4``: All support for Qt 4.x has been moved out to a separate
- ``meta-qt4`` layer because Qt 4 is no longer supported upstream.
-
-- ``x11vnc``: Moved to the ``meta-oe`` layer.
-
-- ``linux-yocto-3.14``: No longer supported.
-
-- ``linux-yocto-3.19``: No longer supported.
-
-- ``libjpeg``: Replaced by the ``libjpeg-turbo`` recipe.
-
-- ``pth``: Became obsolete.
-
-- ``liboil``: Recipe is no longer needed and has been moved to the
- ``meta-multimedia`` layer.
-
-- ``gtk-theme-torturer``: Recipe is no longer needed and has been moved
- to the ``meta-gnome`` layer.
-
-- ``gnome-mime-data``: Recipe is no longer needed and has been moved to
- the ``meta-gnome`` layer.
-
-- ``udev``: Replaced by the ``eudev`` recipe for compatibility when
- using ``sysvinit`` with newer kernels.
-
-- ``python-pygtk``: Recipe became obsolete.
-
-- ``adt-installer``: Recipe became obsolete. See the
- ":ref:`ref-manual/migration-2.1:adt removed`" section for more information.
-
-.. _migration-2.1-class-changes:
-
-Class Changes
--------------
-
-The following classes have changed:
-
-- ``autotools_stage``: Removed because the
- :ref:`autotools <ref-classes-autotools>` class now provides its
- functionality. Recipes that inherited from ``autotools_stage`` should
- now inherit from ``autotools`` instead.
-
-- ``boot-directdisk``: Merged into the ``image-vm`` class. The
- ``boot-directdisk`` class was rarely directly used. Consequently,
- this change should not cause any issues.
-
-- ``bootimg``: Merged into the
- :ref:`image-live <ref-classes-image-live>` class. The ``bootimg``
- class was rarely directly used. Consequently, this change should not
- cause any issues.
-
-- ``packageinfo``: Removed due to its limited use by the Hob UI, which
- has itself been removed.
-
-.. _migration-2.1-build-system-ui-changes:
-
-Build System User Interface Changes
------------------------------------
-
-The following changes have been made to the build system user interface:
-
-- *Hob GTK+-based UI*: Removed because it is unmaintained and based on
- the outdated GTK+ 2 library. The Toaster web-based UI is much more
- capable and is actively maintained. See the
- ":ref:`toaster-manual/setup-and-use:using the toaster web interface`"
- section in the Toaster User Manual for more information on this
- interface.
-
-- *"puccho" BitBake UI*: Removed because is unmaintained and no longer
- useful.
-
-.. _migration-2.1-adt-removed:
-
-ADT Removed
------------
-
-The Application Development Toolkit (ADT) has been removed because its
-functionality almost completely overlapped with the :ref:`standard
-SDK <sdk-manual/using:using the standard sdk>` and the
-:ref:`extensible SDK <sdk-manual/extensible:using the extensible sdk>`. For
-information on these SDKs and how to build and use them, see the
-:doc:`/sdk-manual/index` manual.
-
-.. note::
-
- The Yocto Project Eclipse IDE Plug-in is still supported and is not
- affected by this change.
-
-.. _migration-2.1-poky-reference-distribution-changes:
-
-Poky Reference Distribution Changes
------------------------------------
-
-The following changes have been made for the Poky distribution:
-
-- The ``meta-yocto`` layer has been renamed to ``meta-poky`` to better
- match its purpose, which is to provide the Poky reference
- distribution. The ``meta-yocto-bsp`` layer retains its original name
- since it provides reference machines for the Yocto Project and it is
- otherwise unrelated to Poky. References to ``meta-yocto`` in your
- ``conf/bblayers.conf`` should automatically be updated, so you should
- not need to change anything unless you are relying on this naming
- elsewhere.
-
-- The :ref:`uninative <ref-classes-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.
- With this class enabled, a tarball containing a pre-built C library
- is downloaded at the start of the build.
-
- The ``uninative`` class is enabled through the
- ``meta/conf/distro/include/yocto-uninative.inc`` file, which for
- those not using the Poky distribution, can include to easily enable
- the same functionality.
-
- Alternatively, if you wish to build your own ``uninative`` tarball,
- you can do so by building the ``uninative-tarball`` recipe, making it
- available to your build machines (e.g. over HTTP/HTTPS) and setting a
- similar configuration as the one set by ``yocto-uninative.inc``.
-
-- Static library generation, for most cases, is now disabled by default
- in the Poky distribution. Disabling this generation saves some build
- time as well as the size used for build output artifacts.
-
- Disabling this library generation is accomplished through a
- ``meta/conf/distro/include/no-static-libs.inc``, which for those not
- using the Poky distribution can easily include to enable the same
- functionality.
-
- Any recipe that needs to opt-out of having the "--disable-static"
- option specified on the configure command line either because it is
- not a supported option for the configure script or because static
- libraries are needed should set the following variable::
-
- DISABLE_STATIC = ""
-
-- The separate ``poky-tiny`` distribution now uses the musl C library
- instead of a heavily pared down ``glibc``. Using musl results in a
- smaller distribution and facilitates much greater maintainability
- because musl is designed to have a small footprint.
-
- If you have used ``poky-tiny`` and have customized the ``glibc``
- configuration you will need to redo those customizations with musl
- when upgrading to the new release.
-
-.. _migration-2.1-packaging-changes:
-
-Packaging Changes
------------------
-
-The following changes have been made to packaging:
-
-- The ``runuser`` and ``mountpoint`` binaries, which were previously in
- the main ``util-linux`` package, have been split out into the
- ``util-linux-runuser`` and ``util-linux-mountpoint`` packages,
- respectively.
-
-- The ``python-elementtree`` package has been merged into the
- ``python-xml`` package.
-
-.. _migration-2.1-tuning-file-changes:
-
-Tuning File Changes
--------------------
-
-The following changes have been made to the tuning files:
-
-- The "no-thumb-interwork" tuning feature has been dropped from the ARM
- tune include files. Because interworking is required for ARM EABI,
- attempting to disable it through a tuning feature no longer makes
- sense.
-
- .. note::
-
- Support for ARM OABI was deprecated in gcc 4.7.
-
-- The ``tune-cortexm*.inc`` and ``tune-cortexr4.inc`` files have been
- removed because they are poorly tested. Until the OpenEmbedded build
- system officially gains support for CPUs without an MMU, these tuning
- files would probably be better maintained in a separate layer if
- needed.
-
-.. _migration-2.1-supporting-gobject-introspection:
-
-Supporting GObject Introspection
---------------------------------
-
-This release supports generation of GLib Introspective Repository (GIR)
-files through GObject introspection, which is the standard mechanism for
-accessing GObject-based software from runtime environments. You can
-enable, disable, and test the generation of this data. See the
-":ref:`dev-manual/common-tasks:enabling gobject introspection support`"
-section in the Yocto Project Development Tasks Manual for more
-information.
-
-.. _migration-2.1-miscellaneous-changes:
-
-Miscellaneous Changes
----------------------
-
-These additional changes exist:
-
-- The minimum Git version has been increased to 1.8.3.1. If your host
- distribution does not provide a sufficiently recent version, you can
- install the buildtools, which will provide it. See the
- :ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`
- section for more information on the buildtools tarball.
-
-- The buggy and incomplete support for the RPM version 4 package
- manager has been removed. The well-tested and maintained support for
- RPM version 5 remains.
-
-- Previously, the following list of packages were removed if
- package-management was not in
- :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
- they might still be needed for a read-write image even in the absence
- of a package manager (e.g. if users need to be added, modified, or
- removed at runtime).
-
-- The
- :ref:`devtool modify <sdk-manual/extensible:use \`\`devtool modify\`\` to modify the source of an existing component>`
- command now defaults to extracting the source since that is most
- commonly expected. The "-x" or "--extract" options are now no-ops. If
- you wish to provide your own existing source tree, you will now need
- to specify either the "-n" or "--no-extract" options when running
- ``devtool modify``.
-
-- If the formfactor for a machine is either not supplied or does not
- specify whether a keyboard is attached, then the default is to assume
- a keyboard is attached rather than assume no keyboard. This change
- primarily affects the Sato UI.
-
-- The ``.debug`` directory packaging is now automatic. If your recipe
- builds software that installs binaries into directories other than
- the standard ones, you no longer need to take care of setting
- ``FILES_${PN}-dbg`` to pick up the resulting ``.debug`` directories
- as these directories are automatically found and added.
-
-- Inaccurate disk and CPU percentage data has been dropped from
- ``buildstats`` output. This data has been replaced with
- ``getrusage()`` data and corrected IO statistics. You will probably
- need to update any custom code that reads the ``buildstats`` data.
-
-- The ``meta/conf/distro/include/package_regex.inc`` is now deprecated.
- The contents of this file have been moved to individual recipes.
-
- .. note::
-
- Because this file will likely be removed in a future Yocto Project
- release, it is suggested that you remove any references to the
- file that might be in your configuration.
-
-- The ``v86d/uvesafb`` has been removed from the ``genericx86`` and
- ``genericx86-64`` reference machines, which are provided by the
- ``meta-yocto-bsp`` layer. Most modern x86 boards do not rely on this
- file and it only adds kernel error messages during startup. If you do
- still need to support ``uvesafb``, you can simply add ``v86d`` to
- your image.
-
-- Build sysroot paths are now removed from debug symbol files. Removing
- these paths means that remote GDB using an unstripped build system
- sysroot will no longer work (although this was never documented to
- work). The supported method to accomplish something similar is to set
- ``IMAGE_GEN_DEBUGFS`` to "1", which will generate a companion debug
- image containing unstripped binaries and associated debug sources
- alongside the image.
-
-
diff --git a/poky/documentation/ref-manual/migration-2.2.rst b/poky/documentation/ref-manual/migration-2.2.rst
deleted file mode 100644
index a60ce8d..0000000
--- a/poky/documentation/ref-manual/migration-2.2.rst
+++ /dev/null
@@ -1,446 +0,0 @@
-Moving to the Yocto Project 2.2 Release (morty)
-===============================================
-
-This section provides migration information for moving to the Yocto
-Project 2.2 Release (codename "morty") from the prior release.
-
-.. _migration-2.2-minimum-kernel-version:
-
-Minimum Kernel Version
-----------------------
-
-The minimum kernel version for the target system and for SDK is now
-3.2.0, due to the upgrade to ``glibc 2.24``. Specifically, for
-AArch64-based targets the version is 3.14. For Nios II-based targets,
-the minimum kernel version is 3.19.
-
-.. note::
-
- For x86 and x86_64, you can reset :term:`OLDEST_KERNEL`
- to anything down to 2.6.32 if desired.
-
-.. _migration-2.2-staging-directories-in-sysroot-simplified:
-
-Staging Directories in Sysroot Has Been Simplified
---------------------------------------------------
-
-The way directories are staged in sysroot has been simplified and
-introduces the new :term:`SYSROOT_DIRS`,
-:term:`SYSROOT_DIRS_NATIVE`, and
-:term:`SYSROOT_DIRS_BLACKLIST`. See the
-:oe_lists:`v2 patch series on the OE-Core Mailing List
-</pipermail/openembedded-core/2016-May/121365.html>`
-for additional information.
-
-.. _migration-2.2-removal-of-old-images-from-tmp-deploy-now-enabled:
-
-Removal of Old Images and Other Files in ``tmp/deploy`` Now Enabled
--------------------------------------------------------------------
-
-Removal of old images and other files in ``tmp/deploy/`` is now enabled
-by default due to a new staging method used for those files. As a result
-of this change, the ``RM_OLD_IMAGE`` variable is now redundant.
-
-.. _migration-2.2-python-changes:
-
-Python Changes
---------------
-
-The following changes for Python occurred:
-
-.. _migration-2.2-bitbake-now-requires-python-3.4:
-
-BitBake Now Requires Python 3.4+
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-BitBake requires Python 3.4 or greater.
-
-.. _migration-2.2-utf-8-locale-required-on-build-host:
-
-UTF-8 Locale Required on Build Host
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-A UTF-8 locale is required on the build host due to Python 3. Since
-C.UTF-8 is not a standard, the default is en_US.UTF-8.
-
-.. _migration-2.2-metadata-now-must-use-python-3-syntax:
-
-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 :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 lists
-
- - changed names for Python modules
-
-.. _migration-2.2-target-python-recipes-switched-to-python-3:
-
-Target Python Recipes Switched to Python 3
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Most target Python recipes have now been switched to Python 3.
-Unfortunately, systems using RPM as a package manager and providing
-online package-manager support through SMART still require Python 2.
-
-.. note::
-
- Python 2 and recipes that use it can still be built for the target as
- with previous versions.
-
-.. _migration-2.2-buildtools-tarball-includes-python-3:
-
-``buildtools-tarball`` Includes Python 3
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-``buildtools-tarball`` now includes Python 3.
-
-.. _migration-2.2-uclibc-replaced-by-musl:
-
-uClibc Replaced by musl
------------------------
-
-uClibc has been removed in favor of musl. Musl has matured, is better
-maintained, and is compatible with a wider range of applications as
-compared to uClibc.
-
-.. _migration-2.2-B-no-longer-default-working-directory-for-tasks:
-
-``${B}`` No Longer Default Working Directory for Tasks
-------------------------------------------------------
-
-``${``\ :term:`B`\ ``}`` is no longer the default working
-directory for tasks. Consequently, any custom tasks you define now need
-to either have the
-``[``\ :ref:`dirs <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` flag
-set, or the task needs to change into the appropriate working directory
-manually (e.g using ``cd`` for a shell task).
-
-.. note::
-
- The preferred method is to use the
- [dirs]
- flag.
-
-.. _migration-2.2-runqemu-ported-to-python:
-
-``runqemu`` Ported to Python
-----------------------------
-
-``runqemu`` has been ported to Python and has changed behavior in some
-cases. Previous usage patterns continue to be supported.
-
-The new ``runqemu`` is a Python script. Machine knowledge is no longer
-hardcoded into ``runqemu``. You can choose to use the ``qemuboot``
-configuration file to define the BSP's own arguments and to make it
-bootable with ``runqemu``. If you use a configuration file, use the
-following form::
-
- image-name-machine.qemuboot.conf
-
-The configuration file
-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
-: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``.
-
-If you want to use ``runqemu`` without a configuration file, use the
-following command form::
-
- $ runqemu machine rootfs kernel [options]
-
-Supported machines are as follows:
-
- - qemuarm
- - qemuarm64
- - qemux86
- - qemux86-64
- - qemuppc
- - qemumips
- - qemumips64
- - qemumipsel
- - qemumips64el
-
-Consider the
-following example, which uses the ``qemux86-64`` machine, provides a
-root filesystem, provides an image, and uses the ``nographic`` option::
-
- $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic
-
-Following is a list of variables that can be set in configuration files
-such as ``bsp.conf`` to enable the BSP to be booted by ``runqemu``:
-
-.. note::
-
- "QB" means "QEMU Boot".
-
-::
-
- QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386")
- QB_OPT_APPEND: Options to append to QEMU (e.g. "-show-cursor")
- QB_DEFAULT_KERNEL: Default kernel to boot (e.g. "bzImage")
- QB_DEFAULT_FSTYPE: Default FSTYPE to boot (e.g. "ext4")
- QB_MEM: Memory (e.g. "-m 512")
- QB_MACHINE: QEMU machine (e.g. "-machine virt")
- QB_CPU: QEMU cpu (e.g. "-cpu qemu32")
- QB_CPU_KVM: Similar to QB_CPU except used for kvm support (e.g. "-cpu kvm64")
- QB_KERNEL_CMDLINE_APPEND: Options to append to the kernel's -append
- option (e.g. "console=ttyS0 console=tty")
- QB_DTB: QEMU dtb name
- QB_AUDIO_DRV: QEMU audio driver (e.g. "alsa", set it when support audio)
- QB_AUDIO_OPT: QEMU audio option (e.g. "-soundhw ac97,es1370"), which is used
- when QB_AUDIO_DRV is set.
- QB_KERNEL_ROOT: Kernel's root (e.g. /dev/vda)
- QB_TAP_OPT: Network option for 'tap' mode (e.g.
- "-netdev tap,id=net0,ifname=@TAP@,script=no,downscript=no -device virtio-net-device,netdev=net0").
- runqemu will replace "@TAP@" with the one that is used, such as tap0, tap1 ...
- QB_SLIRP_OPT: Network option for SLIRP mode (e.g. "-netdev user,id=net0 -device virtio-net-device,netdev=net0")
- QB_ROOTFS_OPT: Used as rootfs (e.g.
- "-drive id=disk0,file=@ROOTFS@,if=none,format=raw -device virtio-blk-device,drive=disk0").
- runqemu will replace "@ROOTFS@" with the one which is used, such as
- core-image-minimal-qemuarm64.ext4.
- QB_SERIAL_OPT: Serial port (e.g. "-serial mon:stdio")
- QB_TCPSERIAL_OPT: tcp serial port option (e.g.
- " -device virtio-serial-device -chardev 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 :term:`IMAGE_CLASSES` as
-follows and run ``runqemu``:
-
-.. note::
-
- For command-line syntax, use ``runqemu help``.
-
-::
-
- IMAGE_CLASSES += "qemuboot"
-
-.. _migration-2.2-default-linker-hash-style-changed:
-
-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 :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
-used by the software (e.g. a Makefile) might need to be patched.
-However, sometimes making this fix is as simple as adding the following
-to the recipe::
-
- TARGET_CC_ARCH += "${LDFLAGS}"
-
-.. _migration-2.2-kernel-image-base-name-no-longer-uses-kernel-imagetype:
-
-``KERNEL_IMAGE_BASE_NAME`` no Longer Uses ``KERNEL_IMAGETYPE``
---------------------------------------------------------------
-
-The ``KERNEL_IMAGE_BASE_NAME`` variable no longer uses 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 ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}"
-
-If you have recipes or
-classes that use ``KERNEL_IMAGE_BASE_NAME`` directly, you might need to
-update the references to ensure they continue to work.
-
-.. _migration-2.2-bitbake-changes:
-
-BitBake Changes
----------------
-
-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 :term:`SRCREV` for
- specifying the source revision to use, be it
- ``${``\ :term:`AUTOREV`\ ``}``, changelist number,
- p4date, or label, in preference to separate
- :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
- within ``SRC_URI``.
-
-- Some of BitBake's internal code structures for accessing the recipe
- cache needed to be changed to support the new multi-configuration
- functionality. These changes will affect external tools that use
- BitBake's tinfoil module. For information on these changes, see the
- changes made to the scripts supplied with OpenEmbedded-Core:
- :yocto_git:`1 </poky/commit/?id=189371f8393971d00bca0fceffd67cc07784f6ee>`
- and
- :yocto_git:`2 </poky/commit/?id=4a5aa7ea4d07c2c90a1654b174873abb018acc67>`.
-
-- The task management code has been rewritten to avoid using ID
- indirection in order to improve performance. This change is unlikely
- to cause any problems for most users. However, the setscene
- verification function as pointed to by
- ``BB_SETSCENE_VERIFY_FUNCTION`` needed to change signature.
- Consequently, a new variable named ``BB_SETSCENE_VERIFY_FUNCTION2``
- has been added allowing multiple versions of BitBake to work with
- suitably written metadata, which includes OpenEmbedded-Core and Poky.
- Anyone with custom BitBake task scheduler code might also need to
- update the code to handle the new structure.
-
-.. _migration-2.2-swabber-has-been-removed:
-
-Swabber has Been Removed
-------------------------
-
-Swabber, a tool that was intended to detect host contamination in the
-build process, has been removed, as it has been unmaintained and unused
-for some time and was never particularly effective. The OpenEmbedded
-build system has since incorporated a number of mechanisms including
-enhanced QA checks that mean that there is less of a need for such a
-tool.
-
-.. _migration-2.2-removed-recipes:
-
-Removed Recipes
----------------
-
-The following recipes have been removed:
-
-- ``augeas``: No longer needed and has been moved to ``meta-oe``.
-
-- ``directfb``: Unmaintained and has been moved to ``meta-oe``.
-
-- ``gcc``: Removed 4.9 version. Versions 5.4 and 6.2 are still present.
-
-- ``gnome-doc-utils``: No longer needed.
-
-- ``gtk-doc-stub``: Replaced by ``gtk-doc``.
-
-- ``gtk-engines``: No longer needed and has been moved to
- ``meta-gnome``.
-
-- ``gtk-sato-engine``: Became obsolete.
-
-- ``libglade``: No longer needed and has been moved to ``meta-oe``.
-
-- ``libmad``: Unmaintained and functionally replaced by ``libmpg123``.
- ``libmad`` has been moved to ``meta-oe``.
-
-- ``libowl``: Became obsolete.
-
-- ``libxsettings-client``: No longer needed.
-
-- ``oh-puzzles``: Functionally replaced by ``puzzles``.
-
-- ``oprofileui``: Became obsolete. OProfile has been largely supplanted
- by perf.
-
-- ``packagegroup-core-directfb.bb``: Removed.
-
-- ``core-image-directfb.bb``: Removed.
-
-- ``pointercal``: No longer needed and has been moved to ``meta-oe``.
-
-- ``python-imaging``: No longer needed and moved to ``meta-python``
-
-- ``python-pyrex``: No longer needed and moved to ``meta-python``.
-
-- ``sato-icon-theme``: Became obsolete.
-
-- ``swabber-native``: Swabber has been removed. See the :ref:`entry on
- Swabber <ref-manual/migration-2.2:swabber has been removed>`.
-
-- ``tslib``: No longer needed and has been moved to ``meta-oe``.
-
-- ``uclibc``: Removed in favor of musl.
-
-- ``xtscal``: No longer needed and moved to ``meta-oe``
-
-.. _migration-2.2-removed-classes:
-
-Removed Classes
----------------
-
-The following classes have been removed:
-
-- ``distutils-native-base``: No longer needed.
-
-- ``distutils3-native-base``: No longer needed.
-
-- ``sdl``: Only set :term:`DEPENDS` and
- :term:`SECTION`, which are better set within the
- recipe instead.
-
-- ``sip``: Mostly unused.
-
-- ``swabber``: See the :ref:`entry on
- Swabber <ref-manual/migration-2.2:swabber has been removed>`.
-
-.. _migration-2.2-minor-packaging-changes:
-
-Minor Packaging Changes
------------------------
-
-The following minor packaging changes have occurred:
-
-- ``grub``: Split ``grub-editenv`` into its own package.
-
-- ``systemd``: Split container and vm related units into a new package,
- systemd-container.
-
-- ``util-linux``: Moved ``prlimit`` to a separate
- ``util-linux-prlimit`` package.
-
-.. _migration-2.2-miscellaneous-changes:
-
-Miscellaneous Changes
----------------------
-
-The following miscellaneous changes have occurred:
-
-- ``package_regex.inc``: Removed because the definitions
- ``package_regex.inc`` previously contained have been moved to their
- respective recipes.
-
-- Both ``devtool add`` and ``recipetool create`` now use a fixed
- :term:`SRCREV` by default when fetching from a Git
- repository. You can override this in either case to use
- ``${``\ :term:`AUTOREV`\ ``}`` instead by using the
- ``-a`` or ``--autorev`` command-line option
-
-- ``distcc``: GTK+ UI is now disabled by default.
-
-- ``packagegroup-core-tools-testapps``: Removed Piglit.
-
-- ``image.bbclass``: Renamed COMPRESS(ION) to CONVERSION. This change
- means that ``COMPRESSIONTYPES``, ``COMPRESS_DEPENDS`` and
- ``COMPRESS_CMD`` are deprecated in favor of ``CONVERSIONTYPES``,
- ``CONVERSION_DEPENDS`` and ``CONVERSION_CMD``. The ``COMPRESS*``
- variable names will still work in the 2.2 release but metadata that
- does not need to be backwards-compatible should be changed to use the
- new names as the ``COMPRESS*`` ones will be removed in a future
- release.
-
-- ``gtk-doc``: A full version of ``gtk-doc`` is now made available.
- However, some old software might not be capable of using the current
- version of ``gtk-doc`` to build documentation. You need to change
- recipes that build such software so that they explicitly disable
- building documentation with ``gtk-doc``.
-
-
diff --git a/poky/documentation/ref-manual/migration-2.3.rst b/poky/documentation/ref-manual/migration-2.3.rst
deleted file mode 100644
index dfbda61..0000000
--- a/poky/documentation/ref-manual/migration-2.3.rst
+++ /dev/null
@@ -1,517 +0,0 @@
-Moving to the Yocto Project 2.3 Release (pyro)
-==============================================
-
-This section provides migration information for moving to the Yocto
-Project 2.3 Release (codename "pyro") from the prior release.
-
-.. _migration-2.3-recipe-specific-sysroots:
-
-Recipe-specific Sysroots
-------------------------
-
-The OpenEmbedded build system now uses one sysroot per recipe to resolve
-long-standing issues with configuration script auto-detection of
-undeclared dependencies. Consequently, you might find that some of your
-previously written custom recipes are missing declared dependencies,
-particularly those dependencies that are incidentally built earlier in a
-typical build process and thus are already likely to be present in the
-shared sysroot in previous releases.
-
-Consider the following:
-
-- *Declare Build-Time Dependencies:* Because of this new feature, you
- must explicitly declare all build-time dependencies for your recipe.
- If you do not declare these dependencies, they are not populated into
- the sysroot for the recipe.
-
-- *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 :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
- :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
- :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``.
-
-- Examine Recipes that Use ``SSTATEPOSTINSTFUNCS``: You need to
- examine any recipe that uses ``SSTATEPOSTINSTFUNCS`` and determine
- steps to take.
-
- Functions added to ``SSTATEPOSTINSTFUNCS`` are still called as they
- were in previous Yocto Project releases. However, since a separate
- sysroot is now being populated for every recipe and if existing
- 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
- :term:`SYSROOT_PREPROCESS_FUNCS`.
-
- For an example, see the ``pixbufcache`` class in ``meta/classes/`` in
- the :ref:`overview-manual/development-environment:yocto project source repositories`.
-
- .. note::
-
- The
- SSTATEPOSTINSTFUNCS
- variable itself is now deprecated in favor of the
- do_populate_sysroot[postfuncs]
- task. Consequently, if you do still have any function or functions
- that need to be called after the sysroot component is created for
- a recipe, then you would be well advised to take steps to use a
- post installation script as described previously. Taking these
- steps prepares your code for when
- SSTATEPOSTINSTFUNCS
- is removed in a future Yocto Project release.
-
-- *Specify the Sysroot when Using Certain External Scripts:* Because
- 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
- :term:`STAGING_DIR_NATIVE` is used.
-
-.. note::
-
- You can find more information on how recipe-specific sysroots work in
- the ":ref:`ref-classes-staging`" section.
-
-.. _migration-2.3-path-variable:
-
-``PATH`` Variable
------------------
-
-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 :term:`HOSTTOOLS` and
-:term:`HOSTTOOLS_NONFATAL` variables is added
-to ``PATH``.
-
-Consequently, any native binaries provided by the host that you need to
-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 :term:`DEPENDS`
-value.
-
-.. note::
-
- PATH
- is not sanitized in the same way within ``devshell``.
- If it were, you would have difficulty running host tools for
- development and debugging within the shell.
-
-.. _migration-2.3-scripts:
-
-Changes to Scripts
-------------------
-
-The following changes to scripts took place:
-
-- ``oe-find-native-sysroot``: The usage for the
- ``oe-find-native-sysroot`` script has changed to the following::
-
- $ . oe-find-native-sysroot recipe
-
- You must now supply a recipe for recipe
- as part of the command. Prior to the Yocto Project 2.3 release, it
- was not necessary to provide the script with the command.
-
-- ``oe-run-native``: The usage for the ``oe-run-native`` script has
- changed to the following::
-
- $ oe-run-native native_recipe tool
-
- You must
- supply the name of the native recipe and the tool you want to run as
- part of the command. Prior to the Yocto Project 2.3 release, it
- was not necessary to provide the native recipe with the command.
-
-- ``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 :term:`TMPDIR` and getting it wrong,
- it is recommended that you delete ``TMPDIR`` and have it restored
- from shared state (sstate) on subsequent builds.
-
-- ``wipe-sysroot``: The ``wipe-sysroot`` script has been removed as
- it is no longer needed with recipe-specific sysroots.
-
-.. _migration-2.3-functions:
-
-Changes to Functions
---------------------
-
-The previously deprecated ``bb.data.getVar()``, ``bb.data.setVar()``,
-and related functions have been removed in favor of ``d.getVar()``,
-``d.setVar()``, and so forth.
-
-You need to fix any references to these old functions.
-
-.. _migration-2.3-bitbake-changes:
-
-BitBake Changes
----------------
-
-The following changes took place for BitBake:
-
-- *BitBake's Graphical Dependency Explorer UI Replaced:* BitBake's
- graphical dependency explorer UI ``depexp`` was replaced by
- ``taskexp`` ("Task Explorer"), which provides a graphical way of
- exploring the ``task-depends.dot`` file. The data presented by Task
- Explorer is much more accurate than the data that was presented by
- ``depexp``. Being able to visualize the data is an often requested
- feature as standard ``*.dot`` file viewers cannot usual cope with the
- size of the ``task-depends.dot`` file.
-
-- *BitBake "-g" Output Changes:* The ``package-depends.dot`` and
- ``pn-depends.dot`` files as previously generated using the
- ``bitbake -g`` command have been removed. A ``recipe-depends.dot``
- file is now generated as a collapsed version of ``task-depends.dot``
- instead.
-
- The reason for this change is because ``package-depends.dot`` and
- ``pn-depends.dot`` largely date back to a time before task-based
- execution and do not take into account task-level dependencies
- between recipes, which could be misleading.
-
-- *Mirror Variable Splitting Changes:* Mirror variables including
- :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
- themselves.
-
-- *The Subversion (SVN) Fetcher Uses an "ssh" Parameter and Not an
- "rsh" Parameter:* The SVN fetcher now takes an "ssh" parameter
- instead of an "rsh" parameter. This new optional parameter is used
- 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 :ref:`ref-tasks-fetch` task.
-
- See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:subversion (svn) fetcher (\`\`svn://\`\`)`"
- section in the BitBake
- User Manual for additional information.
-
-- ``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2``
- Removed: Because the mechanism they were part of is no longer
- necessary with recipe-specific sysroots, the
- ``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2``
- variables have been removed.
-
-.. _migration-2.3-absolute-symlinks:
-
-Absolute Symbolic Links
------------------------
-
-Absolute symbolic links (symlinks) within staged files are no longer
-permitted and now trigger an error. Any explicit creation of symlinks
-can use the ``lnr`` script, which is a replacement for ``ln -r``.
-
-If the build scripts in the software that the recipe is building are
-creating a number of absolute symlinks that need to be corrected, you
-can inherit ``relative_symlinks`` within the recipe to turn those
-absolute symlinks into relative symlinks.
-
-.. _migration-2.3-gplv2-and-gplv3-moves:
-
-GPLv2 Versions of GPLv3 Recipes Moved
--------------------------------------
-
-Older GPLv2 versions of GPLv3 recipes have moved to a separate
-``meta-gplv2`` layer.
-
-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.
-
-.. note::
-
- You can ``find meta-gplv2`` layer in the OpenEmbedded layer index at
- :oe_layer:`/meta-gplv2`.
-
-These relocated GPLv2 recipes do not receive the same level of
-maintenance as other core recipes. The recipes do not get security fixes
-and upstream no longer maintains them. In fact, the upstream community
-is actively hostile towards people that use the old versions of the
-recipes. Moving these recipes into a separate layer both makes the
-different needs of the recipes clearer and clearly identifies the number
-of these recipes.
-
-.. note::
-
- The long-term solution might be to move to BSD-licensed replacements
- of the GPLv3 components for those that need to exclude GPLv3-licensed
- components from the target system. This solution will be investigated
- for future Yocto Project releases.
-
-.. _migration-2.3-package-management-changes:
-
-Package Management Changes
---------------------------
-
-The following package management changes took place:
-
-- Smart package manager is replaced by DNF package manager. Smart has
- become unmaintained upstream, is not ported to Python 3.x.
- Consequently, Smart needed to be replaced. DNF is the only feasible
- candidate.
-
- The change in functionality is that the on-target runtime package
- management from remote package feeds is now done with a different
- tool that has a different set of command-line options. If you have
- scripts that call the tool directly, or use its API, they need to be
- fixed.
-
- For more information, see the `DNF
- Documentation <https://dnf.readthedocs.io/en/latest/>`__.
-
-- Rpm 5.x is replaced with Rpm 4.x. This is done for two major reasons:
-
- - DNF is API-incompatible with Rpm 5.x and porting it and
- maintaining the port is non-trivial.
-
- - Rpm 5.x itself has limited maintenance upstream, and the Yocto
- Project is one of the very few remaining users.
-
-- Berkeley DB 6.x is removed and Berkeley DB 5.x becomes the default:
-
- - Version 6.x of Berkeley DB has largely been rejected by the open
- source community due to its AGPLv3 license. As a result, most
- mainstream open source projects that require DB are still
- developed and tested with DB 5.x.
-
- - In OE-core, the only thing that was requiring DB 6.x was Rpm 5.x.
- Thus, no reason exists to continue carrying DB 6.x in OE-core.
-
-- ``createrepo`` is replaced with ``createrepo_c``.
-
- ``createrepo_c`` is the current incarnation of the tool that
- generates remote repository metadata. It is written in C as compared
- to ``createrepo``, which is written in Python. ``createrepo_c`` is
- faster and is maintained.
-
-- Architecture-independent RPM packages are "noarch" instead of "all".
-
- 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 :ref:`allarch.bbclass <ref-classes-allarch>`
- class.
-
-- Signing of remote package feeds using ``PACKAGE_FEED_SIGN`` is not
- currently supported. This issue will be fully addressed in a future
- Yocto Project release. See :yocto_bugs:`defect 11209 </show_bug.cgi?id=11209>`
- for more information on a solution to package feed signing with RPM
- in the Yocto Project 2.3 release.
-
-- OPKG now uses the libsolv backend for resolving package dependencies
- by default. This is vastly superior to OPKG's internal ad-hoc solver
- that was previously used. This change does have a small impact on
- disk (around 500 KB) and memory footprint.
-
- .. note::
-
- For further details on this change, see the
- :yocto_git:`commit message </poky/commit/?id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81>`.
-
-.. _migration-2.3-removed-recipes:
-
-Removed Recipes
----------------
-
-The following recipes have been removed:
-
-- ``linux-yocto 4.8``: Version 4.8 has been removed. Versions 4.1
- (LTSI), 4.4 (LTS), 4.9 (LTS/LTSI) and 4.10 are now present.
-
-- ``python-smartpm``: Functionally replaced by ``dnf``.
-
-- ``createrepo``: Replaced by the ``createrepo-c`` recipe.
-
-- ``rpmresolve``: No longer needed with the move to RPM 4 as RPM
- itself is used instead.
-
-- ``gstreamer``: Removed the GStreamer Git version recipes as they
- have been stale. ``1.10.``\ x recipes are still present.
-
-- ``alsa-conf-base``: Merged into ``alsa-conf`` since ``libasound``
- depended on both. Essentially, no way existed to install only one of
- these.
-
-- ``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 :term:`OpenEmbedded-Core (OE-Core)`.
-
-- ``gummiboot``: Replaced by ``systemd-boot``.
-
-.. _migration-2.3-wic-changes:
-
-Wic Changes
------------
-
-The following changes have been made to Wic:
-
-.. note::
-
- For more information on Wic, see the
- ":ref:`dev-manual/common-tasks:creating partitioned images using wic`"
- section in the Yocto Project Development Tasks Manual.
-
-- *Default Output Directory Changed:* Wic's default output directory is
- now the current directory by default instead of the unusual
- ``/var/tmp/wic``.
-
- The "-o" and "--outdir" options remain unchanged and are used to
- specify your preferred output directory if you do not want to use the
- default directory.
-
-- *fsimage Plug-in Removed:* The Wic fsimage plugin has been removed as
- it duplicates functionality of the rawcopy plugin.
-
-.. _migration-2.3-qa-changes:
-
-QA Changes
-----------
-
-The following QA checks have changed:
-
-- ``unsafe-references-in-binaries``: The
- ``unsafe-references-in-binaries`` QA check, which was disabled by
- default, has now been removed. This check was intended to detect
- binaries in ``/bin`` that link to libraries in ``/usr/lib`` and have
- the case where the user has ``/usr`` on a separate filesystem to
- ``/``.
-
- The removed QA check was buggy. Additionally, ``/usr`` residing on a
- separate partition from ``/`` is now a rare configuration.
- Consequently, ``unsafe-references-in-binaries`` was removed.
-
-- ``file-rdeps``: The ``file-rdeps`` QA check is now an error by
- default instead of a warning. Because it is an error instead of a
- warning, you need to address missing runtime dependencies.
-
- For additional information, see the
- :ref:`insane <ref-classes-insane>` class and the
- ":ref:`ref-manual/qa-checks:errors and warnings`" section.
-
-.. _migration-2.3-miscellaneous-changes:
-
-Miscellaneous Changes
----------------------
-
-The following miscellaneous changes have occurred:
-
-- In this release, a number of recipes have been changed to ignore the
- ``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.
-
- .. note::
-
- Future releases of the Yocto Project will remove entirely the
- ability to disable the
- largefile
- feature, which would make it unconditionally enabled everywhere.
-
-- 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
- Multilib enabled. Regardless, the ``DATE`` value is inaccurate if the
- ``base-files`` recipe is restored from shared state (sstate) rather
- than rebuilt.
-
- 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
- :term:`ROOTFS_POSTPROCESS_COMMAND`.
- Doing so ensures the value is always up-to-date with the created
- image.
-
-- Dropbear's ``init`` script now disables DSA host keys by default.
- This change is in line with the systemd service file, which supports
- RSA keys only, and with recent versions of OpenSSH, which deprecates
- DSA host keys.
-
-- The :ref:`buildhistory <ref-classes-buildhistory>` class now
- correctly uses tabs as separators between all columns in
- ``installed-package-sizes.txt`` in order to aid import into other
- tools.
-
-- The ``USE_LDCONFIG`` variable has been replaced with the "ldconfig"
- ``DISTRO_FEATURES`` feature. Distributions that previously set::
-
- USE_LDCONFIG = "0"
-
- should now instead use the following::
-
- DISTRO_FEATURES_BACKFILL_CONSIDERED_append = " ldconfig"
-
-- The default value of
- :term:`COPYLEFT_LICENSE_INCLUDE` now
- includes all versions of AGPL licenses in addition to GPL and LGPL.
-
- .. note::
-
- The default list is not intended to be guaranteed as a complete
- safe list. You should seek legal advice based on what you are
- distributing if you are unsure.
-
-- Kernel module packages are now suffixed with the kernel version in
- order to allow module packages from multiple kernel versions to
- co-exist on a target system. If you wish to return to the previous
- naming scheme that does not include the version suffix, use the
- following::
-
- KERNEL_MODULE_PACKAGE_SUFFIX = ""
-
-- Removal of ``libtool`` ``*.la`` files is now enabled by default. The
- ``*.la`` files are not actually needed on Linux and relocating them
- is an unnecessary burden.
-
- If you need to preserve these ``.la`` files (e.g. in a custom
- distribution), you must change
- :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 :ref:`uninative <ref-classes-uninative>` class for additional
- information.
-
-- All native and nativesdk recipes now use a separate
- ``DISTRO_FEATURES`` value instead of sharing the value used by
- recipes for the target, in order to avoid unnecessary rebuilds.
-
- The ``DISTRO_FEATURES`` for ``native`` recipes is
- :term:`DISTRO_FEATURES_NATIVE` added to
- an intersection of ``DISTRO_FEATURES`` and
- :term:`DISTRO_FEATURES_FILTER_NATIVE`.
-
- For nativesdk recipes, the corresponding variables are
- :term:`DISTRO_FEATURES_NATIVESDK`
- and
- :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 :term:`FILESPATH` instead.
-
-- The ``MULTIMACH_HOST_SYS`` variable has been removed as it is no
- longer needed with recipe-specific sysroots.
-
-
diff --git a/poky/documentation/ref-manual/migration-2.4.rst b/poky/documentation/ref-manual/migration-2.4.rst
deleted file mode 100644
index 2ba17e0..0000000
--- a/poky/documentation/ref-manual/migration-2.4.rst
+++ /dev/null
@@ -1,327 +0,0 @@
-Moving to the Yocto Project 2.4 Release (rocko)
-===============================================
-
-This section provides migration information for moving to the Yocto
-Project 2.4 Release (codename "rocko") from the prior release.
-
-.. _migration-2.4-memory-resident-mode:
-
-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
-: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.
-
-.. _migration-2.4-packaging-changes:
-
-Packaging Changes
------------------
-
-This section provides information about packaging changes that have
-occurred:
-
-- ``python3`` Changes:
-
- - The main "python3" package now brings in all of the standard
- Python 3 distribution rather than a subset. This behavior matches
- what is expected based on traditional Linux distributions. If you
- wish to install a subset of Python 3, specify ``python-core`` plus
- one or more of the individual packages that are still produced.
-
- - ``python3``: The ``bz2.py``, ``lzma.py``, and
- ``_compression.py`` scripts have been moved from the
- ``python3-misc`` package to the ``python3-compression`` package.
-
-- ``binutils``: The ``libbfd`` library is now packaged in a separate
- "libbfd" package. This packaging saves space when certain tools (e.g.
- ``perf``) are installed. In such cases, the tools only need
- ``libbfd`` rather than all the packages in ``binutils``.
-
-- ``util-linux`` Changes:
-
- - The ``su`` program is now packaged in a separate "util-linux-su"
- package, which is only built when "pam" is listed in the
- :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.
- :term:`RDEPENDS`) on the ``util-linux-su`` package
- when "pam" is in ``DISTRO_FEATURES``.
-
- - The ``switch_root`` program is now packaged in a separate
- "util-linux-switch-root" package for small initramfs images that
- 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.
- :term:`RRECOMMENDS`) on the
- ``util-linux-switch-root`` package.
-
- - The ``ionice`` program is now packaged in a separate
- "util-linux-ionice" package. The main ``util-linux`` package has a
- recommended runtime dependency (i.e. ``RRECOMMENDS``) on the
- ``util-linux-ionice`` package.
-
-- ``initscripts``: The ``sushell`` program is now packaged in a
- separate "initscripts-sushell" package. This packaging change allows
- systems to pull ``sushell`` in when ``selinux`` is enabled. The
- change also eliminates needing to pull in the entire ``initscripts``
- package. The main ``initscripts`` package has a runtime dependency
- (i.e. ``RDEPENDS``) on the ``sushell`` package when "selinux" is in
- ``DISTRO_FEATURES``.
-
-- ``glib-2.0``: The ``glib-2.0`` package now has a recommended
- 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
- :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
- from the main ``go`` recipe into a separate ``go-runtime`` recipe.
-
-.. _migration-2.4-removed-recipes:
-
-Removed Recipes
----------------
-
-The following recipes have been removed:
-
-- ``acpitests``: This recipe is not maintained.
-
-- ``autogen-native``: No longer required by Grub, oe-core, or
- meta-oe.
-
-- ``bdwgc``: Nothing in OpenEmbedded-Core requires this recipe. It
- has moved to meta-oe.
-
-- ``byacc``: This recipe was only needed by rpm 5.x and has moved to
- meta-oe.
-
-- ``gcc (5.4)``: The 5.4 series dropped the recipe in favor of 6.3 /
- 7.2.
-
-- ``gnome-common``: Deprecated upstream and no longer needed.
-
-- ``go-bootstrap-native``: Go 1.9 does its own bootstrapping so this
- recipe has been removed.
-
-- ``guile``: This recipe was only needed by ``autogen-native`` and
- ``remake``. The recipe is no longer needed by either of these
- programs.
-
-- ``libclass-isa-perl``: This recipe was previously needed for LSB 4,
- no longer needed.
-
-- ``libdumpvalue-perl``: This recipe was previously needed for LSB 4,
- no longer needed.
-
-- ``libenv-perl``: This recipe was previously needed for LSB 4, no
- longer needed.
-
-- ``libfile-checktree-perl``: This recipe was previously needed for
- LSB 4, no longer needed.
-
-- ``libi18n-collate-perl``: This recipe was previously needed for LSB
- 4, no longer needed.
-
-- ``libiconv``: This recipe was only needed for ``uclibc``, which was
- removed in the previous release. ``glibc`` and ``musl`` have their
- own implementations. ``meta-mingw`` still needs ``libiconv``, so it
- has been moved to ``meta-mingw``.
-
-- ``libpng12``: This recipe was previously needed for LSB. The
- current ``libpng`` is 1.6.x.
-
-- ``libpod-plainer-perl``: This recipe was previously needed for LSB
- 4, no longer needed.
-
-- ``linux-yocto (4.1)``: This recipe was removed in favor of 4.4,
- 4.9, 4.10 and 4.12.
-
-- ``mailx``: This recipe was previously only needed for LSB
- compatibility, and upstream is defunct.
-
-- ``mesa (git version only)``: The git version recipe was stale with
- respect to the release version.
-
-- ``ofono (git version only)``: The git version recipe was stale with
- respect to the release version.
-
-- ``portmap``: This recipe is obsolete and is superseded by
- ``rpcbind``.
-
-- ``python3-pygpgme``: This recipe is old and unmaintained. It was
- previously required by ``dnf``, which has switched to official
- ``gpgme`` Python bindings.
-
-- ``python-async``: This recipe has been removed in favor of the
- Python 3 version.
-
-- ``python-gitdb``: This recipe has been removed in favor of the
- Python 3 version.
-
-- ``python-git``: This recipe was removed in favor of the Python 3
- version.
-
-- ``python-mako``: This recipe was removed in favor of the Python 3
- version.
-
-- ``python-pexpect``: This recipe was removed in favor of the Python
- 3 version.
-
-- ``python-ptyprocess``: This recipe was removed in favor of Python
- the 3 version.
-
-- ``python-pycurl``: Nothing is using this recipe in
- OpenEmbedded-Core (i.e. ``meta-oe``).
-
-- ``python-six``: This recipe was removed in favor of the Python 3
- version.
-
-- ``python-smmap``: This recipe was removed in favor of the Python 3
- version.
-
-- ``remake``: Using ``remake`` as the provider of ``virtual/make`` is
- broken. Consequently, this recipe is not needed in OpenEmbedded-Core.
-
-.. _migration-2.4-kernel-device-tree-move:
-
-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
-:ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class.
-Functionality is automatically enabled for any recipe that inherits the
-:ref:`kernel <ref-classes-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
-Yocto Project will remove ``meta/recipes-kernel/linux/linux-dtb.inc``.
-It is advisable to remove any ``require`` statements that request
-``meta/recipes-kernel/linux/linux-dtb.inc`` from any custom kernel
-recipes you might have. This will avoid breakage in post 2.4 releases.
-
-.. _migration-2.4-package-qa-changes:
-
-Package QA Changes
-------------------
-
-The following package QA changes took place:
-
-- The "unsafe-references-in-scripts" QA check has been removed.
-
-- If you refer to ``${COREBASE}/LICENSE`` within
- :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
- a file within the source tree.
-
-.. _migration-2.4-readme-changes:
-
-``README`` File Changes
------------------------
-
-The following are changes to ``README`` files:
-
-- The main Poky ``README`` file has been moved to the ``meta-poky``
- layer and has been renamed ``README.poky``. A symlink has been
- created so that references to the old location work.
-
-- The ``README.hardware`` file has been moved to ``meta-yocto-bsp``. A
- symlink has been created so that references to the old location work.
-
-- A ``README.qemu`` file has been created with coverage of the
- ``qemu*`` machines.
-
-.. _migration-2.4-miscellaneous-changes:
-
-Miscellaneous Changes
----------------------
-
-The following are additional changes:
-
-- The ``ROOTFS_PKGMANAGE_BOOTSTRAP`` variable and any references to it
- have been removed. You should remove this variable from any custom
- recipes.
-
-- The ``meta-yocto`` directory has been removed.
-
- .. note::
-
- In the Yocto Project 2.1 release
- meta-yocto
- was renamed to
- meta-poky
- and the
- meta-yocto
- subdirectory remained to avoid breaking existing configurations.
-
-- The ``maintainers.inc`` file, which tracks maintainers by listing a
- primary person responsible for each recipe in OE-Core, has been moved
- from ``meta-poky`` to OE-Core (i.e. from
- ``meta-poky/conf/distro/include`` to ``meta/conf/distro/include``).
-
-- The :ref:`buildhistory <ref-classes-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
- :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
- change, specify that subdirectory as the last parameter on the
- ``git show`` or ``git diff`` commands.
-
-- The ``x86-base.inc`` file, which is included by all x86-based machine
- configurations, now sets :term:`IMAGE_FSTYPES`
- using ``?=`` to "live" rather than appending with ``+=``. This change
- makes the default easier to override.
-
-- BitBake fires multiple "BuildStarted" events when multiconfig is
- enabled (one per configuration). For more information, see the
- ":ref:`Events <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:events>`" section in the BitBake User
- Manual.
-
-- By default, the ``security_flags.inc`` file sets a
- :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.
-
-- OE-Core now provides a ``bitbake-layers`` plugin that implements a
- "create-layer" subcommand. The implementation of this subcommand has
- resulted in the ``yocto-layer`` script being deprecated and will
- likely be removed in the next Yocto Project release.
-
-- The ``vmdk``, ``vdi``, and ``qcow2`` image file types are now used in
- conjunction with the "wic" image type through ``CONVERSION_CMD``.
- Consequently, the equivalent image types are now ``wic.vmdk``,
- ``wic.vdi``, and ``wic.qcow2``, respectively.
-
-- ``do_image_<type>[depends]`` has replaced ``IMAGE_DEPENDS_<type>``.
- If you have your own classes that implement custom image types, then
- you need to update them.
-
-- OpenSSL 1.1 has been introduced. However, the default is still 1.0.x
- through the :term:`PREFERRED_VERSION`
- variable. This preference is set is due to the remaining
- compatibility issues with other software. The
- :term:`PROVIDES` variable in the openssl 1.0 recipe
- now includes "openssl10" as a marker that can be used in
- :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.
- prefile and postfile), which are used to read or post-read additional
- configuration files from the command line, now only affect the
- current BitBake command. Before these BitBake changes, these options
- would "stick" for future executions.
-
-
diff --git a/poky/documentation/ref-manual/migration-2.5.rst b/poky/documentation/ref-manual/migration-2.5.rst
deleted file mode 100644
index 86a0da9..0000000
--- a/poky/documentation/ref-manual/migration-2.5.rst
+++ /dev/null
@@ -1,308 +0,0 @@
-Moving to the Yocto Project 2.5 Release (sumo)
-==============================================
-
-This section provides migration information for moving to the Yocto
-Project 2.5 Release (codename "sumo") from the prior release.
-
-.. _migration-2.5-packaging-changes:
-
-Packaging Changes
------------------
-
-This section provides information about packaging changes that have
-occurred:
-
-- ``bind-libs``: The libraries packaged by the bind recipe are in a
- separate ``bind-libs`` package.
-
-- ``libfm-gtk``: The ``libfm`` GTK+ bindings are split into a
- separate ``libfm-gtk`` package.
-
-- ``flex-libfl``: The flex recipe splits out libfl into a separate
- ``flex-libfl`` package to avoid too many dependencies being pulled in
- where only the library is needed.
-
-- ``grub-efi``: The ``grub-efi`` configuration is split into a
- separate ``grub-bootconf`` recipe. However, the dependency
- relationship from ``grub-efi`` is through a virtual/grub-bootconf
- provider making it possible to have your own recipe provide the
- dependency. Alternatively, you can use a BitBake append file to bring
- the configuration back into the ``grub-efi`` recipe.
-
-- *armv7a Legacy Package Feed Support:* Legacy support is removed for
- transitioning from ``armv7a`` to ``armv7a-vfp-neon`` in package
- feeds, which was previously enabled by setting
- ``PKGARCHCOMPAT_ARMV7A``. This transition occurred in 2011 and active
- package feeds should by now be updated to the new naming.
-
-.. _migration-2.5-removed-recipes:
-
-Removed Recipes
----------------
-
-The following recipes have been removed:
-
-- ``gcc``: The version 6.4 recipes are replaced by 7.x.
-
-- ``gst-player``: Renamed to ``gst-examples`` as per upstream.
-
-- ``hostap-utils``: This software package is obsolete.
-
-- ``latencytop``: This recipe is no longer maintained upstream. The
- last release was in 2009.
-
-- ``libpfm4``: The only file that requires this recipe is
- ``oprofile``, which has been removed.
-
-- ``linux-yocto``: The version 4.4, 4.9, and 4.10 recipes have been
- removed. Versions 4.12, 4.14, and 4.15 remain.
-
-- ``man``: This recipe has been replaced by modern ``man-db``
-
-- ``mkelfimage``: This tool has been removed in the upstream coreboot
- project, and is no longer needed with the removal of the ELF image
- type.
-
-- ``nativesdk-postinst-intercept``: This recipe is not maintained.
-
-- ``neon``: This software package is no longer maintained upstream
- and is no longer needed by anything in OpenEmbedded-Core.
-
-- ``oprofile``: The functionality of this recipe is replaced by
- ``perf`` and keeping compatibility on an ongoing basis with ``musl``
- is difficult.
-
-- ``pax``: This software package is obsolete.
-
-- ``stat``: This software package is not maintained upstream.
- ``coreutils`` provides a modern stat binary.
-
-- ``zisofs-tools-native``: This recipe is no longer needed because
- the compressed ISO image feature has been removed.
-
-.. _migration-2.5-scripts-and-tools-changes:
-
-Scripts and Tools Changes
--------------------------
-
-The following are changes to scripts and tools:
-
-- ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer``: The
- ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer`` scripts
- previously shipped with poky but not in OpenEmbedded-Core have been
- removed. These scripts are not maintained and are outdated. In many
- cases, they are also limited in scope. The
- ``bitbake-layers create-layer`` command is a direct replacement for
- ``yocto-layer``. See the documentation to create a BSP or kernel
- recipe in the ":ref:`bsp-guide/bsp:bsp kernel recipe example`" section.
-
-- ``devtool finish``: ``devtool finish`` now exits with an error if
- there are uncommitted changes or a rebase/am in progress in the
- recipe's source repository. If this error occurs, there might be
- uncommitted changes that will not be included in updates to the
- patches applied by the recipe. A -f/--force option is provided for
- situations that the uncommitted changes are inconsequential and you
- want to proceed regardless.
-
-- ``scripts/oe-setup-rpmrepo`` script: The functionality of
- ``scripts/oe-setup-rpmrepo`` is replaced by
- ``bitbake package-index``.
-
-- ``scripts/test-dependencies.sh`` script: The script is largely made
- obsolete by the recipe-specific sysroots functionality introduced in
- the previous release.
-
-.. _migration-2.5-bitbake-changes:
-
-BitBake Changes
----------------
-
-The following are BitBake changes:
-
-- The ``--runall`` option has changed. There are two different
- behaviors people might want:
-
- - *Behavior A:* For a given target (or set of targets) look through
- the task graph and run task X only if it is present and will be
- built.
-
- - *Behavior B:* For a given target (or set of targets) look through
- the task graph and run task X if any recipe in the taskgraph has
- such a target, even if it is not in the original task graph.
-
- The ``--runall`` option now performs "Behavior B". Previously
- ``--runall`` behaved like "Behavior A". A ``--runonly`` option has
- been added to retain the ability to perform "Behavior A".
-
-- Several explicit "run this task for all recipes in the dependency
- tree" tasks have been removed (e.g. ``fetchall``, ``checkuriall``,
- and the ``*all`` tasks provided by the ``distrodata`` and
- ``archiver`` classes). There is a BitBake option to complete this for
- any arbitrary task. For example::
-
- bitbake <target> -c fetchall
-
- should now be replaced with::
-
- bitbake <target> --runall=fetch
-
-.. _migration-2.5-python-and-python3-changes:
-
-Python and Python 3 Changes
----------------------------
-
-The following are auto-packaging changes to Python and Python 3:
-
-The script-managed ``python-*-manifest.inc`` files that were previously
-used to generate Python and Python 3 packages have been replaced with a
-JSON-based file that is easier to read and maintain. A new task is
-available for maintainers of the Python recipes to update the JSON file
-when upgrading to new Python versions. You can now edit the file
-directly instead of having to edit a script and run it to update the
-file.
-
-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
-: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
-way the Python manifest file was created. For more information on this
-change please see :yocto_git:`this commit
-</poky/commit/?id=8d94b9db221d1def42f091b991903faa2d1651ce>`.
-
-.. _migration-2.5-miscellaneous-changes:
-
-Miscellaneous Changes
----------------------
-
-The following are additional changes:
-
-- The ``kernel`` class supports building packages for multiple kernels.
- If your kernel recipe or ``.bbappend`` file mentions packaging at
- all, you should replace references to the kernel in package names
- with ``${KERNEL_PACKAGE_NAME}``. For example, if you disable
- automatic installation of the kernel image using
- ``RDEPENDS_kernel-base = ""`` you can avoid warnings using
- ``RDEPENDS_${KERNEL_PACKAGE_NAME}-base = ""`` instead.
-
-- The ``buildhistory`` class commits changes to the repository by
- default so you no longer need to set ``BUILDHISTORY_COMMIT = "1"``.
- If you want to disable commits you need to set
- ``BUILDHISTORY_COMMIT = "0"`` in your configuration.
-
-- The ``beaglebone`` reference machine has been renamed to
- ``beaglebone-yocto``. The ``beaglebone-yocto`` BSP is a reference
- implementation using only mainline components available in
- OpenEmbedded-Core and ``meta-yocto-bsp``, whereas Texas Instruments
- maintains a full-featured BSP in the ``meta-ti`` layer. This rename
- avoids the previous name clash that existed between the two BSPs.
-
-- The ``update-alternatives`` class no longer works with SysV ``init``
- scripts because this usage has been problematic. Also, the
- ``sysklogd`` recipe no longer uses ``update-alternatives`` because it
- is incompatible with other implementations.
-
-- By default, the :ref:`cmake <ref-classes-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
- ``make``.
-
-- The previously deprecated ``base_*`` functions have been removed in
- favor of their replacements in ``meta/lib/oe`` and
- ``bitbake/lib/bb``. These are typically used from recipes and
- classes. Any references to the old functions must be updated. The
- following table shows the removed functions and their replacements:
-
- +------------------------------+----------------------------------------------------------+
- | *Removed* | *Replacement* |
- +==============================+==========================================================+
- | base_path_join() | oe.path.join() |
- +------------------------------+----------------------------------------------------------+
- | base_path_relative() | oe.path.relative() |
- +------------------------------+----------------------------------------------------------+
- | base_path_out() | oe.path.format_display() |
- +------------------------------+----------------------------------------------------------+
- | base_read_file() | oe.utils.read_file() |
- +------------------------------+----------------------------------------------------------+
- | base_ifelse() | oe.utils.ifelse() |
- +------------------------------+----------------------------------------------------------+
- | base_conditional() | oe.utils.conditional() |
- +------------------------------+----------------------------------------------------------+
- | base_less_or_equal() | oe.utils.less_or_equal() |
- +------------------------------+----------------------------------------------------------+
- | base_version_less_or_equal() | oe.utils.version_less_or_equal() |
- +------------------------------+----------------------------------------------------------+
- | base_contains() | bb.utils.contains() |
- +------------------------------+----------------------------------------------------------+
- | base_both_contain() | oe.utils.both_contain() |
- +------------------------------+----------------------------------------------------------+
- | base_prune_suffix() | oe.utils.prune_suffix() |
- +------------------------------+----------------------------------------------------------+
- | oe_filter() | oe.utils.str_filter() |
- +------------------------------+----------------------------------------------------------+
- | oe_filter_out() | oe.utils.str_filter_out() (or use the \_remove operator) |
- +------------------------------+----------------------------------------------------------+
-
-- Using ``exit 1`` to explicitly defer a postinstall script until first
- boot is now deprecated since it is not an obvious mechanism and can
- mask actual errors. If you 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``)
- will trigger a warning during ``do_rootfs``.
-
- For more information, see the
- ":ref:`dev-manual/common-tasks:post-installation scripts`"
- section in the Yocto Project Development Tasks Manual.
-
-- The ``elf`` image type has been removed. This image type was removed
- because the ``mkelfimage`` tool that was required to create it is no
- longer provided by coreboot upstream and required updating every time
- ``binutils`` updated.
-
-- Support for .iso image compression (previously enabled through
- ``COMPRESSISO = "1"``) has been removed. The userspace tools
- (``zisofs-tools``) are unmaintained and ``squashfs`` provides better
- performance and compression. In order to build a live image with
- squashfs+lz4 compression enabled you should now set
- ``LIVE_ROOTFS_TYPE = "squashfs-lz4"`` and ensure that ``live`` is in
- ``IMAGE_FSTYPES``.
-
-- Recipes with an unconditional dependency on ``libpam`` are only
- buildable with ``pam`` in ``DISTRO_FEATURES``. If the dependency is
- truly optional then it is recommended that the dependency be
- conditional upon ``pam`` being in ``DISTRO_FEATURES``.
-
-- For EFI-based machines, the bootloader (``grub-efi`` by default) is
- installed into the image at /boot. Wic can be used to split the
- bootloader into separate boot and rootfs partitions if necessary.
-
-- Patches whose context does not match exactly (i.e. where patch
- reports "fuzz" when applying) will generate a warning. For an example
- of this see :yocto_git:`this commit
- </poky/commit/?id=cc97bc08125b63821ce3f616771830f77c456f57>`.
-
-- Layers are expected to set ``LAYERSERIES_COMPAT_layername`` to match
- the version(s) of OpenEmbedded-Core they are compatible with. This is
- specified as codenames using spaces to separate multiple values (e.g.
- "rocko sumo"). If a layer does not set
- ``LAYERSERIES_COMPAT_layername``, a warning will is shown. If a layer
- sets a value that does not include the current version ("sumo" for
- the 2.5 release), then an error will be produced.
-
-- The ``TZ`` environment variable is set to "UTC" within the build
- environment in order to fix reproducibility problems in some recipes.
-
-
diff --git a/poky/documentation/ref-manual/migration-2.6.rst b/poky/documentation/ref-manual/migration-2.6.rst
deleted file mode 100644
index d1c6c0c..0000000
--- a/poky/documentation/ref-manual/migration-2.6.rst
+++ /dev/null
@@ -1,452 +0,0 @@
-Moving to the Yocto Project 2.6 Release (thud)
-==============================================
-
-This section provides migration information for moving to the Yocto
-Project 2.6 Release (codename "thud") from the prior release.
-
-.. _migration-2.6-gcc-changes:
-
-GCC 8.2 is Now Used by Default
-------------------------------
-
-The GNU Compiler Collection version 8.2 is now used by default for
-compilation. For more information on what has changed in the GCC 8.x
-release, see https://gcc.gnu.org/gcc-8/changes.html.
-
-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 :term:`GCCVERSION` variable to "7.%" in
-your configuration.
-
-.. _migration-2.6-removed-recipes:
-
-Removed Recipes
----------------
-
-The following recipes have been removed:
-
-- *beecrypt*: No longer needed since moving to RPM 4.
-- *bigreqsproto*: Replaced by ``xorgproto``.
-- *calibrateproto*: Removed in favor of ``xinput``.
-- *compositeproto*: Replaced by ``xorgproto``.
-- *damageproto*: Replaced by ``xorgproto``.
-- *dmxproto*: Replaced by ``xorgproto``.
-- *dri2proto*: Replaced by ``xorgproto``.
-- *dri3proto*: Replaced by ``xorgproto``.
-- *eee-acpi-scripts*: Became obsolete.
-- *fixesproto*: Replaced by ``xorgproto``.
-- *fontsproto*: Replaced by ``xorgproto``.
-- *fstests*: Became obsolete.
-- *gccmakedep*: No longer used.
-- *glproto*: Replaced by ``xorgproto``.
-- *gnome-desktop3*: No longer needed. This recipe has moved to ``meta-oe``.
-- *icon-naming-utils*: No longer used since the Sato theme was removed in 2016.
-- *inputproto*: Replaced by ``xorgproto``.
-- *kbproto*: Replaced by ``xorgproto``.
-- *libusb-compat*: Became obsolete.
-- *libuser*: Became obsolete.
-- *libnfsidmap*: No longer an external requirement since ``nfs-utils`` 2.2.1. ``libnfsidmap`` is now integrated.
-- *libxcalibrate*: No longer needed with ``xinput``
-- *mktemp*: Became obsolete. The ``mktemp`` command is provided by both ``busybox`` and ``coreutils``.
-- *ossp-uuid*: Is not being maintained and has mostly been replaced by ``uuid.h`` in ``util-linux``.
-- *pax-utils*: No longer needed. Previous QA tests that did use this recipe are now done at build time.
-- *pcmciautils*: Became obsolete.
-- *pixz*: No longer needed. ``xz`` now supports multi-threaded compression.
-- *presentproto*: Replaced by ``xorgproto``.
-- *randrproto*: Replaced by ``xorgproto``.
-- *recordproto*: Replaced by ``xorgproto``.
-- *renderproto*: Replaced by ``xorgproto``.
-- *resourceproto*: Replaced by ``xorgproto``.
-- *scrnsaverproto*: Replaced by ``xorgproto``.
-- *trace-cmd*: Became obsolete. ``perf`` replaced this recipe's functionally.
-- *videoproto*: Replaced by ``xorgproto``.
-- *wireless-tools*: Became obsolete. Superseded by ``iw``.
-- *xcmiscproto*: Replaced by ``xorgproto``.
-- *xextproto*: Replaced by ``xorgproto``.
-- *xf86dgaproto*: Replaced by ``xorgproto``.
-- *xf86driproto*: Replaced by ``xorgproto``.
-- *xf86miscproto*: Replaced by ``xorgproto``.
-- *xf86-video-omapfb*: Became obsolete. Use kernel modesetting driver instead.
-- *xf86-video-omap*: Became obsolete. Use kernel modesetting driver instead.
-- *xf86vidmodeproto*: Replaced by ``xorgproto``.
-- *xineramaproto*: Replaced by ``xorgproto``.
-- *xproto*: Replaced by ``xorgproto``.
-- *yasm*: No longer needed since previous usages are now satisfied by ``nasm``.
-
-.. _migration-2.6-packaging-changes:
-
-Packaging Changes
------------------
-
-The following packaging changes have been made:
-
-- *cmake*: ``cmake.m4`` and ``toolchain`` files have been moved to
- the main package.
-
-- *iptables*: The ``iptables`` modules have been split into
- separate packages.
-
-- *alsa-lib*: ``libasound`` is now in the main ``alsa-lib`` package
- instead of ``libasound``.
-
-- *glibc*: ``libnss-db`` is now in its own package along with a
- ``/var/db/makedbs.sh`` script to update databases.
-
-- *python and python3*: The main package has been removed from
- the recipe. You must install specific packages or ``python-modules``
- / ``python3-modules`` for everything.
-
-- *systemtap*: Moved ``systemtap-exporter`` into its own package.
-
-.. _migration-2.6-xorg-protocol-dependencies:
-
-XOrg Protocol dependencies
---------------------------
-
-The ``*proto`` upstream repositories have been combined into one
-"xorgproto" repository. Thus, the corresponding recipes have also been
-combined into a single ``xorgproto`` recipe. Any recipes that depend
-upon the older ``*proto`` recipes need to be changed to depend on the
-newer ``xorgproto`` recipe instead.
-
-For names of recipes removed because of this repository change, see the
-:ref:`ref-manual/migration-2.6:removed recipes` section.
-
-.. _migration-2.6-distutils-distutils3-fetching-dependencies:
-
-``distutils`` and ``distutils3`` Now Prevent Fetching Dependencies During the ``do_configure`` Task
----------------------------------------------------------------------------------------------------
-
-Previously, it was possible for Python recipes that inherited the
-``distutils`` and
-:ref:`distutils3 <ref-classes-distutils3>` classes to fetch code
-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 :term:`DEPENDS`).
-
-.. note::
-
- This change affects classes beyond just the two mentioned (i.e.
- ``distutils`` and ``distutils3``). Any recipe that inherits ``distutils*``
- classes are affected. For example, the ``setuptools`` and ``setuptools3``
- recipes are affected since they inherit the ``distutils*`` classes.
-
-Fetching these types of dependencies that are not provided in the
-sysroot negatively affects the ability to reproduce builds. This type of
-fetching is now explicitly disabled. Consequently, any missing
-dependencies in Python recipes that use these classes now result in an
-error during the ``do_configure`` task.
-
-.. _migration-2.6-linux-yocto-configuration-audit-issues-now-correctly-reported:
-
-``linux-yocto`` Configuration Audit Issues Now Correctly Reported
------------------------------------------------------------------
-
-Due to a bug, the kernel configuration audit functionality was not
-writing out any resulting warnings during the build. This issue is now
-corrected. You might notice these warnings now if you have a custom
-kernel configuration with a ``linux-yocto`` style kernel recipe.
-
-.. _migration-2.6-image-kernel-artifact-naming-changes:
-
-Image/Kernel Artifact Naming Changes
-------------------------------------
-
-The following changes have been made:
-
-- Name variables (e.g. :term:`IMAGE_NAME`) use a new
- ``IMAGE_VERSION_SUFFIX`` variable instead of
- :term:`DATETIME`. Using ``IMAGE_VERSION_SUFFIX``
- allows easier and more direct changes.
-
- The ``IMAGE_VERSION_SUFFIX`` variable is set in the ``bitbake.conf``
- configuration file as follows::
-
- IMAGE_VERSION_SUFFIX = "-${DATETIME}"
-
-- Several variables have changed names for consistency::
-
- Old Variable Name New Variable Name
- ========================================================
- KERNEL_IMAGE_BASE_NAME KERNEL_IMAGE_NAME
- KERNEL_IMAGE_SYMLINK_NAME KERNEL_IMAGE_LINK_NAME
- MODULE_TARBALL_BASE_NAME MODULE_TARBALL_NAME
- MODULE_TARBALL_SYMLINK_NAME MODULE_TARBALL_LINK_NAME
- INITRAMFS_BASE_NAME INITRAMFS_NAME
-
-- The ``MODULE_IMAGE_BASE_NAME`` variable has been removed. The module
- tarball name is now controlled directly with the
- :term:`MODULE_TARBALL_NAME` variable.
-
-- 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 :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 :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 :term:`INITRAMFS_LINK_NAME`
- variable so that the symlink can be controlled similarly to other
- artifact types.
-
-- :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.
-
-.. _migration-2.6-serial-console-deprecated:
-
-``SERIAL_CONSOLE`` Deprecated
------------------------------
-
-The :term:`SERIAL_CONSOLE` variable has been
-functionally replaced by the
-:term:`SERIAL_CONSOLES` variable for some time.
-With the Yocto Project 2.6 release, ``SERIAL_CONSOLE`` has been
-officially deprecated.
-
-``SERIAL_CONSOLE`` will continue to work as before for the 2.6 release.
-However, for the sake of future compatibility, it is recommended that
-you replace all instances of ``SERIAL_CONSOLE`` with
-``SERIAL_CONSOLES``.
-
-.. note::
-
- The only difference in usage is that ``SERIAL_CONSOLES``
- expects entries to be separated using semicolons as compared to
- ``SERIAL_CONSOLE``, which expects spaces.
-
-.. _migration-2.6-poky-sets-unknown-configure-option-to-qa-error:
-
-Configure Script Reports Unknown Options as Errors
---------------------------------------------------
-
-If the configure script reports an unknown option, this now triggers a
-QA error instead of a warning. Any recipes that previously got away with
-specifying such unknown options now need to be fixed.
-
-.. _migration-2.6-override-changes:
-
-Override Changes
-----------------
-
-The following changes have occurred:
-
-- The ``virtclass-native`` and ``virtclass-nativesdk`` Overrides Have
- Been Removed: The ``virtclass-native`` and ``virtclass-nativesdk``
- overrides have been deprecated since 2012 in favor of
- ``class-native`` and ``class-nativesdk``, respectively. Both
- ``virtclass-native`` and ``virtclass-nativesdk`` are now dropped.
-
- .. note::
-
- The ``virtclass-multilib-`` overrides for multilib are still valid.
-
-- 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 :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.
-
- It is likely this change will not cause any problems. However, it is
- possible with some unusual configurations that you might see a change
- in behavior if you were relying on the previous behavior. Be sure to
- check how you use ``forcevariable`` and ``libc-*`` overrides in your
- custom layers and configuration files to ensure they make sense.
-
-- The ``build-${BUILD_OS}`` Override Has Been Removed: The
- ``build-${BUILD_OS}``, which is typically ``build-linux``, override
- has been removed because building on a host operating system other
- than a recent version of Linux is neither supported nor recommended.
- Dropping the override avoids giving the impression that other host
- operating systems might be supported.
-
-- The "_remove" operator now preserves whitespace. Consequently, when
- specifying list items to remove, be aware that leading and trailing
- whitespace resulting from the removal is retained.
-
- See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`"
- section in the BitBake User Manual for a detailed example.
-
-.. _migration-2.6-systemd-configuration-now-split-out-to-system-conf:
-
-``systemd`` Configuration is Now Split Into ``systemd-conf``
-------------------------------------------------------------
-
-The configuration for the ``systemd`` recipe has been moved into a
-``system-conf`` recipe. Moving this configuration to a separate recipe
-avoids the ``systemd`` recipe from becoming machine-specific for cases
-where machine-specific configurations need to be applied (e.g. for
-``qemu*`` machines).
-
-Currently, the new recipe packages the following files::
-
- ${sysconfdir}/machine-id
- ${sysconfdir}/systemd/coredump.conf
- ${sysconfdir}/systemd/journald.conf
- ${sysconfdir}/systemd/logind.conf
- ${sysconfdir}/systemd/system.conf
- ${sysconfdir}/systemd/user.conf
-
-If you previously used bbappend files to append the ``systemd`` recipe to
-change any of the listed files, you must do so for the ``systemd-conf``
-recipe instead.
-
-.. _migration-2.6-automatic-testing-changes:
-
-Automatic Testing Changes
--------------------------
-
-This section provides information about automatic testing changes:
-
-- ``TEST_IMAGE`` Variable Removed: Prior to this release, you set the
- ``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
- :term:`TESTIMAGE_AUTO` variable.
-
-- Inheriting the ``testimage`` and ``testsdk`` Classes: Best
- practices now dictate that you use the
- :term:`IMAGE_CLASSES` variable rather than the
- :term:`INHERIT` variable when you inherit the
- :ref:`testimage <ref-classes-testimage*>` and
- :ref:`testsdk <ref-classes-testsdk>` classes used for automatic
- testing.
-
-.. _migration-2.6-openssl-changes:
-
-OpenSSL Changes
----------------
-
-`OpenSSL <https://www.openssl.org/>`__ has been upgraded from 1.0 to
-1.1. By default, this upgrade could cause problems for recipes that have
-both versions in their dependency chains. The problem is that both
-versions cannot be installed together at build time.
-
-.. note::
-
- It is possible to have both versions of the library at runtime.
-
-.. _migration-2.6-bitbake-changes:
-
-BitBake Changes
----------------
-
-The server logfile ``bitbake-cookerdaemon.log`` is now always placed in
-the :term:`Build Directory` instead of the current
-directory.
-
-.. _migration-2.6-security-changes:
-
-Security Changes
-----------------
-
-The Poky distribution now uses security compiler flags by default.
-Inclusion of these flags could cause new failures due to stricter
-checking for various potential security issues in code.
-
-.. _migration-2.6-post-installation-changes:
-
-Post Installation Changes
--------------------------
-
-You must explicitly mark post installs to defer to the target. If you
-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 :ref:`ref-tasks-rootfs` task.
-
-For more information on post-installation behavior, see the
-":ref:`dev-manual/common-tasks:post-installation scripts`"
-section in the Yocto Project Development Tasks Manual.
-
-.. _migration-2.6-python-3-profile-guided-optimizations:
-
-Python 3 Profile-Guided Optimization
-------------------------------------
-
-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
-:term:`MACHINE` has support for user-mode emulation in
-QEMU (i.e. "qemu-usermode" is in
-: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
-: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
-for the ``python3`` recipe.
-
-.. _migration-2.6-miscellaneous-changes:
-
-Miscellaneous Changes
----------------------
-
-The following miscellaneous changes occurred:
-
-- Default to using the Thumb-2 instruction set for armv7a and above. If
- you have any custom recipes that build software that needs to be
- built with the ARM instruction set, change the recipe to set the
- instruction set as follows::
-
- ARM_INSTRUCTION_SET = "arm"
-
-- ``run-postinsts`` no longer uses ``/etc/*-postinsts`` for
- ``dpkg/opkg`` in favor of built-in postinst support. RPM behavior
- remains unchanged.
-
-- The ``NOISO`` and ``NOHDD`` variables are no longer used. You now
- control building ``*.iso`` and ``*.hddimg`` image types directly by
- using the :term:`IMAGE_FSTYPES` variable.
-
-- The ``scripts/contrib/mkefidisk.sh`` has been removed in favor of
- Wic.
-
-- ``kernel-modules`` has been removed from
- :term:`RRECOMMENDS` for ``qemumips`` and
- ``qemumips64`` machines. Removal also impacts the ``x86-base.inc``
- file.
-
- .. note::
-
- ``genericx86`` and ``genericx86-64`` retain ``kernel-modules`` as part of
- the ``RRECOMMENDS`` variable setting.
-
-- The ``LGPLv2_WHITELIST_GPL-3.0`` variable has been removed. If you
- are setting this variable in your configuration, set or append it to
- the ``WHITELIST_GPL-3.0`` variable instead.
-
-- ``${ASNEEDED}`` is now included in the
- :term:`TARGET_LDFLAGS` variable directly. The
- remaining definitions from ``meta/conf/distro/include/as-needed.inc``
- have been moved to corresponding recipes.
-
-- Support for DSA host keys has been dropped from the OpenSSH recipes.
- If you are still using DSA keys, you must switch over to a more
- secure algorithm as recommended by OpenSSH upstream.
-
-- The ``dhcp`` recipe now uses the ``dhcpd6.conf`` configuration file
- in ``dhcpd6.service`` for IPv6 DHCP rather than re-using
- ``dhcpd.conf``, which is now reserved for IPv4.
-
-
diff --git a/poky/documentation/ref-manual/migration-2.7.rst b/poky/documentation/ref-manual/migration-2.7.rst
deleted file mode 100644
index 1be4d5d..0000000
--- a/poky/documentation/ref-manual/migration-2.7.rst
+++ /dev/null
@@ -1,180 +0,0 @@
-Moving to the Yocto Project 2.7 Release (warrior)
-=================================================
-
-This section provides migration information for moving to the Yocto
-Project 2.7 Release (codename "warrior") from the prior release.
-
-.. _migration-2.7-bitbake-changes:
-
-BitBake Changes
----------------
-
-The following changes have been made to BitBake:
-
-- BitBake now checks anonymous Python functions and pure Python
- functions (e.g. ``def funcname:``) in the metadata for tab
- indentation. If found, BitBake produces a warning.
-
-- Bitbake now checks
- :term:`BBFILE_COLLECTIONS` for duplicate
- entries and triggers an error if any are found.
-
-.. _migration-2.7-eclipse-support-dropped:
-
-Eclipse Support Removed
------------------------
-
-Support for the Eclipse IDE has been removed. Support continues for
-those releases prior to 2.7 that did include support. The 2.7 release
-does not include the Eclipse Yocto plugin.
-
-.. _migration-2.7-qemu-native-splits-system-and-user-mode-parts:
-
-``qemu-native`` Splits the System and User-Mode Parts
------------------------------------------------------
-
-The system and user-mode parts of ``qemu-native`` are now split.
-``qemu-native`` provides the user-mode components and
-``qemu-system-native`` provides the system components. If you have
-recipes that depend on QEMU's system emulation functionality at build
-time, they should now depend upon ``qemu-system-native`` instead of
-``qemu-native``.
-
-.. _migration-2.7-upstream-tracking.inc-removed:
-
-The ``upstream-tracking.inc`` File Has Been Removed
----------------------------------------------------
-
-The previously deprecated ``upstream-tracking.inc`` file is now removed.
-Any ``UPSTREAM_TRACKING*`` variables are now set in the corresponding
-recipes instead.
-
-Remove any references you have to the ``upstream-tracking.inc`` file in
-your configuration.
-
-.. _migration-2.7-distro-features-libc-removed:
-
-The ``DISTRO_FEATURES_LIBC`` Variable Has Been Removed
-------------------------------------------------------
-
-The ``DISTRO_FEATURES_LIBC`` variable is no longer used. The ability to
-configure glibc using kconfig has been removed for quite some time
-making the ``libc-*`` features set no longer effective.
-
-Remove any references you have to ``DISTRO_FEATURES_LIBC`` in your own
-layers.
-
-.. _migration-2.7-license-values:
-
-License Value Corrections
--------------------------
-
-The following corrections have been made to the
-: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
-
-.. _migration-2.7-packaging-changes:
-
-Packaging Changes
------------------
-
-This section provides information about packaging changes.
-
-- ``bind``: The ``nsupdate`` binary has been moved to the
- ``bind-utils`` package.
-
-- 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
- :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 :term:`SDKIMAGE_FEATURES` that
- does not include ``src-pkgs``.
-
-- Mount all using ``util-linux``: ``/etc/default/mountall`` has moved
- into the -mount sub-package.
-
-- 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 :term:`RRECOMMENDS` and
- :term:`RDEPENDS` variables. As a result, existing
- images should not see any changes assuming
- :term:`NO_RECOMMENDATIONS` is not set.
-
-- ``netbase/base-files``: ``/etc/hosts`` has moved from ``netbase`` to
- ``base-files``.
-
-- ``tzdata``: The main package has been converted to an empty meta
- package that pulls in all ``tzdata`` packages by default.
-
-- ``lrzsz``: This package has been removed from
- ``packagegroup-self-hosted`` and
- ``packagegroup-core-tools-testapps``. The X/Y/ZModem support is less
- likely to be needed on modern systems. If you are relying on these
- packagegroups to include the ``lrzsz`` package in your image, you now
- need to explicitly add the package.
-
-.. _migration-2.7-removed-recipes:
-
-Removed Recipes
----------------
-
-The following recipes have been removed:
-
-- *gcc*: Drop version 7.3 recipes. Version 8.3 now remains.
-- *linux-yocto*: Drop versions 4.14 and 4.18 recipes. Versions 4.19 and 5.0 remain.
-- *go*: Drop version 1.9 recipes. Versions 1.11 and 1.12 remain.
-- *xvideo-tests*: Became obsolete.
-- *libart-lgpl*: Became obsolete.
-- *gtk-icon-utils-native*: These tools are now provided by gtk+3-native
-- *gcc-cross-initial*: No longer needed. gcc-cross/gcc-crosssdk is now used instead.
-- *gcc-crosssdk-initial*: No longer needed. gcc-cross/gcc-crosssdk is now used instead.
-- *glibc-initial*: Removed because the benefits of having it for site_config are currently outweighed by the cost of building the recipe.
-
-.. _migration-2.7-removed-classes:
-
-Removed Classes
----------------
-
-The following classes have been removed:
-
-- *distutils-tools*: This class was never used.
-- *bugzilla.bbclass*: Became obsolete.
-- *distrodata*: This functionally has been replaced by a more modern tinfoil-based implementation.
-
-.. _migration-2.7-miscellaneous-changes:
-
-Miscellaneous Changes
----------------------
-
-The following miscellaneous changes occurred:
-
-- The ``distro`` subdirectory of the Poky repository has been removed
- from the top-level ``scripts`` directory.
-
-- Perl now builds for the target using
- `perl-cross <https://arsv.github.io/perl-cross/>`_ for better
- maintainability and improved build performance. This change should
- not present any problems unless you have heavily customized your Perl
- recipe.
-
-- ``arm-tunes``: Removed the "-march" option if mcpu is already added.
-
-- ``update-alternatives``: Convert file renames to
- :term:`PACKAGE_PREPROCESS_FUNCS`
-
-- ``base/pixbufcache``: Obsolete ``sstatecompletions`` code has been
- removed.
-
-- :ref:`native <ref-classes-native>` class:
- :term:`RDEPENDS` handling has been enabled.
-
-- ``inetutils``: This recipe has rsh disabled.
-
-
diff --git a/poky/documentation/ref-manual/migration-3.0.rst b/poky/documentation/ref-manual/migration-3.0.rst
deleted file mode 100644
index f3d20e2..0000000
--- a/poky/documentation/ref-manual/migration-3.0.rst
+++ /dev/null
@@ -1,320 +0,0 @@
-Moving to the Yocto Project 3.0 Release (zeus)
-==============================================
-
-This section provides migration information for moving to the Yocto
-Project 3.0 Release (codename "zeus") from the prior release.
-
-.. _migration-3.0-init-system-selection:
-
-Init System Selection
----------------------
-
-Changing the init system manager previously required setting a number of
-different variables. You can now change the manager by setting the
-``INIT_MANAGER`` variable and the corresponding include files (i.e.
-``conf/distro/include/init-manager-*.conf``). Include files are provided
-for four values: "none", "sysvinit", "systemd", and "mdev-busybox". The
-default value, "none", for ``INIT_MANAGER`` should allow your current
-settings to continue working. However, it is advisable to explicitly set
-``INIT_MANAGER``.
-
-.. _migration-3.0-lsb-support-removed:
-
-LSB Support Removed
--------------------
-
-Linux Standard Base (LSB) as a standard is not current, and is not well
-suited for embedded applications. Support can be continued in a separate
-layer if needed. However, presently LSB support has been removed from
-the core.
-
-As a result of this change, the ``poky-lsb`` derivative distribution
-configuration that was also used for testing alternative configurations
-has been replaced with a ``poky-altcfg`` distribution that has LSB parts
-removed.
-
-.. _migration-3.0-removed-recipes:
-
-Removed Recipes
----------------
-
-The following recipes have been removed.
-
-- ``core-image-lsb-dev``: Part of removed LSB support.
-
-- ``core-image-lsb``: Part of removed LSB support.
-
-- ``core-image-lsb-sdk``: Part of removed LSB support.
-
-- ``cve-check-tool``: Functionally replaced by the ``cve-update-db``
- recipe and ``cve-check`` class.
-
-- ``eglinfo``: No longer maintained. ``eglinfo`` from ``mesa-demos`` is
- an adequate and maintained alternative.
-
-- ``gcc-8.3``: Version 8.3 removed. Replaced by 9.2.
-
-- ``gnome-themes-standard``: Only needed by gtk+ 2.x, which has been
- removed.
-
-- ``gtk+``: GTK+ 2 is obsolete and has been replaced by gtk+3.
-
-- ``irda-utils``: Has become obsolete. IrDA support has been removed
- from the Linux kernel in version 4.17 and later.
-
-- ``libnewt-python``: ``libnewt`` Python support merged into main
- ``libnewt`` recipe.
-
-- ``libsdl``: Replaced by newer ``libsdl2``.
-
-- ``libx11-diet``: Became obsolete.
-
-- ``libxx86dga``: Removed obsolete client library.
-
-- ``libxx86misc``: Removed. Library is redundant.
-
-- ``linux-yocto``: Version 5.0 removed, which is now redundant (5.2 /
- 4.19 present).
-
-- ``lsbinitscripts``: Part of removed LSB support.
-
-- ``lsb``: Part of removed LSB support.
-
-- ``lsbtest``: Part of removed LSB support.
-
-- ``openssl10``: Replaced by newer ``openssl`` version 1.1.
-
-- ``packagegroup-core-lsb``: Part of removed LSB support.
-
-- ``python-nose``: Removed the Python 2.x version of the recipe.
-
-- ``python-numpy``: Removed the Python 2.x version of the recipe.
-
-- ``python-scons``: Removed the Python 2.x version of the recipe.
-
-- ``source-highlight``: No longer needed.
-
-- ``stress``: Replaced by ``stress-ng``.
-
-- ``vulkan``: Split into ``vulkan-loader``, ``vulkan-headers``, and
- ``vulkan-tools``.
-
-- ``weston-conf``: Functionality moved to ``weston-init``.
-
-.. _migration-3.0-packaging-changes:
-
-Packaging Changes
------------------
-
-The following packaging changes have occurred.
-
-- The `Epiphany <https://en.wikipedia.org/wiki/GNOME_Web>`__ browser
- has been dropped from ``packagegroup-self-hosted`` as it has not been
- needed inside ``build-appliance-image`` for quite some time and was
- causing resource problems.
-
-- ``libcap-ng`` Python support has been moved to a separate
- ``libcap-ng-python`` recipe to streamline the build process when the
- Python bindings are not needed.
-
-- ``libdrm`` now packages the file ``amdgpu.ids`` into a separate
- ``libdrm-amdgpu`` package.
-
-- ``python3``: The ``runpy`` module is now in the ``python3-core``
- package as it is required to support the common "python3 -m" command
- usage.
-
-- ``distcc`` now provides separate ``distcc-client`` and
- ``distcc-server`` packages as typically one or the other are needed,
- rather than both.
-
-- ``python*-setuptools`` recipes now separately package the
- ``pkg_resources`` module in a ``python-pkg-resources`` /
- ``python3-pkg-resources`` package as the module is useful independent
- of the rest of the setuptools package. The main ``python-setuptools``
- / ``python3-setuptools`` package depends on this new package so you
- should only need to update dependencies unless you want to take
- advantage of the increased granularity.
-
-.. _migration-3.0-cve-checking:
-
-CVE Checking
-------------
-
-``cve-check-tool`` has been functionally replaced by a new
-``cve-update-db`` recipe and functionality built into the ``cve-check``
-class. The result uses NVD JSON data feeds rather than the deprecated
-XML feeds that ``cve-check-tool`` was using, supports CVSSv3 scoring,
-and makes other improvements.
-
-Additionally, the ``CVE_CHECK_CVE_WHITELIST`` variable has been replaced
-by ``CVE_CHECK_WHITELIST``.
-
-.. _migration-3.0-bitbake-changes:
-
-Bitbake Changes
----------------
-
-The following BitBake changes have occurred.
-
-- ``addtask`` statements now properly validate dependent tasks.
- Previously, an invalid task was silently ignored. With this change,
- the invalid task generates a warning.
-
-- Other invalid ``addtask`` and ``deltask`` usages now trigger these
- warnings: "multiple target tasks arguments with addtask / deltask",
- and "multiple before/after clauses".
-
-- The "multiconfig" prefix is now shortened to "mc". "multiconfig" will
- continue to work, however it may be removed in a future release.
-
-- The ``bitbake -g`` command no longer generates a
- ``recipe-depends.dot`` file as the contents (i.e. a reprocessed
- version of ``task-depends.dot``) were confusing.
-
-- The ``bb.build.FuncFailed`` exception, previously raised by
- ``bb.build.exec_func()`` when certain other exceptions have occurred,
- has been removed. The real underlying exceptions will be raised
- instead. If you have calls to ``bb.build.exec_func()`` in custom
- classes or ``tinfoil-using`` scripts, any references to
- ``bb.build.FuncFailed`` should be cleaned up.
-
-- Additionally, the ``bb.build.exec_func()`` no longer accepts the
- "pythonexception" parameter. The function now always raises
- exceptions. Remove this argument in any calls to
- ``bb.build.exec_func()`` in custom classes or scripts.
-
-- The
- :term:`bitbake:BB_SETSCENE_VERIFY_FUNCTION2`
- is no longer used. In the unlikely event that you have any references
- to it, they should be removed.
-
-- The ``RunQueueExecuteScenequeue`` and ``RunQueueExecuteTasks`` events
- have been removed since setscene tasks are now executed as part of
- the normal runqueue. Any event handling code in custom classes or
- scripts that handles these two events need to be updated.
-
-- The arguments passed to functions used with
- :term:`bitbake:BB_HASHCHECK_FUNCTION`
- have changed. If you are using your own custom hash check function,
- see :yocto_git:`/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725`
- for details.
-
-- Task specifications in ``BB_TASKDEPDATA`` and class implementations
- used in signature generator classes now use "<fn>:<task>" everywhere
- rather than the "." delimiter that was being used in some places.
- This change makes it consistent with all areas in the code. Custom
- signature generator classes and code that reads ``BB_TASKDEPDATA``
- need to be updated to use ':' as a separator rather than '.'.
-
-.. _migration-3.0-sanity-checks:
-
-Sanity Checks
--------------
-
-The following sanity check changes occurred.
-
-- :term:`SRC_URI` is now checked for usage of two
- problematic items:
-
- - "${PN}" prefix/suffix use - Warnings always appear if ${PN} is
- used. You must fix the issue regardless of whether multiconfig or
- anything else that would cause prefixing/suffixing to happen.
-
- - Github archive tarballs - these are not guaranteed to be stable.
- Consequently, it is likely that the tarballs will be refreshed and
- thus the SRC_URI checksums will fail to apply. It is recommended
- that you fetch either an official release tarball or a specific
- revision from the actual Git repository instead.
-
- Either one of these items now trigger a warning by default. If you
- wish to disable this check, remove ``src-uri-bad`` from
- :term:`WARN_QA`.
-
-- The ``file-rdeps`` runtime dependency check no longer expands
- :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
- recursively. Here is an example: package A contains a shell script
- starting with ``#!/bin/bash`` but has no dependency on bash. However,
- package A depends on package B, which does depend on bash. You need
- to add the missing dependency or dependencies to resolve the warning.
-
-- Setting ``DEPENDS_${PN}`` anywhere (i.e. typically in a recipe) now
- triggers an error. The error is triggered because
- :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
- only upstream officially supports linking the library with glibc.
- Thus, a warning is shown when building systemd in conjunction with
- musl.
-
-.. _migration-3.0-miscellaneous-changes:
-
-Miscellaneous Changes
----------------------
-
-The following miscellaneous changes have occurred.
-
-- The ``gnome`` class has been removed because it now does very little.
- You should update recipes that previously inherited this class to do
- the following: inherit gnomebase gtk-icon-cache gconf mime
-
-- The ``meta/recipes-kernel/linux/linux-dtb.inc`` file has been
- removed. This file was previously deprecated in favor of setting
- :term:`KERNEL_DEVICETREE` in any kernel
- recipe and only produced a warning. Remove any ``include`` or
- ``require`` statements pointing to this file.
-
-- :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
- of your recipes is expecting these variables to be set, then building
- the recipe will fail. In such cases, you must either export the
- variable or variables in the recipe or change the scripts so that
- exporting is not necessary.
-
-- You must change the host distro identifier used in
- :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
- :term:`SANITY_TESTED_DISTROS`.
-
-- In the ``base-files`` recipe, writing the hostname into
- ``/etc/hosts`` and ``/etc/hostname`` is now done within the main
- :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
- done the latter (e.g. in a ``base-files`` bbappend), then you should
- remove it from your customized ``do_install_basefilesissue``
- function.
-
-- The ``wic --expand`` command now uses commas to separate "key:value"
- pairs rather than hyphens.
-
- .. note::
-
- The wic command-line help is not updated.
-
- You must update any scripts or commands where you use
- ``wic --expand`` with multiple "key:value" pairs.
-
-- UEFI image variable settings have been moved from various places to a
- central ``conf/image-uefi.conf``. This change should not influence
- any existing configuration as the ``meta/conf/image-uefi.conf`` in
- the core metadata sets defaults that can be overridden in the same
- manner as before.
-
-- ``conf/distro/include/world-broken.inc`` has been removed. For cases
- where certain recipes need to be disabled when using the musl C
- library, these recipes now have ``COMPATIBLE_HOST_libc-musl`` set
- with a comment that explains why.
-
-
diff --git a/poky/documentation/ref-manual/migration-3.1.rst b/poky/documentation/ref-manual/migration-3.1.rst
deleted file mode 100644
index 7822285..0000000
--- a/poky/documentation/ref-manual/migration-3.1.rst
+++ /dev/null
@@ -1,275 +0,0 @@
-Moving to the Yocto Project 3.1 Release (dunfell)
-=================================================
-
-This section provides migration information for moving to the Yocto
-Project 3.1 Release (codename "dunfell") from the prior release.
-
-.. _migration-3.1-minimum-system-requirements:
-
-Minimum system requirements
----------------------------
-
-The following versions / requirements of build host components have been
-updated:
-
-- gcc 5.0
-
-- python 3.5
-
-- tar 1.28
-
-- ``rpcgen`` is now required on the host (part of the ``libc-dev-bin``
- package on Ubuntu, Debian and related distributions, and the
- ``glibc`` package on RPM-based distributions).
-
-Additionally, the ``makeinfo`` and ``pod2man`` tools are *no longer*
-required on the host.
-
-.. _migration-3.1-mpc8315e-rdb-removed:
-
-mpc8315e-rdb machine removed
-----------------------------
-
-The MPC8315E-RDB machine is old/obsolete and unobtainable, thus given
-the maintenance burden the ``mpc8315e-rdb`` machine configuration that
-supported it has been removed in this release. The removal does leave a
-gap in official PowerPC reference hardware support; this may change in
-future if a suitable machine with accompanying support resources is
-found.
-
-.. _migration-3.1-python-2-removed:
-
-Python 2 removed
-----------------
-
-Due to the expiration of upstream support in January 2020, support for
-Python 2 has now been removed; it is recommended that you use Python 3
-instead. If absolutely needed there is a meta-python2 community layer
-containing Python 2, related classes and various Python 2-based modules,
-however it should not be considered as supported.
-
-.. _migration-3.1-reproducible-builds:
-
-Reproducible builds now enabled by default
-------------------------------------------
-
-In order to avoid unnecessary differences in output files (aiding binary
-reproducibility), the Poky distribution configuration
-(``DISTRO = "poky"``) now inherits the ``reproducible_build`` class by
-default.
-
-.. _migration-3.1-ptest-feature-impact:
-
-Impact of ptest feature is now more significant
------------------------------------------------
-
-The Poky distribution configuration (``DISTRO = "poky"``) enables ptests
-by default to enable runtime testing of various components. In this
-release, a dependency needed to be added that has resulted in a
-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
-:term:`DISTRO_FEATURES` to save a significant
-amount of build time e.g. by adding the following in your configuration::
-
- DISTRO_FEATURES_remove = "ptest"
-
-.. _migration-3.1-removed-recipes:
-
-Removed recipes
----------------
-
-The following recipes have been removed:
-
-- ``chkconfig``: obsolete
-
-- ``console-tools``: obsolete
-
-- ``enchant``: replaced by ``enchant2``
-
-- ``foomatic-filters``: obsolete
-
-- ``libidn``: no longer needed, moved to meta-oe
-
-- ``libmodulemd``: replaced by ``libmodulemd-v1``
-
-- ``linux-yocto``: drop 4.19, 5.2 version recipes (5.4 now provided)
-
-- ``nspr``: no longer needed, moved to meta-oe
-
-- ``nss``: no longer needed, moved to meta-oe
-
-- ``python``: Python 2 removed (Python 3 preferred)
-
-- ``python-setuptools``: Python 2 version removed (python3-setuptools
- preferred)
-
-- ``sysprof``: no longer needed, moved to meta-oe
-
-- ``texi2html``: obsolete
-
-- ``u-boot-fw-utils``: functionally replaced by ``libubootenv``
-
-.. _migration-3.1-features-check:
-
-features_check class replaces distro_features_check
----------------------------------------------------
-
-The ``distro_features_check`` class has had its functionality expanded,
-now supporting ``ANY_OF_MACHINE_FEATURES``,
-``REQUIRED_MACHINE_FEATURES``, ``CONFLICT_MACHINE_FEATURES``,
-``ANY_OF_COMBINED_FEATURES``, ``REQUIRED_COMBINED_FEATURES``,
-``CONFLICT_COMBINED_FEATURES``. As a result the class has now been
-renamed to ``features_check``; the ``distro_features_check`` class still
-exists but generates a warning and redirects to the new class. In
-preparation for a future removal of the old class it is recommended that
-you update recipes currently inheriting ``distro_features_check`` to
-inherit ``features_check`` instead.
-
-.. _migration-3.1-removed-classes:
-
-Removed classes
----------------
-
-The following classes have been removed:
-
-- ``distutils-base``: moved to meta-python2
-
-- ``distutils``: moved to meta-python2
-
-- ``libc-common``: merged into the glibc recipe as nothing else used
- it.
-
-- ``python-dir``: moved to meta-python2
-
-- ``pythonnative``: moved to meta-python2
-
-- ``setuptools``: moved to meta-python2
-
-- ``tinderclient``: dropped as it was obsolete.
-
-.. _migration-3.1-src-uri-checksums:
-
-SRC_URI checksum behaviour
---------------------------
-
-Previously, recipes by tradition included both SHA256 and MD5 checksums
-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
-it is specified.
-
-.. _migration-3.1-npm:
-
-npm fetcher changes
--------------------
-
-The npm fetcher has been completely reworked in this release. The npm
-fetcher now only fetches the package source itself and no longer the
-dependencies; there is now also an npmsw fetcher which explicitly
-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
-: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.
-
-An example of the new scheme::
-
- SRC_URI = "npm://registry.npmjs.org;package=array-flatten;version=1.1.1 \
- npmsw://${THISDIR}/npm-shrinkwrap.json"
-
-Another example where the sources are fetched from git rather than an npm repository::
-
- SRC_URI = "git://github.com/foo/bar.git;protocol=https \
- npmsw://${THISDIR}/npm-shrinkwrap.json"
-
-devtool and recipetool have also been updated to match with the npm
-fetcher changes. Other than producing working and more complete recipes
-for npm sources, there is also a minor change to the command line for
-devtool: the ``--fetch-dev`` option has been renamed to ``--npm-dev`` as
-it is npm-specific.
-
-.. _migration-3.1-packaging-changes:
-
-Packaging changes
------------------
-
-- ``intltool`` has been removed from ``packagegroup-core-sdk`` as it is
- rarely needed to build modern software - gettext can do most of the
- things it used to be needed for. ``intltool`` has also been removed
- from ``packagegroup-core-self-hosted`` as it is not needed to for
- standard builds.
-
-- git: ``git-am``, ``git-difftool``, ``git-submodule``, and
- ``git-request-pull`` are no longer perl-based, so are now installed
- with the main ``git`` package instead of within ``git-perltools``.
-
-- 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 :term:`RRECOMMENDS` of the main
- ``glibc`` package if ``ldconfig`` is present in
- :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
- through the normal shared library dependency handling, there should
- be no impact to existing configurations other than less unnecessary
- libraries being installed in some cases.
-
-- linux-firmware now has a new package for ``bcm4366c`` and includes
- available NVRAM config files into the ``bcm43340``, ``bcm43362``,
- ``bcm43430`` and ``bcm4356-pcie`` packages.
-
-- ``harfbuzz`` now splits the new ``libharfbuzz-subset.so`` library
- into its own package to reduce the main package size in cases where
- ``libharfbuzz-subset.so`` is not needed.
-
-.. _migration-3.1-package-qa-warnings:
-
-Additional warnings
--------------------
-
-Warnings will now be shown at ``do_package_qa`` time in the following
-circumstances:
-
-- A recipe installs ``.desktop`` files containing ``MimeType`` keys but
- does not inherit the new ``mime-xdg`` class
-
-- A recipe installs ``.xml`` files into ``${datadir}/mime/packages``
- but does not inherit the ``mime`` class
-
-.. _migration-3.1-x86-live-wic:
-
-``wic`` image type now used instead of ``live`` by default for x86
-------------------------------------------------------------------
-
-``conf/machine/include/x86-base.inc`` (inherited by most x86 machine
-configurations) now specifies ``wic`` instead of ``live`` by default in
-:term:`IMAGE_FSTYPES`. The ``live`` image type will
-likely be removed in a future release so it is recommended that you use
-``wic`` instead.
-
-.. _migration-3.1-misc:
-
-Miscellaneous changes
----------------------
-
-- The undocumented ``SRC_DISTRIBUTE_LICENSES`` variable has now been
- removed in favour of a new ``AVAILABLE_LICENSES`` variable which is
- dynamically set based upon license files found in
- ``${COMMON_LICENSE_DIR}`` and ``${LICENSE_PATH}``.
-
-- The tune definition for big-endian microblaze machines is now
- ``microblaze`` instead of ``microblazeeb``.
-
-- ``newlib`` no longer has built-in syscalls. ``libgloss`` should then
- provide the syscalls, ``crt0.o`` and other functions that are no
- longer part of ``newlib`` itself. If you are using
- ``TCLIBC = "newlib"`` this now means that you must link applications
- with both ``newlib`` and ``libgloss``, whereas before ``newlib``
- would run in many configurations by itself.
diff --git a/poky/documentation/ref-manual/migration-3.2.rst b/poky/documentation/ref-manual/migration-3.2.rst
deleted file mode 100644
index 956a56f..0000000
--- a/poky/documentation/ref-manual/migration-3.2.rst
+++ /dev/null
@@ -1,313 +0,0 @@
-Moving to the Yocto Project 3.2 Release (gatesgarth)
-====================================================
-
-This section provides migration information for moving to the Yocto
-Project 3.2 Release (codename "gatesgarth") from the prior release.
-
-.. _migration-3.2-minimum-system-requirements:
-
-Minimum system requirements
----------------------------
-
-``gcc`` version 6.0 is now required at minimum on the build host. For older
-host distributions where this is not available, you can use the
-``buildtools-extended-tarball`` (easily installable using
-``scripts/install-buildtools``).
-
-
-.. _migration-3.2-removed-recipes:
-
-Removed recipes
----------------
-
-The following recipes have been removed:
-
-- ``bjam-native``: replaced by ``boost-build-native``
-- ``avahi-ui``: folded into the main ``avahi`` recipe - the GTK UI can be disabled using :term:`PACKAGECONFIG` for ``avahi``.
-- ``build-compare``: no longer needed with the removal of the ``packagefeed-stability`` class
-- ``dhcp``: obsolete, functionally replaced by ``dhcpcd`` and ``kea``
-- ``libmodulemd-v1``: replaced by ``libmodulemd``
-- ``packagegroup-core-device-devel``: obsolete
-
-
-.. _migration-3.2-removed-classes:
-
-Removed classes
----------------
-
-The following classes (.bbclass files) have been removed:
-
-- ``spdx``: obsolete - the Yocto Project is a strong supporter of SPDX, but this class was old code using a dated approach and had the potential to be misleading. The ``meta-sdpxscanner`` layer is a much more modern and active approach to handling this and is recommended as a replacement.
-
-- ``packagefeed-stability``: this class had become obsolete with the advent of hash equivalence and reproducible builds.
-
-
-pseudo path filtering and mismatch behaviour
---------------------------------------------
-
-pseudo now operates on a filtered subset of files. This is a significant change
-to the way pseudo operates within OpenEmbedded - by default, pseudo monitors and
-logs (adds to its database) any file created or modified whilst in a ``fakeroot``
-environment. However, there are large numbers of files that we simply don't care
-about the permissions of whilst in that ``fakeroot`` context, for example ${:term:`S`}, ${:term:`B`}, ${:term:`T`},
-${:term:`SSTATE_DIR`}, the central sstate control directories, and others.
-
-As of this release, new functionality in pseudo is enabled to ignore these
-directory trees (controlled using a new :term:`PSEUDO_IGNORE_PATHS` variable)
-resulting in a cleaner database with less chance of "stray" mismatches if files
-are modified outside pseudo context. It also should reduce some overhead from
-pseudo as the interprocess round trip to the server is avoided.
-
-There is a possible complication where some existing recipe may break, for
-example, a recipe was found to be writing to ``${B}/install`` for
-``make install`` in ``do_install`` and since ``${B}`` is listed as not to be tracked,
-there were errors trying to ``chown root`` for files in this location. Another
-example was the ``tcl`` recipe where the source directory ``S`` is set to a
-subdirectory of the source tree but files were written out to the directory
-structure above that subdirectory. For these types of cases in your own recipes,
-extend ``PSEUDO_IGNORE_PATHS`` to cover additional paths that pseudo should not
-be monitoring.
-
-In addition, pseudo's behaviour on mismatches has now been changed - rather
-than doing what turns out to be a rather dangerous "fixup" if it sees a file
-with a different path but the same inode as another file it has previously seen,
-pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </Pseudo_Abort>`
-that explains how to deal with this.
-
-
-.. _migration-3.2-multilib-mlprefix:
-
-``MLPREFIX`` now required for multilib when runtime dependencies conditionally added
-------------------------------------------------------------------------------------
-
-In order to solve some previously intractable problems with runtime
-dependencies and multilib, a change was made that now requires the :term:`MLPREFIX`
-value to be explicitly prepended to package names being added as
-dependencies (e.g. in :term:`RDEPENDS` and :term:`RRECOMMENDS` values)
-where the dependency is conditionally added.
-
-If you have anonymous python or in-line python conditionally adding
-dependencies in your custom recipes, and you intend for those recipes to
-work with multilib, then you will need to ensure that ``${MLPREFIX}``
-is prefixed on the package names in the dependencies, for example
-(from the ``glibc`` recipe)::
-
- RRECOMMENDS_${PN} = "${@bb.utils.contains('DISTRO_FEATURES', 'ldconfig', '${MLPREFIX}ldconfig', '', d)}"
-
-This also applies when conditionally adding packages to :term:`PACKAGES` where
-those packages have dependencies, for example (from the ``alsa-plugins`` recipe)::
-
- PACKAGES += "${@bb.utils.contains('PACKAGECONFIG', 'pulseaudio', 'alsa-plugins-pulseaudio-conf', '', d)}"
- ...
- RDEPENDS_${PN}-pulseaudio-conf += "\
- ${MLPREFIX}libasound-module-conf-pulse \
- ${MLPREFIX}libasound-module-ctl-pulse \
- ${MLPREFIX}libasound-module-pcm-pulse \
- "
-
-
-.. _migration-3.2-packagegroup-core-device-devel:
-
-packagegroup-core-device-devel no longer included in images built for qemu* machines
-------------------------------------------------------------------------------------
-
-``packagegroup-core-device-devel`` was previously added automatically to
-images built for ``qemu*`` machines, however the purpose of the group and what
-it should contain is no longer clear, and in general, adding userspace
-development items to images is best done at the image/class level; thus this
-packagegroup was removed.
-
-This packagegroup previously pulled in the following:
-
-- ``distcc-config``
-- ``nfs-export-root``
-- ``bash``
-- ``binutils-symlinks``
-
-If you still need any of these in your image built for a ``qemu*`` machine
-then you will add them explicitly to :term:`IMAGE_INSTALL` or another
-appropriate place in the dependency chain for your image (if you have not
-already done so).
-
-
-.. _migration-3.2-dhcp:
-
-DHCP server/client replaced
----------------------------
-
-The ``dhcp`` software package has become unmaintained and thus has been
-functionally replaced by ``dhcpcd`` (client) and ``kea`` (server). You will
-need to replace references to the recipe/package names as appropriate - most
-commonly, at the package level ``dhcp-client`` should be replaced by
-``dhcpcd`` and ``dhcp-server`` should be replaced by ``kea``. If you have any
-custom configuration files for these they will need to be adapted - refer to
-the upstream documentation for ``dhcpcd`` and ``kea`` for further details.
-
-
-.. _migration-3.2-packaging-changes:
-
-Packaging changes
------------------
-
-- ``python3``: the ``urllib`` python package has now moved into the core package, as it is used more commonly than just netclient (e.g. email, xml, mimetypes, pydoc). In addition, the ``pathlib`` module is now also part of the core package.
-
-- ``iptables``: ``iptables-apply`` and ``ip6tables-apply`` have been split out to their own package to avoid a bash dependency in the main ``iptables`` package
-
-
-.. _migration-3.2-package-qa-checks:
-
-Package QA check changes
-------------------------
-
-Previously, the following package QA checks triggered warnings, however they can
-be indicators of genuine underlying problems and are therefore now treated as
-errors:
-
-- :ref:`already-stripped <qa-check-already-stripped>`
-- :ref:`compile-host-path <qa-check-compile-host-path>`
-- :ref:`installed-vs-shipped <qa-check-installed-vs-shipped>`
-- :ref:`ldflags <qa-check-ldflags>`
-- :ref:`pn-overrides <qa-check-pn-overrides>`
-- :ref:`rpaths <qa-check-rpaths>`
-- :ref:`staticdev <qa-check-staticdev>`
-- :ref:`unknown-configure-option <qa-check-unknown-configure-option>`
-- :ref:`useless-rpaths <qa-check-useless-rpaths>`
-
-In addition, the following new checks were added and default to triggering an error:
-
-- :ref:`shebang-size <qa-check-shebang-size>`: Check for shebang (#!) lines longer than 128 characters, which can give an error at runtime depending on the operating system.
-
-- :ref:`unhandled-features-check <qa-check-unhandled-features-check>`: Check if any of the variables supported by the :ref:`features_check <ref-classes-features_check>` class is set while not inheriting the class itself.
-
-- :ref:`missing-update-alternatives <qa-check-missing-update-alternatives>`: Check if the recipe sets the :term:`ALTERNATIVE` variable for any of its packages, and does not inherit the :ref:`update-alternatives <ref-classes-update-alternatives>` class.
-
-- A trailing slash or duplicated slashes in the value of :term:`S` or :term:`B` will now trigger a warning so that they can be removed and path comparisons can be more reliable - remove any instances of these in your recipes if the warning is displayed.
-
-
-.. _migration-3.2-src-uri-file-globbing:
-
-Globbing no longer supported in ``file://`` entries in ``SRC_URI``
-------------------------------------------------------------------
-
-Globbing (``*`` and ``?`` wildcards) in ``file://`` URLs within :term:`SRC_URI`
-did not properly support file checksums, thus changes to the source files
-would not always change the do_fetch task checksum, and consequently would
-not ensure that the changed files would be incorporated in subsequent builds.
-
-Unfortunately it is not practical to make globbing work generically here, so
-the decision was taken to remove support for globs in ``file://`` URLs.
-If you have any usage of these in your recipes, then you will now need to
-either add each of the files that you expect to match explicitly, or
-alternatively if you still need files to be pulled in dynamically, put the
-files into a subdirectory and reference that instead.
-
-
-.. _migration-3.2-deploydir-clean:
-
-deploy class now cleans ``DEPLOYDIR`` before ``do_deploy``
-----------------------------------------------------------
-
-``do_deploy`` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as ``do_install`` cleans up ${:term:`D`} before running. This reduces the risk of ``DEPLOYDIR`` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds.
-
-Most recipes and classes that inherit the ``deploy`` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` - these should be refactored to use ``do_deploy_prepend`` instead.
-
-
-.. _migration-3.2-nativesdk-sdk-provides-dummy:
-
-Custom SDK / SDK-style recipes need to include ``nativesdk-sdk-provides-dummy``
--------------------------------------------------------------------------------
-
-All ``nativesdk`` packages require ``/bin/sh`` due to their postinstall scriptlets, thus this package has to be dummy-provided within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have a custom SDK recipe (or your own SDK-style recipe similar to e.g. ``buildtools-tarball``), you will need to ensure ``nativesdk-sdk-provides-dummy`` or an equivalent is included in :term:`TOOLCHAIN_HOST_TASK`.
-
-
-``ld.so.conf`` now moved back to main ``glibc`` package
--------------------------------------------------------
-
-There are cases where one doesn't want ``ldconfig`` on target (e.g. for
-read-only root filesystems, it's rather pointless), yet one still
-needs ``/etc/ld.so.conf`` to be present at image build time:
-
-When some recipe installs libraries to a non-standard location, and
-therefore installs in a file in ``/etc/ld.so.conf.d/foo.conf``, we
-need ``/etc/ld.so.conf`` containing::
-
- include /etc/ld.so.conf.d/*.conf
-
-in order to get those other locations picked up.
-
-Thus ``/etc/ld.so.conf`` is now in the main ``glibc`` package so that
-there's always an ``ld.so.conf`` present when the build-time ``ldconfig``
-runs towards the end of image construction.
-
-The ``ld.so.conf`` and ``ld.so.conf.d/*.conf`` files do not take up
-significant space (at least not compared to the ~700kB ``ldconfig`` binary), and they
-might be needed in case ``ldconfig`` is installable, so they are left
-in place after the image is built. Technically it would be possible to
-remove them if desired, though it would not be trivial if you still
-wanted the build-time ldconfig to function (:term:`ROOTFS_POSTPROCESS_COMMAND`
-will not work as ``ldconfig`` is run after the functions referred to
-by that variable).
-
-
-.. _migration-3.2-virgl:
-
-Host DRI drivers now used for GL support within ``runqemu``
------------------------------------------------------------
-
-``runqemu`` now uses the mesa-native libraries everywhere virgl is used
-(i.e. when ``gl``, ``gl-es`` or ``egl-headless`` options are specified),
-but instructs them to load DRI drivers from the host. Unfortunately this
-may not work well with proprietary graphics drivers such as those from
-Nvidia; if you are using such drivers then you may need to switch to an
-alternative (such as Nouveau in the case of Nvidia hardware) or avoid
-using the GL options.
-
-
-.. _migration-3.2-initramfs-suffix:
-
-initramfs images now use a blank suffix
----------------------------------------
-
-The reference initramfs images (``core-image-minimal-initramfs``,
-``core-image-tiny-initramfs`` and ``core-image-testmaster-initramfs``) now
-set an empty string for :term:`IMAGE_NAME_SUFFIX`, which otherwise defaults
-to ``".rootfs"``. These images aren't root filesystems and thus the rootfs
-label didn't make sense. If you are looking for the output files generated
-by these image recipes directly then you will need to adapt to the new
-naming without the ``.rootfs`` part.
-
-
-.. _migration-3.2-image-artifact-names:
-
-Image artifact name variables now centralised in image-artifact-names class
----------------------------------------------------------------------------
-
-The defaults for the following image artifact name variables have been moved
-from bitbake.conf to a new ``image-artifact-names`` class:
-
-- :term:`IMAGE_BASENAME`
-- :term:`IMAGE_LINK_NAME`
-- :term:`IMAGE_NAME`
-- :term:`IMAGE_NAME_SUFFIX`
-- :term:`IMAGE_VERSION_SUFFIX`
-
-Image-related classes now inherit this class, and typically these variables
-are only referenced within image recipes so those will be unaffected by this
-change. However if you have references to these variables in either a recipe
-that is not an image or a class that is enabled globally, then those will
-now need to be changed to ``inherit image-artifact-names``.
-
-
-.. _migration-3.2-misc:
-
-Miscellaneous changes
----------------------
-
-- Support for the long-deprecated ``PACKAGE_GROUP`` variable has now been removed - replace any remaining instances with :term:`FEATURE_PACKAGES`.
-- The ``FILESPATHPKG`` variable, having been previously deprecated, has now been removed. Replace any remaining references with appropriate use of :term:`FILESEXTRAPATHS`.
-- Erroneous use of ``inherit +=`` (instead of ``INHERIT +=``) in a configuration file now triggers an error instead of silently being ignored.
-- ptest support has been removed from the ``kbd`` recipe, as upstream has moved to autotest which is difficult to work with in a cross-compilation environment.
-- ``oe.utils.is_machine_specific()`` and ``oe.utils.machine_paths()`` have been removed as their utility was questionable. In the unlikely event that you have references to these in your own code, then the code will need to be reworked.
-- The ``i2ctransfer`` module is now disabled by default when building ``busybox`` in order to be consistent with disabling the other i2c tools there. If you do wish the i2ctransfer module to be built in BusyBox then add ``CONFIG_I2CTRANSFER=y`` to your custom BusyBox configuration.
-- In the ``Upstream-Status`` header convention for patches, ``Accepted`` has been replaced with ``Backport`` as these almost always mean the same thing i.e. the patch is already upstream and may need to be removed in a future recipe upgrade. If you are adding these headers to your own patches then use ``Backport`` to indicate that the patch has been sent upstream.
-- The ``tune-supersparc.inc`` tune file has been removed as it does not appear to be widely used and no longer works.
diff --git a/poky/documentation/ref-manual/migration-3.3.rst b/poky/documentation/ref-manual/migration-3.3.rst
deleted file mode 100644
index 4fb51a3..0000000
--- a/poky/documentation/ref-manual/migration-3.3.rst
+++ /dev/null
@@ -1,168 +0,0 @@
-Moving to the Yocto Project 3.3 Release (hardknott)
-===================================================
-
-This section provides migration information for moving to the Yocto
-Project 3.3 Release (codename "hardknott") from the prior release.
-
-
-.. _migration-3.3-minimum-system-requirements:
-
-Minimum system requirements
----------------------------
-
-You will now need at least Python 3.6 installed on your build host. Most recent
-distributions provide this, but should you be building on a distribution that
-does not have it, you can use the ``buildtools-tarball`` (easily installable
-using ``scripts/install-buildtools``) - see
-:ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`
-for details.
-
-
-.. _migration-3.3-removed-recipes:
-
-Removed recipes
----------------
-
-The following recipes have been removed:
-
-- ``go-dep``: obsolete with the advent of go modules
-- ``gst-validate``: replaced by ``gst-devtools``
-- ``linux-yocto``: removed 5.8 version recipes (5.4 / 5.10 still provided)
-- ``vulkan-demos``: replaced by ``vulkan-samples``
-
-
-.. _migration-3.3-common-license-only-versions:
-
-Single version common license file naming
------------------------------------------
-
-Some license files in ``meta/files/common-licenses`` have been renamed to match
-current SPDX naming conventions:
-
-- AGPL-3.0 -> AGPL-3.0-only
-- GPL-1.0 -> GPL-1.0-only
-- GPL-2.0 -> GPL-2.0-only
-- GPL-3.0 -> GPL-3.0-only
-- LGPL-2.0 -> LGPL-2.0-only
-- LGPL-2.1 -> LGPL-2.1-only
-- LGPL-3.0 -> LGPL-3.0-only
-
-Additionally, corresponding "-or-later" suffixed files have been added e.g.
-``GPL-2.0-or-later``.
-
-It is not required that you change :term:`LICENSE` values as there are mappings
-from the original names in place; however, in rare cases where you have a recipe
-which sets :term:`LIC_FILES_CHKSUM` to point to file(s) in
-``meta/files/common-licenses`` (which in any case is not recommended) you will
-need to update those.
-
-
-.. _migration-3.3-python3targetconfig:
-
-New ``python3targetconfig`` class
----------------------------------
-
-A new :ref:`python3targetconfig <ref-classes-python3targetconfig>` class has been
-created for situations where you would previously have inherited the
-``python3native`` class but need access to target configuration data (such as
-correct installation directories). Recipes where this situation applies should
-be changed to inherit ``python3targetconfig`` instead of ``python3native``. This
-also adds a dependency on target ``python3``, so it should only be used where
-appropriate in order to avoid unnecessarily lengthening builds.
-
-Some example recipes where this change has been made: ``gpgme``, ``libcap-ng``,
-``python3-pycairo``.
-
-
-.. _migration-3.3-distutils-path:
-
-``setup.py`` path for python modules
-------------------------------------
-
-In a Python module, sometimes ``setup.py`` can be buried deep in the
-source tree. Previously this was handled in recipes by setting :term:`S` to
-point to the subdirectory within the source where ``setup.py`` is located.
-However with the recent :ref:`pseudo <overview-manual/concepts:fakeroot and pseudo>`
-changes, some Python modules make changes to files beneath ``${S}``, for
-example::
-
- S = "${WORKDIR}/git/python/pythonmodule"
-
-then in ``setup.py`` it works with source code in a relative fashion, such
-as ``../../src``. This causes pseudo to abort as it isn't able to track
-the paths properly. This release introduces a new :term:`DISTUTILS_SETUP_PATH`
-variable so that recipes can specify it explicitly, for example::
-
- S = "${WORKDIR}/git"
- DISTUTILS_SETUP_PATH = "${S}/python/pythonmodule"
-
-Recipes that inherit from :ref:`distutils3 <ref-classes-distutils3>` (or
-:ref:`setuptools3 <ref-classes-setuptools3>` which itself inherits
-:ref:`distutils3 <ref-classes-distutils3>`) that also set :term:`S` to
-point to a Python module within a subdirectory in the aforementioned
-manner should be changed to set :term:`DISTUTILS_SETUP_PATH` instead.
-
-
-.. _migration-3.3-bitbake:
-
-BitBake changes
----------------
-
-- BitBake is now configured to use a default ``umask`` of ``022`` for all tasks
- (specified via a new :term:`BB_DEFAULT_UMASK` variable). If needed, ``umask`` can
- still be set on a per-task basis via the ``umask`` varflag on the task
- function, but that is unlikely to be necessary in most cases.
-
-- If a version specified in :term:`PREFERRED_VERSION` is not available this
- will now trigger a warning instead of just a note, making such issues more
- visible.
-
-
-.. _migration-3.3-packaging:
-
-Packaging changes
------------------
-
-The following packaging changes have been made; in all cases the main package
-still depends upon the split out packages so you should not need to do anything
-unless you want to take advantage of the improved granularity:
-
-- ``dbus``: ``-common`` and ``-tools`` split out
-- ``iproute2``: split ``ip`` binary to its own package
-- ``net-tools``: split ``mii-tool`` into its own package
-- ``procps``: split ``ps`` and ``sysctl`` into their own packages
-- ``rpm``: split build and extra functionality into separate packages
-- ``sudo``: split ``sudo`` binary into ``sudo-sudo`` and libs into ``sudo-lib``
-- ``systemtap``: examples, python scripts and runtime material split out
-- ``util-linux``: ``libuuid`` has been split out to its own
- ``util-linux-libuuid`` recipe (and corresponding packages) to avoid circular
- dependencies if ``libgcrypt`` support is enabled in ``util-linux``.
- (``util-linux`` depends upon ``util-linux-libuuid``.)
-
-
-.. _migration-3.3-misc:
-
-Miscellaneous changes
----------------------
-
-- The default poky :term:`DISTRO_VERSION` value now uses the core metadata's
- git hash (i.e. :term:`METADATA_REVISION`) rather than the date (i.e.
- :term:`DATE`) to reduce one small source of non-reproducibility. You can
- of course specify your own :term:`DISTRO_VERSION` value as desired
- (particularly if you create your own custom distro configuration).
-- ``adwaita-icon-theme`` version 3.34.3 has been added back, and is selected
- as the default via :term:`PREFERRED_VERSION` in
- ``meta/conf/distro/include/default-versions.inc`` due to newer versions
- not working well with ``librsvg`` 2.40. ``librsvg`` is not practically
- upgradeable at the moment as it has been ported to Rust, and Rust is not
- (yet) in OE-Core, but this will change in a future release.
-- ``ffmpeg`` is now configured to disable GPL-licensed portions by default
- to make it harder to accidentally violate the GPL. To explicitly enable GPL
- licensed portions, add ``gpl`` to :term:`PACKAGECONFIG` for ``ffmpeg``
- using a bbappend (or use ``PACKAGECONFIG_append_pn-ffmpeg = " gpl"`` in
- your configuration.)
-- ``connman`` is now set to conflict with ``systemd-networkd`` as they
- overlap functionally and may interfere with each other at runtime.
-- Canonical SPDX license names are now used in image license manifests in
- order to avoid aliases of the same license from showing up together (e.g.
- ``GPLv2`` and ``GPL-2.0``)
diff --git a/poky/documentation/ref-manual/migration-general.rst b/poky/documentation/ref-manual/migration-general.rst
deleted file mode 100644
index 182482e..0000000
--- a/poky/documentation/ref-manual/migration-general.rst
+++ /dev/null
@@ -1,54 +0,0 @@
-General Migration Considerations
-================================
-
-Some considerations are not tied to a specific Yocto Project release.
-This section presents information you should consider when migrating to
-any new Yocto Project release.
-
-- *Dealing with Customized Recipes*:
-
- Issues could arise if you take
- older recipes that contain customizations and simply copy them
- forward expecting them to work after you migrate to new Yocto Project
- metadata. For example, suppose you have a recipe in your layer that
- is a customized version of a core recipe copied from the earlier
- release, rather than through the use of an append file. When you
- migrate to a newer version of Yocto Project, the metadata (e.g.
- perhaps an include file used by the recipe) could have changed in a
- way that would break the build. Say, for example, a function is
- removed from an include file and the customized recipe tries to call
- that function.
-
- You could "forward-port" all your customizations in your recipe so
- that everything works for the new release. However, this is not the
- optimal solution as you would have to repeat this process with each
- new release if changes occur that give rise to problems.
-
- The better solution (where practical) is to use append files
- (``*.bbappend``) to capture any customizations you want to make to a
- recipe. Doing so, isolates your changes from the main recipe making
- them much more manageable. However, sometimes it is not practical to
- use an append file. A good example of this is when introducing a
- newer or older version of a recipe in another layer.
-
-- *Updating Append Files*:
-
- Since append files generally only contain
- your customizations, they often do not need to be adjusted for new
- releases. However, if the ``.bbappend`` file is specific to a
- particular version of the recipe (i.e. its name does not use the %
- wildcard) and the version of the recipe to which it is appending has
- changed, then you will at a minimum need to rename the append file to
- match the name of the recipe file. A mismatch between an append file
- and its corresponding recipe file (``.bb``) will trigger an error
- during parsing.
-
- Depending on the type of customization the append file applies, other
- incompatibilities might occur when you upgrade. For example, if your
- append file applies a patch and the recipe to which it is appending
- is updated to a newer version, the patch might no longer apply. If
- this is the case and assuming the patch is still needed, you must
- modify the patch file so that it does apply.
-
-
-
diff --git a/poky/documentation/ref-manual/migration.rst b/poky/documentation/ref-manual/migration.rst
deleted file mode 100644
index a01d4ee..0000000
--- a/poky/documentation/ref-manual/migration.rst
+++ /dev/null
@@ -1,32 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-
-******************************************
-Migrating to a Newer Yocto Project Release
-******************************************
-
-This chapter provides information you can use to migrate work to a newer
-Yocto Project release. You can find the same information in the release
-notes for a given release.
-
-.. toctree::
-
- migration-general
- migration-1.3
- migration-1.4
- migration-1.5
- migration-1.6
- migration-1.7
- migration-1.8
- migration-2.0
- migration-2.1
- migration-2.2
- migration-2.3
- migration-2.4
- migration-2.5
- migration-2.6
- migration-2.7
- migration-3.0
- migration-3.1
- migration-3.2
- migration-3.3
-
diff --git a/poky/documentation/ref-manual/qa-checks.rst b/poky/documentation/ref-manual/qa-checks.rst
index 2e98713..a105acc 100644
--- a/poky/documentation/ref-manual/qa-checks.rst
+++ b/poky/documentation/ref-manual/qa-checks.rst
@@ -88,7 +88,7 @@
A file-level dependency has been identified from the specified
package on the specified files, but there is no explicit
corresponding entry in :term:`RDEPENDS`. If
- particular files are required at runtime then ``RDEPENDS`` should be
+ particular files are required at runtime then :term:`RDEPENDS` should be
declared in the recipe to ensure the packages providing them are
built.
@@ -104,7 +104,7 @@
: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.
+ to add an explicit :term:`RDEPENDS` for the dependency.
.. _qa-check-dev-so:
@@ -152,7 +152,7 @@
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 :term:`FILES` for additional
- information on ``FILES``.
+ information on :term:`FILES`.
.. _qa-check-arch:
@@ -235,9 +235,9 @@
This indicates that binaries produced when building the recipe have
not been linked with the :term:`LDFLAGS` options
- provided by the build system. Check to be sure that the ``LDFLAGS``
+ provided by the build system. Check to be sure that the :term:`LDFLAGS`
variable is being passed to the linker command. A common workaround
- for this situation is to pass in ``LDFLAGS`` using
+ for this situation is to pass in :term:`LDFLAGS` using
:term:`TARGET_CC_ARCH` within the recipe as
follows::
@@ -403,7 +403,7 @@
If your recipe name does not match this, or you add packages to
: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``,
+ if you have added a non-conforming package name to :term:`PACKAGES`,
change the package name appropriately.
@@ -431,13 +431,13 @@
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 :term:`MACHINE`
+ such that its :term:`PN` value matches something already in :term:`OVERRIDES`
+ (e.g. :term:`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
+ Rename your recipe (or if :term:`PN` is being set explicitly, change the
+ :term:`PN` value) so that the conflict does not occur. See
:term:`FILES` for additional information.
@@ -464,7 +464,7 @@
This check looks for instances of setting ``DEPENDS_${PN}``
which is erroneous (:term:`DEPENDS` is a recipe-wide variable and thus
it is not correct to specify it for a particular package, nor will such
- an assignment actually work.) Set ``DEPENDS`` instead.
+ an assignment actually work.) Set :term:`DEPENDS` instead.
.. _qa-check-already-stripped:
@@ -499,7 +499,7 @@
Package names must appear only once in the
:term:`PACKAGES` variable. You might receive this
- error if you are attempting to add a package to ``PACKAGES`` that is
+ error if you are attempting to add a package to :term:`PACKAGES` that is
already in the variable's value.
@@ -523,7 +523,7 @@
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
+ - Add the files to :term:`FILES` for the package you want them to appear
in (e.g. ``FILES_${``\ :term:`PN`\ ``}`` for the main
package).
diff --git a/poky/documentation/ref-manual/release-process.rst b/poky/documentation/ref-manual/release-process.rst
index 935a2e3..ab143f7 100644
--- a/poky/documentation/ref-manual/release-process.rst
+++ b/poky/documentation/ref-manual/release-process.rst
@@ -62,8 +62,10 @@
Releases are given a nominal release version as well but the codename is
used in repositories for this reason. You can find information on Yocto
-Project releases and codenames at
-:yocto_wiki:`/Releases`.
+Project releases and codenames at :yocto_wiki:`/Releases`.
+
+Our :doc:`/migration-guides/index` detail how to migrate from one release of
+the Yocto Project to the next.
Stable Release Process
======================
@@ -164,9 +166,8 @@
.. note::
- You can find all these branches in the Yocto Project
- Source Repositories
- .
+ You can find all these branches in the
+ :ref:`overview-manual/development-environment:yocto project source repositories`.
Testing within these public branches ensures in a publicly visible way
that all of the main supposed architectures and recipes in OE-Core
diff --git a/poky/documentation/ref-manual/structure.rst b/poky/documentation/ref-manual/structure.rst
index 36c9efc..5f00edb 100644
--- a/poky/documentation/ref-manual/structure.rst
+++ b/poky/documentation/ref-manual/structure.rst
@@ -251,9 +251,9 @@
relatively rare.
At a minimum, you would normally edit this file to select the target
-``MACHINE``, which package types you wish to use
+:term:`MACHINE`, which package types you wish to use
(:term:`PACKAGE_CLASSES`), and the location from
-which you want to access downloaded files (``DL_DIR``).
+which you want to access downloaded files (:term:`DL_DIR`).
If ``local.conf`` is not present when you start the build, the
OpenEmbedded build system creates it from ``local.conf.sample`` when you
@@ -336,7 +336,7 @@
This directory contains downloaded upstream source tarballs. You can
reuse the directory for multiple builds or move the directory to another
location. You can control the location of this directory through the
-``DL_DIR`` variable.
+:term:`DL_DIR` variable.
.. _structure-build-sstate-cache:
@@ -346,7 +346,7 @@
This directory contains the shared state cache. You can reuse the
directory for multiple builds or move the directory to another location.
You can control the location of this directory through the
-``SSTATE_DIR`` variable.
+:term:`SSTATE_DIR` variable.
.. _structure-build-tmp:
@@ -548,7 +548,7 @@
------------------
This directory contains general logs that are not otherwise placed using
-the package's ``WORKDIR``. Examples of logs are the output from the
+the package's :term:`WORKDIR`. Examples of logs are the output from the
``do_check_pkg`` or ``do_distro_check`` tasks. Running a build does not
necessarily mean this directory is created.
@@ -569,7 +569,7 @@
example, consider ``linux-yocto-kernel-3.0`` on the machine ``qemux86``
built within the Yocto Project. For this package, a work directory of
``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred
-to as the ``WORKDIR``, is created. Within this directory, the source is
+to as the :term:`WORKDIR`, is created. Within this directory, the source is
unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt.
(See the ":ref:`dev-manual/common-tasks:using quilt in your workflow`" section in
the Yocto Project Development Tasks Manual for more information.) Within
@@ -577,7 +577,7 @@
directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and
standard Quilt commands can be used.
-There are other directories generated within ``WORKDIR``. The most
+There are other directories generated within :term:`WORKDIR`. The most
important directory is ``WORKDIR/temp/``, which has log files for each
task (``log.do_*.pid``) and contains the scripts BitBake runs for each
task (``run.do_*.pid``). The ``WORKDIR/image/`` directory is where "make
@@ -709,7 +709,7 @@
The contents of this directory controls any distribution-specific
configurations. For the Yocto Project, the ``defaultsetup.conf`` is the
-main file here. This directory includes the versions and the ``SRCDATE``
+main file here. This directory includes the versions and the :term:`SRCDATE`
definitions for applications that are configured here. An example of an
alternative configuration might be ``poky-bleeding.conf``. Although this
file mainly inherits its configuration from Poky.
diff --git a/poky/documentation/ref-manual/tasks.rst b/poky/documentation/ref-manual/tasks.rst
index 5bceb79..970b083 100644
--- a/poky/documentation/ref-manual/tasks.rst
+++ b/poky/documentation/ref-manual/tasks.rst
@@ -57,7 +57,7 @@
The default behavior of this task is to run ``oe_runmake clean`` if a
makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found and
:term:`CLEANBROKEN` is not set to "1". If no such
-file is found or the ``CLEANBROKEN`` variable is set to "1", the
+file is found or the :term:`CLEANBROKEN` variable is set to "1", the
``do_configure`` task does nothing.
.. _ref-tasks-configure_ptest_base:
@@ -308,17 +308,17 @@
poky/meta/recipes-connectivity/bluez5/bluez5
-In the ``bluez5`` recipe, the ``SRC_URI`` statements point to the source
+In the ``bluez5`` recipe, the :term:`SRC_URI` statements point to the source
and patch files needed to build the package.
.. note::
- In the case for the ``bluez5_5.48.bb`` recipe, the ``SRC_URI`` statements
+ In the case for the ``bluez5_5.48.bb`` recipe, the :term:`SRC_URI` statements
are from an include file ``bluez5.inc``.
As mentioned earlier, the build system treats files whose file types are
``.patch`` and ``.diff`` as patch files. However, you can use the
-"apply=yes" parameter with the ``SRC_URI`` statement to indicate any
+"apply=yes" parameter with the :term:`SRC_URI` statement to indicate any
file as a patch file::
SRC_URI = " \
@@ -329,7 +329,7 @@
Conversely, if you have a directory full of patch files and you want to
exclude some so that the ``do_patch`` task does not apply them during
the patch phase, you can use the "apply=no" parameter with the
-``SRC_URI`` statement::
+:term:`SRC_URI` statement::
SRC_URI = " \
git://path_to_repo/some_package \
@@ -430,7 +430,7 @@
reside. For more information on how source files are unpacked, see the
":ref:`overview-manual/concepts:source fetching`"
section in the Yocto Project Overview and Concepts Manual and also see
-the ``WORKDIR`` and ``S`` variable descriptions.
+the :term:`WORKDIR` and :term:`S` variable descriptions.
Manually Called Tasks
=====================
diff --git a/poky/documentation/ref-manual/terms.rst b/poky/documentation/ref-manual/terms.rst
index 0af9af6..54469e5 100644
--- a/poky/documentation/ref-manual/terms.rst
+++ b/poky/documentation/ref-manual/terms.rst
@@ -97,11 +97,11 @@
.. note::
By default, the Build Directory contains :term:`TMPDIR`, which is a
- temporary directory the build system uses for its work. ``TMPDIR`` cannot
+ temporary directory the build system uses for its work. :term:`TMPDIR` cannot
be under NFS. Thus, by default, the Build Directory cannot be under
NFS. However, if you need the Build Directory to be under NFS, you can
- set this up by setting ``TMPDIR`` in your ``local.conf`` file to use a local
- drive. Doing so effectively separates ``TMPDIR`` from :term:`TOPDIR`, which is the
+ set this up by setting :term:`TMPDIR` in your ``local.conf`` file to use a local
+ drive. Doing so effectively separates :term:`TMPDIR` from :term:`TOPDIR`, which is the
Build Directory.
:term:`Build Host`
diff --git a/poky/documentation/ref-manual/variables.rst b/poky/documentation/ref-manual/variables.rst
index df6413b..71c2e11 100644
--- a/poky/documentation/ref-manual/variables.rst
+++ b/poky/documentation/ref-manual/variables.rst
@@ -63,7 +63,7 @@
Used by the alternatives system to map duplicated commands to actual
locations. For example, if the ``bracket`` command provided by the
``busybox`` package is duplicated through another package, you must
- use the ``ALTERNATIVE_LINK_NAME`` variable to specify the actual
+ use the :term:`ALTERNATIVE_LINK_NAME` variable to specify the actual
location::
ALTERNATIVE_LINK_NAME[bracket] = "/usr/bin/["
@@ -73,7 +73,7 @@
.. note::
- If ``ALTERNATIVE_LINK_NAME`` is not defined, it defaults to ``${bindir}/name``.
+ If :term:`ALTERNATIVE_LINK_NAME` is not defined, it defaults to ``${bindir}/name``.
For more information on the alternatives system, see the
":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
@@ -109,11 +109,11 @@
.. note::
- If ``ALTERNATIVE_TARGET`` is not defined, it inherits the value
+ If :term:`ALTERNATIVE_TARGET` is not defined, it inherits the value
from the :term:`ALTERNATIVE_LINK_NAME` variable.
- If ``ALTERNATIVE_LINK_NAME`` and ``ALTERNATIVE_TARGET`` are the
- same, the target for ``ALTERNATIVE_TARGET`` has "``.{BPN}``"
+ If :term:`ALTERNATIVE_LINK_NAME` and :term:`ALTERNATIVE_TARGET` are the
+ same, the target for :term:`ALTERNATIVE_TARGET` has "``.{BPN}``"
appended to it.
Finally, if the file referenced has not been renamed, the
@@ -131,8 +131,8 @@
class, this variable identifies a list of distribution features where
at least one must be enabled in the current configuration in order
for the OpenEmbedded build system to build the recipe. In other words,
- if none of the features listed in ``ANY_OF_DISTRO_FEATURES``
- appear in ``DISTRO_FEATURES`` within the current configuration, then
+ if none of the features listed in :term:`ANY_OF_DISTRO_FEATURES`
+ appear in :term:`DISTRO_FEATURES` within the current configuration, then
the recipe will be skipped, and if the build system attempts to build
the recipe then an error will be triggered.
@@ -174,7 +174,7 @@
attempt to build. Instead, BitBake assumes these recipes have already
been built.
- In OpenEmbedded-Core, ``ASSUME_PROVIDED`` mostly specifies native
+ In OpenEmbedded-Core, :term:`ASSUME_PROVIDED` mostly specifies native
tools that should not be built. An example is ``git-native``, which
when specified, allows for the Git binary from the host to be used
rather than building ``git-native``.
@@ -200,7 +200,7 @@
:term:`AUTO_LIBNAME_PKGS`
When the :ref:`debian <ref-classes-debian>` class is inherited,
- which is the default behavior, ``AUTO_LIBNAME_PKGS`` specifies which
+ which is the default behavior, :term:`AUTO_LIBNAME_PKGS` specifies which
packages should be checked for libraries and renamed according to
Debian library package naming.
@@ -213,7 +213,7 @@
:ref:`syslinux <ref-classes-syslinux>` class checks this variable.
:term:`AUTOREV`
- When ``SRCREV`` is set to the value of this variable, it specifies to
+ When :term:`SRCREV` is set to the value of this variable, it specifies to
use the latest source revision in the repository. Here is an example::
SRCREV = "${AUTOREV}"
@@ -224,7 +224,7 @@
have a kernel recipe that inherits the
:ref:`kernel <ref-classes-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
+ into :term:`PV`. Consequently, you need to change :term:`PV` in your recipe
so that it does contain ``${SRCPV}``.
For more information see the
@@ -238,8 +238,8 @@
.. note::
- It is assumed that all changes to ``COMMON_LICENSE_DIR`` and
- ``LICENSE_PATH`` have been done before ``AVAILABLE_LICENSES``
+ It is assumed that all changes to :term:`COMMON_LICENSE_DIR` and
+ :term:`LICENSE_PATH` have been done before :term:`AVAILABLE_LICENSES`
is defined (in :ref:`ref-classes-license`).
:term:`AVAILTUNES`
@@ -279,7 +279,7 @@
S = "${WORKDIR}/${BP}"
- You can separate the (``S``) directory and the directory pointed to
+ You can separate the (:term:`S`) directory and the directory pointed to
by the ``B`` variable. Most Autotools-based recipes support
separating these directories. The build system defaults to using
separate directories for ``gcc`` and some kernel recipes.
@@ -289,7 +289,7 @@
packages are packages installed only through the
:term:`RRECOMMENDS` variable. You can prevent any
of these "recommended" packages from being installed by listing them
- with the ``BAD_RECOMMENDATIONS`` variable::
+ with the :term:`BAD_RECOMMENDATIONS` variable::
BAD_RECOMMENDATIONS = "package_name package_name package_name ..."
@@ -314,12 +314,12 @@
:term:`BASE_LIB`
The library directory name for the CPU or Application Binary
- Interface (ABI) tune. The ``BASE_LIB`` applies only in the Multilib
+ Interface (ABI) tune. The :term:`BASE_LIB` applies only in the Multilib
context. See the ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`"
section in the Yocto Project Development Tasks Manual for information
on Multilib.
- The ``BASE_LIB`` variable is defined in the machine include files in
+ The :term:`BASE_LIB` variable is defined in the machine include files in
the :term:`Source Directory`. If Multilib is not
being used, the value defaults to "lib".
@@ -332,7 +332,7 @@
to use to obtain the required source code. Following are
considerations surrounding this variable:
- - This host list is only used if ``BB_NO_NETWORK`` is either not set
+ - This host list is only used if :term:`BB_NO_NETWORK` is either not set
or set to "0".
- There is limited support for wildcard matching against the beginning of
@@ -357,14 +357,14 @@
- Attempts to access networks not in the host list cause a failure.
- Using ``BB_ALLOWED_NETWORKS`` in conjunction with
+ Using :term:`BB_ALLOWED_NETWORKS` in conjunction with
:term:`PREMIRRORS` is very useful. Adding the host
- you want to use to ``PREMIRRORS`` results in the source code being
+ you want to use to :term:`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 :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.
+ host listed in :term:`SRC_URI` after a successful fetch from the
+ :term:`PREMIRRORS` occurs.
:term:`BB_DANGLINGAPPENDS_WARNONLY`
Defines how BitBake handles situations where an append file
@@ -389,7 +389,7 @@
you to control the build based on these parameters.
Disk space monitoring is disabled by default. To enable monitoring,
- add the ``BB_DISKMON_DIRS`` variable to your ``conf/local.conf`` file
+ add the :term:`BB_DISKMON_DIRS` variable to your ``conf/local.conf`` file
found in the :term:`Build Directory`. Use the
following form:
@@ -444,7 +444,7 @@
variable, the build system also issue a warning when the disk space
in the ``${SSTATE_DIR}`` directory drops below 1 Gbyte or the number
of free inodes drops below 100 Kbytes. Subsequent warnings are issued
- during intervals as defined by the ``BB_DISKMON_WARNINTERVAL``
+ during intervals as defined by the :term:`BB_DISKMON_WARNINTERVAL`
variable.
The second example stops the build after all currently executing
@@ -461,14 +461,14 @@
intervals, define the variable in your ``conf/local.conf`` file in
the :term:`Build Directory`.
- If you are going to use the ``BB_DISKMON_WARNINTERVAL`` variable, you
+ If you are going to use the :term:`BB_DISKMON_WARNINTERVAL` variable, you
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.
- If you do not provide a ``BB_DISKMON_WARNINTERVAL`` variable and you
- do use ``BB_DISKMON_DIRS`` with the "WARN" action, the disk
+ If you do not provide a :term:`BB_DISKMON_WARNINTERVAL` variable and you
+ do use :term:`BB_DISKMON_DIRS` with the "WARN" action, the disk
monitoring interval defaults to the following::
BB_DISKMON_WARNINTERVAL = "50M,5K"
@@ -521,7 +521,7 @@
``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
+ clean up your :term:`DL_DIR` directory by deleting any Git or other
source control work directories.
:term:`BB_NUMBER_THREADS`
@@ -529,13 +529,13 @@
time. The OpenEmbedded build system automatically configures this
variable to be equal to the number of cores on the build system. For
example, a system with a dual core processor that also uses
- hyper-threading causes the ``BB_NUMBER_THREADS`` variable to default
+ hyper-threading causes the :term:`BB_NUMBER_THREADS` variable to default
to "4".
For single socket systems (i.e. one CPU), you should not have to
override this variable to gain optimal parallelism during builds.
However, if you have very large systems that employ multiple physical
- CPUs, you might want to make sure the ``BB_NUMBER_THREADS`` variable
+ CPUs, you might want to make sure the :term:`BB_NUMBER_THREADS` variable
is not set higher than "20".
For more information on speeding up builds, see the
@@ -544,7 +544,7 @@
:term:`BB_SERVER_TIMEOUT`
Specifies the time (in seconds) after which to unload the BitBake
- server due to inactivity. Set ``BB_SERVER_TIMEOUT`` to determine how
+ server due to inactivity. Set :term:`BB_SERVER_TIMEOUT` to determine how
long the BitBake server stays resident between invocations.
For example, the following statement in your ``local.conf`` file
@@ -562,7 +562,7 @@
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
:term:`MACHINE`; "nativesdk", which targets the SDK
- machine instead of ``MACHINE``; and "mulitlibs" in the form
+ machine instead of :term:`MACHINE`; and "mulitlibs" in the form
"``multilib:``\ multilib_name".
To build a different variant of the recipe with a minimal amount of
@@ -573,13 +573,13 @@
.. note::
- Internally, the ``BBCLASSEXTEND`` mechanism generates recipe
+ Internally, the :term:`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 :term:`DEPENDS` on "foo" is rewritten
to a ``DEPENDS`` on "foo-native".
- Even when using ``BBCLASSEXTEND``, the recipe is only parsed once.
+ Even when using :term:`BBCLASSEXTEND`, the recipe is only parsed once.
Parsing once adds some limitations. For example, it is not
possible to include a different file depending on the variant,
since ``include`` statements are processed when the recipe is
@@ -605,14 +605,14 @@
- effectively letting you control the precedence for the multiple
layers. The precedence established through this variable stands
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
+ example, a layer that has a recipe with a higher :term:`PV` value but for
+ which the :term:`BBFILE_PRIORITY` is set to have a lower precedence still
has a lower precedence.
- A larger value for the ``BBFILE_PRIORITY`` variable results in a
+ A larger value for the :term:`BBFILE_PRIORITY` variable results in a
higher precedence. For example, the value 6 has a higher precedence
- than the value 5. If not specified, the ``BBFILE_PRIORITY`` variable
- is set based on layer dependencies (see the ``LAYERDEPENDS`` variable
+ than the value 5. If not specified, the :term:`BBFILE_PRIORITY` variable
+ is set based on layer dependencies (see the :term:`LAYERDEPENDS` variable
for more information. The default priority, if unspecified for a
layer with no dependencies, is the lowest defined priority + 1 (or 1
if no priorities are defined).
@@ -635,12 +635,12 @@
Activates content when identified layers are present. You identify
the layers by the collections that the layers define.
- Use the ``BBFILES_DYNAMIC`` variable to avoid ``.bbappend`` files
+ Use the :term:`BBFILES_DYNAMIC` variable to avoid ``.bbappend`` files
whose corresponding ``.bb`` file is in a layer that attempts to
modify other layers through ``.bbappend`` but does not want to
introduce a hard dependency on those other layers.
- Use the following form for ``BBFILES_DYNAMIC``:
+ Use the following form for :term:`BBFILES_DYNAMIC`:
collection_name:filename_pattern The following example identifies two
collection names and two filename patterns::
@@ -664,7 +664,7 @@
:term:`BBINCLUDELOGS_LINES`
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``,
+ reporting a failed task. If you do not set :term:`BBINCLUDELOGS_LINES`,
the entire log is printed.
:term:`BBLAYERS`
@@ -685,7 +685,7 @@
:term:`BBMASK`
Prevents BitBake from processing recipes and recipe append files.
- You can use the ``BBMASK`` variable to "hide" these ``.bb`` and
+ You can use the :term:`BBMASK` variable to "hide" these ``.bb`` and
``.bbappend`` files. BitBake ignores any recipe or recipe append
files that match any of the expressions. It is as if BitBake does not
see them at all. Consequently, matching files are not parsed or
@@ -732,7 +732,7 @@
``conf/multiconfig`` directory (e.g.
build_directory\ ``/conf/multiconfig/configA.conf``).
- For information on how to use ``BBMULTICONFIG`` in an environment
+ For information on how to use :term:`BBMULTICONFIG` in an environment
that supports building targets with multiple configurations, see the
":ref:`dev-manual/common-tasks:building images for multiple targets using multiple configurations`"
section in the Yocto Project Development Tasks Manual.
@@ -744,7 +744,7 @@
.. note::
If you run BitBake from a directory outside of the
- :term:`Build Directory`, you must be sure to set ``BBPATH``
+ :term:`Build Directory`, you must be sure to set :term:`BBPATH`
to point to the Build Directory. Set the variable as you would any
environment variable and then run BitBake::
@@ -754,7 +754,7 @@
:term:`BBSERVER`
- If defined in the BitBake environment, ``BBSERVER`` points to the
+ If defined in the BitBake environment, :term:`BBSERVER` points to the
BitBake remote server.
Use the following format to export the variable to the BitBake
@@ -762,9 +762,9 @@
export BBSERVER=localhost:$port
- By default, ``BBSERVER`` also appears in
+ By default, :term:`BBSERVER` also appears in
:term:`bitbake:BB_HASHBASE_WHITELIST`.
- Consequently, ``BBSERVER`` is excluded from checksum and dependency
+ Consequently, :term:`BBSERVER` is excluded from checksum and dependency
data.
:term:`BINCONFIG`
@@ -791,7 +791,7 @@
.. note::
- The ``BINCONFIG_GLOB`` variable uses
+ The :term:`BINCONFIG_GLOB` variable uses
`shell globbing <https://tldp.org/LDP/abs/html/globbingref.html>`__,
which is recognition and expansion of wildcards during pattern
matching. Shell globbing is very similar to
@@ -806,7 +806,7 @@
:term:`BP`
The base recipe name and version but without any special recipe name
- suffix (i.e. ``-native``, ``lib64-``, and so forth). ``BP`` is
+ suffix (i.e. ``-native``, ``lib64-``, and so forth). :term:`BP` is
comprised of the following::
${BPN}-${PV}
@@ -828,23 +828,23 @@
:term:`BUILD_ARCH`
Specifies the architecture of the build host (e.g. ``i686``). The
- OpenEmbedded build system sets the value of ``BUILD_ARCH`` from the
+ OpenEmbedded build system sets the value of :term:`BUILD_ARCH` from the
machine name reported by the ``uname`` command.
:term:`BUILD_AS_ARCH`
Specifies the architecture-specific assembler flags for the build
- host. By default, the value of ``BUILD_AS_ARCH`` is empty.
+ host. By default, the value of :term:`BUILD_AS_ARCH` is empty.
:term:`BUILD_CC_ARCH`
Specifies the architecture-specific C compiler flags for the build
- host. By default, the value of ``BUILD_CC_ARCH`` is empty.
+ host. By default, the value of :term:`BUILD_CC_ARCH` is empty.
:term:`BUILD_CCLD`
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``
+ compiler is being used as the linker. By default, :term:`BUILD_CCLD`
points to GCC and passes as arguments the value of
:term:`BUILD_CC_ARCH`, assuming
- ``BUILD_CC_ARCH`` is set.
+ :term:`BUILD_CC_ARCH` is set.
:term:`BUILD_CFLAGS`
Specifies the flags to pass to the C compiler when building for the
@@ -866,19 +866,19 @@
:term:`BUILD_FC`
Specifies the Fortran compiler command for the build host. By
- default, ``BUILD_FC`` points to Gfortran and passes as arguments the
+ default, :term:`BUILD_FC` points to Gfortran and passes as arguments the
value of :term:`BUILD_CC_ARCH`, assuming
- ``BUILD_CC_ARCH`` is set.
+ :term:`BUILD_CC_ARCH` is set.
:term:`BUILD_LD`
Specifies the linker command for the build host. By default,
- ``BUILD_LD`` points to the GNU linker (ld) and passes as arguments
+ :term:`BUILD_LD` points to the GNU linker (ld) and passes as arguments
the value of :term:`BUILD_LD_ARCH`, assuming
- ``BUILD_LD_ARCH`` is set.
+ :term:`BUILD_LD_ARCH` is set.
:term:`BUILD_LD_ARCH`
Specifies architecture-specific linker flags for the build host. By
- default, the value of ``BUILD_LD_ARCH`` is empty.
+ default, the value of :term:`BUILD_LD_ARCH` is empty.
:term:`BUILD_LDFLAGS`
Specifies the flags to pass to the linker when building for the build
@@ -903,13 +903,13 @@
:term:`BUILD_PREFIX`
The toolchain binary prefix used for native recipes. The OpenEmbedded
- build system uses the ``BUILD_PREFIX`` value to set the
+ build system uses the :term:`BUILD_PREFIX` value to set the
:term:`TARGET_PREFIX` when building for
``native`` recipes.
:term:`BUILD_STRIP`
Specifies the command to be used to strip debugging symbols from
- binaries produced for the build host. By default, ``BUILD_STRIP``
+ binaries produced for the build host. By default, :term:`BUILD_STRIP`
points to
``${``\ :term:`BUILD_PREFIX`\ ``}strip``.
@@ -922,7 +922,7 @@
on :term:`BUILD_ARCH`,
:term:`BUILD_VENDOR`, and
:term:`BUILD_OS`. You do not need to set the
- ``BUILD_SYS`` variable yourself.
+ :term:`BUILD_SYS` variable yourself.
:term:`BUILD_VENDOR`
Specifies the vendor name to use when building for the build host.
@@ -933,7 +933,7 @@
You can define this directory indirectly through the
:ref:`structure-core-script` script by passing in a Build
Directory path when you run the script. If you run the script and do
- not provide a Build Directory path, the ``BUILDDIR`` defaults to
+ not provide a Build Directory path, the :term:`BUILDDIR` defaults to
``build`` in the current directory.
:term:`BUILDHISTORY_COMMIT`
@@ -954,12 +954,12 @@
:term:`BUILDHISTORY_COMMIT_AUTHOR`
When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
class, this variable specifies the author to use for each Git commit.
- In order for the ``BUILDHISTORY_COMMIT_AUTHOR`` variable to work, the
+ In order for the :term:`BUILDHISTORY_COMMIT_AUTHOR` variable to work, the
:term:`BUILDHISTORY_COMMIT` variable must
be set to "1".
Git requires that the value you provide for the
- ``BUILDHISTORY_COMMIT_AUTHOR`` variable takes the form of "name
+ :term:`BUILDHISTORY_COMMIT_AUTHOR` variable takes the form of "name
email@host". Providing an email address or host that is not valid
does not produce an error.
@@ -1025,7 +1025,7 @@
When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
class, this variable optionally specifies a remote repository to
which build history pushes Git changes. In order for
- ``BUILDHISTORY_PUSH_REPO`` to work,
+ :term:`BUILDHISTORY_PUSH_REPO` to work,
:term:`BUILDHISTORY_COMMIT` must be set to
"1".
@@ -1066,7 +1066,7 @@
Points to the location of the directory that holds build statistics
when you use and enable the
:ref:`buildstats <ref-classes-buildstats>` class. The
- ``BUILDSTATS_BASE`` directory defaults to
+ :term:`BUILDSTATS_BASE` directory defaults to
``${``\ :term:`TMPDIR`\ ``}/buildstats/``.
:term:`BUSYBOX_SPLIT_SUID`
@@ -1075,7 +1075,7 @@
``setuid root``, and one for the remaining features (i.e. those that
do not require ``setuid root``).
- The ``BUSYBOX_SPLIT_SUID`` variable defaults to "1", which results in
+ The :term:`BUSYBOX_SPLIT_SUID` variable defaults to "1", which results in
splitting the output executable file. Set the variable to "0" to get
a single output executable file.
@@ -1092,7 +1092,7 @@
exported to an environment variable and thus made visible to the
software being built during the compilation step.
- Default initialization for ``CFLAGS`` varies depending on what is
+ Default initialization for :term:`CFLAGS` varies depending on what is
being built:
- :term:`TARGET_CFLAGS` when building for the
@@ -1131,12 +1131,12 @@
FOO_class-native = "native"
FOO = "other"
- The underlying mechanism behind ``CLASSOVERRIDE`` is simply
+ The underlying mechanism behind :term:`CLASSOVERRIDE` is simply
that it is included in the default value of
:term:`OVERRIDES`.
:term:`CLEANBROKEN`
- If set to "1" within a recipe, ``CLEANBROKEN`` specifies that the
+ If set to "1" within a recipe, :term:`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 :ref:`ref-tasks-configure`
@@ -1185,7 +1185,7 @@
.. note::
- The ``COMPLEMENTARY_GLOB`` variable uses Unix filename pattern matching
+ The :term:`COMPLEMENTARY_GLOB` variable uses Unix filename pattern matching
(`fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__),
which is similar to the Unix style pathname pattern expansion
(`glob <https://docs.python.org/3/library/glob.html>`__).
@@ -1193,7 +1193,7 @@
The resulting list of complementary packages is associated with an
item that can be added to
:term:`IMAGE_FEATURES`. An example usage of
- this is the "dev-pkgs" item that when added to ``IMAGE_FEATURES``
+ this is the "dev-pkgs" item that when added to :term:`IMAGE_FEATURES`
will install -dev packages (containing headers and other development
files) for every package in the image.
@@ -1215,7 +1215,7 @@
:term:`CONF_VERSION`
Tracks the version of the local configuration file (i.e.
- ``local.conf``). The value for ``CONF_VERSION`` increments each time
+ ``local.conf``). The value for :term:`CONF_VERSION` increments each time
``build/conf/`` compatibility changes.
:term:`CONFFILES`
@@ -1225,28 +1225,28 @@
files you have changed after the original installation and that you
now want to remain unchanged are overwritten. In other words,
editable files might exist in the package that you do not want reset
- as part of the package update process. You can use the ``CONFFILES``
+ as part of the package update process. You can use the :term:`CONFFILES`
variable to list the files in the package that you wish to prevent
the PMS from overwriting during this update process.
- To use the ``CONFFILES`` variable, provide a package name override
+ To use the :term:`CONFFILES` variable, provide a package name override
that identifies the resulting package. Then, provide a
space-separated list of files. Here is an example::
CONFFILES_${PN} += "${sysconfdir}/file1 \
${sysconfdir}/file2 ${sysconfdir}/file3"
- There is a relationship between the ``CONFFILES`` and ``FILES``
- variables. The files listed within ``CONFFILES`` must be a subset of
- the files listed within ``FILES``. Because the configuration files
- you provide with ``CONFFILES`` are simply being identified so that
+ There is a relationship between the :term:`CONFFILES` and :term:`FILES`
+ variables. The files listed within :term:`CONFFILES` must be a subset of
+ the files listed within :term:`FILES`. Because the configuration files
+ you provide with :term:`CONFFILES` are simply being identified so that
the PMS will not overwrite them, it makes sense that the files must
- already be included as part of the package through the ``FILES``
+ already be included as part of the package through the :term:`FILES`
variable.
.. note::
- When specifying paths as part of the ``CONFFILES`` variable, it is
+ When specifying paths as part of the :term:`CONFFILES` variable, it is
good practice to use appropriate path variables.
For example, ``${sysconfdir}`` rather than ``/etc`` or ``${bindir}``
rather than ``/usr/bin``. You can find a list of these variables at
@@ -1259,7 +1259,7 @@
variable as an environment variable. By default, the variable is set
to null ("").
- The ``CONFIG_INITRAMFS_SOURCE`` can be either a single cpio archive
+ The :term:`CONFIG_INITRAMFS_SOURCE` can be either a single cpio archive
with a ``.cpio`` suffix or a space-separated list of directories and
files for building the initramfs image. A cpio archive should contain
a filesystem archive to be used as an initramfs image. Directories
@@ -1287,8 +1287,8 @@
:ref:`features_check <ref-classes-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
- appears in ``DISTRO_FEATURES`` within the current configuration, then
+ :term:`CONFLICT_DISTRO_FEATURES` variable lists a feature that also
+ appears in :term:`DISTRO_FEATURES` within the current configuration, then
the recipe will be skipped, and if the build system attempts to build
the recipe then an error will be triggered.
@@ -1297,16 +1297,16 @@
archived by the :ref:`archiver <ref-classes-archiver>` class. In
other words, if a license in a recipe's
:term:`LICENSE` value is in the value of
- ``COPYLEFT_LICENSE_EXCLUDE``, then its source is not archived by the
+ :term:`COPYLEFT_LICENSE_EXCLUDE`, then its source is not archived by the
class.
.. note::
- The ``COPYLEFT_LICENSE_EXCLUDE`` variable takes precedence over the
+ The :term:`COPYLEFT_LICENSE_EXCLUDE` variable takes precedence over the
:term:`COPYLEFT_LICENSE_INCLUDE` variable.
The default value, which is "CLOSED Proprietary", for
- ``COPYLEFT_LICENSE_EXCLUDE`` is set by the
+ :term:`COPYLEFT_LICENSE_EXCLUDE` is set by the
:ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
is inherited by the ``archiver`` class.
@@ -1314,7 +1314,7 @@
A space-separated list of licenses to include in the source archived
by the :ref:`archiver <ref-classes-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
+ value is in the value of :term:`COPYLEFT_LICENSE_INCLUDE`, then its
source is archived by the class.
The default value is set by the
@@ -1325,28 +1325,28 @@
:term:`COPYLEFT_PN_EXCLUDE`
A list of recipes to exclude in the source archived by the
:ref:`archiver <ref-classes-archiver>` class. The
- ``COPYLEFT_PN_EXCLUDE`` variable overrides the license inclusion and
+ :term:`COPYLEFT_PN_EXCLUDE` variable overrides the license inclusion and
exclusion caused through the
: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
+ any recipes by name, for :term:`COPYLEFT_PN_EXCLUDE` is set by the
:ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
is inherited by the ``archiver`` class.
:term:`COPYLEFT_PN_INCLUDE`
A list of recipes to include in the source archived by the
:ref:`archiver <ref-classes-archiver>` class. The
- ``COPYLEFT_PN_INCLUDE`` variable overrides the license inclusion and
+ :term:`COPYLEFT_PN_INCLUDE` variable overrides the license inclusion and
exclusion caused through the
: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
+ any recipes by name, for :term:`COPYLEFT_PN_INCLUDE` is set by the
:ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
is inherited by the ``archiver`` class.
@@ -1356,7 +1356,7 @@
Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``,
``crosssdk``, and ``cross-canadian``.
- The default value, which is "target*", for ``COPYLEFT_RECIPE_TYPES``
+ The default value, which is "target*", for :term:`COPYLEFT_RECIPE_TYPES`
is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>`
class, which is inherited by the ``archiver`` class.
@@ -1370,7 +1370,7 @@
.. note::
- The ``COPY_LIC_DIRS`` does not offer a path for adding licenses for
+ The :term:`COPY_LIC_DIRS` does not offer a path for adding licenses for
newly installed packages to an image, which might be most suitable for
read-only filesystems that cannot be upgraded. See the
:term:`LICENSE_CREATE_PACKAGE` variable for additional information.
@@ -1386,7 +1386,7 @@
.. note::
- The ``COPY_LIC_MANIFEST`` does not offer a path for adding licenses for
+ The :term:`COPY_LIC_MANIFEST` does not offer a path for adding licenses for
newly installed packages to an image, which might be most suitable for
read-only filesystems that cannot be upgraded. See the
:term:`LICENSE_CREATE_PACKAGE` variable for additional information.
@@ -1406,24 +1406,24 @@
Specifies the parent directory of the OpenEmbedded-Core Metadata
layer (i.e. ``meta``).
- It is an important distinction that ``COREBASE`` points to the parent
+ It is an important distinction that :term:`COREBASE` points to the parent
of this layer and not the layer itself. Consider an example where you
have cloned the Poky Git repository and retained the ``poky`` name
- for your local copy of the repository. In this case, ``COREBASE``
+ for your local copy of the repository. In this case, :term:`COREBASE`
points to the ``poky`` folder because it is the parent directory of
the ``poky/meta`` layer.
:term:`COREBASE_FILES`
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 allows
+ ``bblayers.conf`` file. The :term:`COREBASE_FILES` variable allows
to copy metadata from the OpenEmbedded build system
into the extensible SDK.
- Explicitly listing files in ``COREBASE`` is needed because it
+ Explicitly listing files in :term:`COREBASE` is needed because it
typically contains build directories and other files that should not
normally be copied into the extensible SDK. Consequently, the value
- of ``COREBASE_FILES`` is used in order to only copy the files that
+ of :term:`COREBASE_FILES` is used in order to only copy the files that
are actually needed.
:term:`CPP`
@@ -1435,7 +1435,7 @@
variable and thus made visible to the software being built during the
compilation step.
- Default initialization for ``CPPFLAGS`` varies depending on what is
+ Default initialization for :term:`CPPFLAGS` varies depending on what is
being built:
- :term:`TARGET_CPPFLAGS` when building for
@@ -1449,12 +1449,12 @@
:term:`CROSS_COMPILE`
The toolchain binary prefix for the target tools. The
- ``CROSS_COMPILE`` variable is the same as the
+ :term:`CROSS_COMPILE` variable is the same as the
:term:`TARGET_PREFIX` variable.
.. note::
- The OpenEmbedded build system sets the ``CROSS_COMPILE``
+ The OpenEmbedded build system sets the :term:`CROSS_COMPILE`
variable only in certain contexts (e.g. when building for kernel
and kernel module recipes).
@@ -1470,7 +1470,7 @@
exported to an environment variable and thus made visible to the
software being built during the compilation step.
- Default initialization for ``CXXFLAGS`` varies depending on what is
+ Default initialization for :term:`CXXFLAGS` varies depending on what is
being built:
- :term:`TARGET_CXXFLAGS` when building for
@@ -1505,7 +1505,7 @@
:term:`DEBIAN_NOAUTONAME`
When the :ref:`debian <ref-classes-debian>` class is inherited,
- which is the default behavior, ``DEBIAN_NOAUTONAME`` specifies a
+ which is the default behavior, :term:`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
set this variable. Here is an example from the ``fontconfig`` recipe::
@@ -1514,7 +1514,7 @@
:term:`DEBIANNAME`
When the :ref:`debian <ref-classes-debian>` class is inherited,
- which is the default behavior, ``DEBIANNAME`` allows you to override
+ which is the default behavior, :term:`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
override when you set this variable. Here is an example from the
@@ -1542,14 +1542,14 @@
.. note::
- The bias provided by ``DEFAULT_PREFERENCE`` is weak and is overridden
+ The bias provided by :term:`DEFAULT_PREFERENCE` is weak and is overridden
by :term:`BBFILE_PRIORITY` if that variable is different between two
layers that contain different versions of the same recipe.
:term:`DEFAULTTUNE`
The default CPU and Application Binary Interface (ABI) tunings (i.e.
the "tune") used by the OpenEmbedded build system. The
- ``DEFAULTTUNE`` helps define
+ :term:`DEFAULTTUNE` helps define
:term:`TUNE_FEATURES`.
The default tune is either implicitly or explicitly set by the
@@ -1574,17 +1574,17 @@
:ref:`ref-tasks-configure` task for ``foo`` runs.
This mechanism is implemented by having ``do_configure`` depend on
the :ref:`ref-tasks-populate_sysroot` task of
- each recipe listed in ``DEPENDS``, through a
+ each recipe listed in :term:`DEPENDS`, through a
``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
declaration in the :ref:`base <ref-classes-base>` class.
.. note::
- It seldom is necessary to reference, for example, ``STAGING_DIR_HOST``
+ It seldom is necessary to reference, for example, :term:`STAGING_DIR_HOST`
explicitly. The standard classes and build-related variables are
configured to automatically use the appropriate staging sysroots.
- As another example, ``DEPENDS`` can also be used to add utilities
+ As another example, :term:`DEPENDS` can also be used to add utilities
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::
@@ -1597,15 +1597,15 @@
.. note::
- - ``DEPENDS`` is a list of recipe names. Or, to be more precise,
+ - :term:`DEPENDS` is a list of recipe names. Or, to be more precise,
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"
+ "foo-dev" in :term:`DEPENDS` does not make sense. Use "foo"
instead, as this will put files from all the packages that make
up ``foo``, which includes those from ``foo-dev``, into the
sysroot.
- - One recipe having another recipe in ``DEPENDS`` does not by
+ - One recipe having another recipe in :term:`DEPENDS` does not by
itself add any runtime dependencies between the packages
produced by the two recipes. However, as explained in the
":ref:`overview-manual/concepts:automatically added runtime dependencies`"
@@ -1613,12 +1613,12 @@
runtime dependencies will often be added automatically, meaning
``DEPENDS`` alone is sufficient for most recipes.
- - Counterintuitively, ``DEPENDS`` is often necessary even for
+ - Counterintuitively, :term:`DEPENDS` is often necessary even for
recipes that install precompiled components. For example, if
``libfoo`` is a precompiled library that links against
``libbar``, then linking against ``libfoo`` requires both
``libfoo`` and ``libbar`` to be available in the sysroot.
- Without a ``DEPENDS`` from the recipe that installs ``libfoo``
+ Without a :term:`DEPENDS` from the recipe that installs ``libfoo``
to the recipe that installs ``libbar``, other recipes might
fail to link against ``libfoo``.
@@ -1658,7 +1658,7 @@
DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb"
The :ref:`package_deb <ref-classes-package_deb>` class uses the
- ``DEPLOY_DIR_DEB`` variable to make sure the
+ :term:`DEPLOY_DIR_DEB` variable to make sure the
:ref:`ref-tasks-package_write_deb` task
writes Debian packages into the appropriate folder. For more
information on how packaging works, see the
@@ -1673,6 +1673,13 @@
resides within the :term:`Build Directory` as
``${DEPLOY_DIR}/images/${MACHINE}/``.
+ It must not be used directly in recipes when deploying files. Instead,
+ it's only useful when a recipe needs to "read" a file already deployed
+ by a dependency. So, it should be filled with the contents of
+ :term:`DEPLOYDIR` by the :ref:`deploy <ref-classes-deploy>` class or
+ with the contents of :term:`IMGDEPLOYDIR` by the :ref:`image
+ <ref-classes-image>` class.
+
For more information on the structure of the Build Directory, see
":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section.
For more detail on the contents of the ``deploy`` directory, see the
@@ -1693,7 +1700,7 @@
DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk"
The :ref:`package_ipk <ref-classes-package_ipk>` class uses the
- ``DEPLOY_DIR_IPK`` variable to make sure the
+ :term:`DEPLOY_DIR_IPK` variable to make sure the
:ref:`ref-tasks-package_write_ipk` task
writes IPK packages into the appropriate folder. For more information
on how packaging works, see the
@@ -1713,7 +1720,7 @@
DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm"
The :ref:`package_rpm <ref-classes-package_rpm>` class uses the
- ``DEPLOY_DIR_RPM`` variable to make sure the
+ :term:`DEPLOY_DIR_RPM` variable to make sure the
:ref:`ref-tasks-package_write_rpm` task
writes RPM packages into the appropriate folder. For more information
on how packaging works, see the
@@ -1733,7 +1740,7 @@
DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar"
The :ref:`package_tar <ref-classes-package_tar>` class uses the
- ``DEPLOY_DIR_TAR`` variable to make sure the
+ :term:`DEPLOY_DIR_TAR` variable to make sure the
:ref:`ref-tasks-package_write_tar` task
writes TAR packages into the appropriate folder. For more information
on how packaging works, see the
@@ -1742,19 +1749,19 @@
:term:`DEPLOYDIR`
When inheriting the :ref:`deploy <ref-classes-deploy>` class, the
- ``DEPLOYDIR`` points to a temporary work area for deployed files that
+ :term:`DEPLOYDIR` points to a temporary work area for deployed files that
is set in the ``deploy`` class as follows::
DEPLOYDIR = "${WORKDIR}/deploy-${PN}"
Recipes inheriting the ``deploy`` class should copy files to be
- deployed into ``DEPLOYDIR``, and the class will take care of copying
+ deployed into :term:`DEPLOYDIR`, and the class will take care of copying
them into :term:`DEPLOY_DIR_IMAGE`
afterwards.
:term:`DESCRIPTION`
The package description used by package managers. If not set,
- ``DESCRIPTION`` takes the value of the :term:`SUMMARY`
+ :term:`DESCRIPTION` takes the value of the :term:`SUMMARY`
variable.
:term:`DISTRO`
@@ -1762,26 +1769,26 @@
of the distribution, see the :term:`DISTRO_NAME`
variable.
- The ``DISTRO`` variable corresponds to a distribution configuration
+ The :term:`DISTRO` 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
:term:`Source Directory`.
- Within that ``poky.conf`` file, the ``DISTRO`` variable is set as
+ Within that ``poky.conf`` file, the :term:`DISTRO` variable is set as
follows::
DISTRO = "poky"
Distribution configuration files are located in a ``conf/distro``
directory within the :term:`Metadata` that contains the
- distribution configuration. The value for ``DISTRO`` must not contain
+ distribution configuration. The value for :term:`DISTRO` must not contain
spaces, and is typically all lower-case.
.. note::
- If the ``DISTRO`` variable is blank, a set of default configurations
+ If the :term:`DISTRO` variable is blank, a set of default configurations
are used, which are specified within
``meta/conf/distro/defaultsetup.conf`` also in the Source Directory.
@@ -1808,11 +1815,11 @@
configuration file.
In most cases, the presence or absence of a feature in
- ``DISTRO_FEATURES`` is translated to the appropriate option supplied
+ :term:`DISTRO_FEATURES` is translated to the appropriate option supplied
to the configure script during the
: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
+ :term:`DISTRO_FEATURES`, causes every piece of software built for the
target that can optionally support X11 to have its X11 support
enabled.
@@ -1821,8 +1828,8 @@
provide with this variable, see the ":ref:`ref-features-distro`" section.
:term:`DISTRO_FEATURES_BACKFILL`
- Features to be added to ``DISTRO_FEATURES`` if not also present in
- ``DISTRO_FEATURES_BACKFILL_CONSIDERED``.
+ Features to be added to :term:`DISTRO_FEATURES` if not also present in
+ :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`.
This variable is set in the ``meta/conf/bitbake.conf`` file. It is
not intended to be user-configurable. It is best to just reference
@@ -1831,8 +1838,8 @@
for more information.
:term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
- Features from ``DISTRO_FEATURES_BACKFILL`` that should not be
- backfilled (i.e. added to ``DISTRO_FEATURES``) during the build. See
+ Features from :term:`DISTRO_FEATURES_BACKFILL` that should not be
+ backfilled (i.e. added to :term:`DISTRO_FEATURES`) during the build. See
the ":ref:`ref-features-backfill`" section for more information.
:term:`DISTRO_FEATURES_DEFAULT`
@@ -1844,14 +1851,14 @@
able to reuse the default
: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::
+ :term:`DISTRO_FEATURES_DEFAULT` from a custom distro configuration file::
DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} myfeature"
:term:`DISTRO_FEATURES_FILTER_NATIVE`
Specifies a list of features that if present in the target
:term:`DISTRO_FEATURES` value should be
- included in ``DISTRO_FEATURES`` when building native recipes. This
+ included in :term:`DISTRO_FEATURES` when building native recipes. This
variable is used in addition to the features filtered using the
:term:`DISTRO_FEATURES_NATIVE`
variable.
@@ -1859,7 +1866,7 @@
:term:`DISTRO_FEATURES_FILTER_NATIVESDK`
Specifies a list of features that if present in the target
:term:`DISTRO_FEATURES` value should be
- included in ``DISTRO_FEATURES`` when building nativesdk recipes. This
+ included in :term:`DISTRO_FEATURES` when building nativesdk recipes. This
variable is used in addition to the features filtered using the
:term:`DISTRO_FEATURES_NATIVESDK`
variable.
@@ -1884,14 +1891,14 @@
The long name of the distribution. For information on the short name
of the distribution, see the :term:`DISTRO` variable.
- The ``DISTRO_NAME`` variable corresponds to a distribution
+ The :term:`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 :term:`Source Directory`.
- Within that ``poky.conf`` file, the ``DISTRO_NAME`` variable is set
+ Within that ``poky.conf`` file, the :term:`DISTRO_NAME` variable is set
as follows::
DISTRO_NAME = "Poky (Yocto Project Reference Distro)"
@@ -1902,7 +1909,7 @@
.. note::
- If the ``DISTRO_NAME`` variable is blank, a set of default
+ If the :term:`DISTRO_NAME` variable is blank, a set of default
configurations are used, which are specified within
``meta/conf/distro/defaultsetup.conf`` also in the Source Directory.
@@ -1914,10 +1921,10 @@
distribution. By default, this list includes the value of
:term:`DISTRO`.
- You can extend ``DISTROOVERRIDES`` to add extra overrides that should
+ You can extend :term:`DISTROOVERRIDES` to add extra overrides that should
apply to the distribution.
- The underlying mechanism behind ``DISTROOVERRIDES`` is simply that it
+ The underlying mechanism behind :term:`DISTROOVERRIDES` is simply that it
is included in the default value of
:term:`OVERRIDES`.
@@ -1936,13 +1943,13 @@
:term:`DL_DIR`
The central download directory used by the build process to store
- downloads. By default, ``DL_DIR`` gets files suitable for mirroring
+ downloads. By default, :term:`DL_DIR` gets files suitable for mirroring
for everything except Git repositories. If you want tarballs of Git
repositories, use the
:term:`BB_GENERATE_MIRROR_TARBALLS`
variable.
- You can set this directory by defining the ``DL_DIR`` variable in the
+ You can set this directory by defining the :term:`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 :term:`Build Directory`.
@@ -1956,7 +1963,7 @@
During a first build, the system downloads many different source code
tarballs from various upstream projects. Downloading can take a
while, particularly if your network connection is slow. Tarballs are
- all stored in the directory defined by ``DL_DIR`` and the build
+ all stored in the directory defined by :term:`DL_DIR` and the build
system looks there first to find source tarballs.
.. note::
@@ -1985,7 +1992,7 @@
:term:`EFI_PROVIDER`
When building bootable images (i.e. where ``hddimg``, ``iso``, or
``wic.vmdk`` is in :term:`IMAGE_FSTYPES`), the
- ``EFI_PROVIDER`` variable specifies the EFI bootloader to use. The
+ :term:`EFI_PROVIDER` variable specifies the EFI bootloader to use. The
default is "grub-efi", but "systemd-boot" can be used instead.
See the :ref:`systemd-boot <ref-classes-systemd-boot>` and
@@ -2006,7 +2013,7 @@
database. By default, the value of this variable is
``${``\ :term:`LOG_DIR`\ ``}/error-report``.
- You can set ``ERR_REPORT_DIR`` to the path you want the error
+ You can set :term:`ERR_REPORT_DIR` to the path you want the error
reporting tool to store the debug files as follows in your
``local.conf`` file::
@@ -2031,11 +2038,11 @@
libraries resolver might implicitly define some dependencies between
packages.
- The ``EXCLUDE_FROM_SHLIBS`` variable is similar to the
+ The :term:`EXCLUDE_FROM_SHLIBS` variable is similar to the
: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
+ Use the :term:`EXCLUDE_FROM_SHLIBS` variable by setting it to "1" for a
particular package::
EXCLUDE_FROM_SHLIBS = "1"
@@ -2051,18 +2058,18 @@
.. note::
- Recipes added to ``EXCLUDE_FROM_WORLD`` may still be built during a
+ Recipes added to :term:`EXCLUDE_FROM_WORLD` may still be built during a
world build in order to satisfy dependencies of other recipes. Adding
- a recipe to ``EXCLUDE_FROM_WORLD`` only ensures that the recipe is not
+ a recipe to :term:`EXCLUDE_FROM_WORLD` only ensures that the recipe is not
explicitly added to the list of build targets in a world build.
:term:`EXTENDPE`
Used with file and pathnames to create a prefix for a recipe's
- 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 "".
+ version based on the recipe's :term:`PE` value. If :term:`PE`
+ is set and greater than zero for a recipe, :term:`EXTENDPE` becomes that
+ value (e.g if :term:`PE` is equal to "1" then :term:`EXTENDPE` becomes "1").
+ If a recipe's :term:`PE` is not set (the default) or is equal to zero,
+ :term:`EXTENDPE` becomes "".
See the :term:`STAMP` variable for an example.
@@ -2078,11 +2085,11 @@
manager to upgrade these types of packages in lock-step.
:term:`EXTERNAL_KERNEL_TOOLS`
- When set, the ``EXTERNAL_KERNEL_TOOLS`` variable indicates that these
+ When set, the :term:`EXTERNAL_KERNEL_TOOLS` variable indicates that these
tools are not in the source tree.
When kernel tools are available in the tree, they are preferred over
- any externally installed tools. Setting the ``EXTERNAL_KERNEL_TOOLS``
+ any externally installed tools. Setting the :term:`EXTERNAL_KERNEL_TOOLS`
variable tells the OpenEmbedded build system to prefer the installed
external tools. See the
:ref:`kernel-yocto <ref-classes-kernel-yocto>` class in
@@ -2117,7 +2124,7 @@
:term:`EXTRA_AUTORECONF`
For recipes inheriting the :ref:`autotools <ref-classes-autotools>`
- class, you can use ``EXTRA_AUTORECONF`` to specify extra options to
+ class, you can use :term:`EXTRA_AUTORECONF` to specify extra options to
pass to the ``autoreconf`` command that is executed during the
:ref:`ref-tasks-configure` task.
@@ -2179,7 +2186,7 @@
installing into the root filesystem.
Sometimes a recipe is required to build the final image but is not
- needed in the root filesystem. You can use the ``EXTRA_IMAGEDEPENDS``
+ needed in the root filesystem. You can use the :term:`EXTRA_IMAGEDEPENDS`
variable to list these recipes and thus specify the dependencies. A
typical example is a required bootloader in a machine configuration.
@@ -2210,12 +2217,12 @@
:term:`EXTRA_OEMAKE`
Additional GNU ``make`` options.
- Because the ``EXTRA_OEMAKE`` defaults to "", you need to set the
+ Because the :term:`EXTRA_OEMAKE` defaults to "", you need to set the
variable to specify any required GNU options.
:term:`PARALLEL_MAKE` and
:term:`PARALLEL_MAKEINST` also make use of
- ``EXTRA_OEMAKE`` to pass the required flags.
+ :term:`EXTRA_OEMAKE` to pass the required flags.
:term:`EXTRA_OESCONS`
When inheriting the :ref:`scons <ref-classes-scons>` class, this
@@ -2231,7 +2238,7 @@
group configurations to a specific recipe.
The set list of commands you can configure using the
- ``EXTRA_USERS_PARAMS`` is shown in the ``extrausers`` class. These
+ :term:`EXTRA_USERS_PARAMS` is shown in the ``extrausers`` class. These
commands map to the normal Unix commands of the same names::
# EXTRA_USERS_PARAMS = "\
@@ -2257,19 +2264,19 @@
:term:`FEATURE_PACKAGES`
Defines one or more packages to include in an image when a specific
item is included in :term:`IMAGE_FEATURES`.
- When setting the value, ``FEATURE_PACKAGES`` should have the name of
+ When setting the value, :term:`FEATURE_PACKAGES` should have the name of
the feature item as an override. Here is an example::
FEATURE_PACKAGES_widget = "package1 package2"
- In this example, if "widget" were added to ``IMAGE_FEATURES``,
+ In this example, if "widget" were added to :term:`IMAGE_FEATURES`,
package1 and package2 would be included in the image.
.. note::
- Packages installed by features defined through ``FEATURE_PACKAGES``
+ Packages installed by features defined through :term:`FEATURE_PACKAGES`
are often package groups. While similarly named, you should not
- confuse the ``FEATURE_PACKAGES`` variable with package groups, which
+ confuse the :term:`FEATURE_PACKAGES` variable with package groups, which
are discussed elsewhere in the documentation.
:term:`FEED_DEPLOYDIR_BASE_URI`
@@ -2294,7 +2301,7 @@
:term:`PACKAGES` variable lists the packages
generated by a recipe.
- To use the ``FILES`` variable, provide a package name override that
+ To use the :term:`FILES` variable, provide a package name override that
identifies the resulting package. Then, provide a space-separated
list of files or paths that identify the files you want included as
part of the resulting package. Here is an example::
@@ -2309,7 +2316,7 @@
syntax. For details on the syntax, see the documentation by
following the previous link.
- - When specifying paths as part of the ``FILES`` variable, it is
+ - When specifying paths as part of the :term:`FILES` variable, it is
good practice to use appropriate path variables. For example,
use ``${sysconfdir}`` rather than ``/etc``, or ``${bindir}``
rather than ``/usr/bin``. You can find a list of these
@@ -2318,7 +2325,7 @@
find the default values of the various ``FILES_*`` variables in
this file.
- If some of the files you provide with the ``FILES`` variable are
+ If some of the files you provide with the :term:`FILES` variable are
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
@@ -2328,7 +2335,7 @@
:term:`FILES_SOLIBSDEV`
Defines the file specification to match
:term:`SOLIBSDEV`. In other words,
- ``FILES_SOLIBSDEV`` defines the full path name of the development
+ :term:`FILES_SOLIBSDEV` defines the full path name of the development
symbolic link (symlink) for shared libraries on the target platform.
The following statement from the ``bitbake.conf`` shows how it is
@@ -2341,11 +2348,11 @@
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 :term:`FILESPATH`
- variable. You can extend ``FILESPATH`` variable by using
- ``FILESEXTRAPATHS``.
+ variable. You can extend :term:`FILESPATH` variable by using
+ :term:`FILESEXTRAPATHS`.
Best practices dictate that you accomplish this by using
- ``FILESEXTRAPATHS`` from within a ``.bbappend`` file and that you
+ :term:`FILESEXTRAPATHS` from within a ``.bbappend`` file and that you
prepend paths as follows::
FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
@@ -2356,7 +2363,7 @@
.. note::
- When extending ``FILESEXTRAPATHS``, be sure to use the immediate
+ When extending :term:`FILESEXTRAPATHS`, be sure to use the immediate
expansion (``:=``) operator. Immediate expansion makes sure that
BitBake evaluates :term:`THISDIR` at the time the
directive is encountered rather than at some later time when
@@ -2373,7 +2380,7 @@
FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
In this example, the build system extends the
- ``FILESPATH`` variable to include a directory named ``files`` that is
+ :term:`FILESPATH` variable to include a directory named ``files`` that is
in the same directory as the corresponding append file.
This next example specifically adds three paths::
@@ -2396,7 +2403,7 @@
.. note::
For a layer that supports a single BSP, the override could just be
- the value of ``MACHINE``.
+ the value of :term:`MACHINE`.
By prepending paths in ``.bbappend`` files, you allow multiple append
files that reside in different layers but are used for the same
@@ -2405,7 +2412,7 @@
:term:`FILESOVERRIDES`
A subset of :term:`OVERRIDES` used by the
OpenEmbedded build system for creating
- :term:`FILESPATH`. The ``FILESOVERRIDES`` variable
+ :term:`FILESPATH`. The :term:`FILESOVERRIDES` variable
uses overrides to automatically extend the
:term:`FILESPATH` variable. For an example of how
that works, see the :term:`FILESPATH` variable
@@ -2414,13 +2421,13 @@
":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
section of the BitBake User Manual.
- By default, the ``FILESOVERRIDES`` variable is defined as::
+ By default, the :term:`FILESOVERRIDES` variable is defined as::
FILESOVERRIDES = "${TRANSLATED_TARGET_ARCH}:${MACHINEOVERRIDES}:${DISTROOVERRIDES}"
.. note::
- Do not hand-edit the ``FILESOVERRIDES`` variable. The values match up
+ Do not hand-edit the :term:`FILESOVERRIDES` variable. The values match up
with expected overrides and are used in an expected manner by the
build system.
@@ -2429,11 +2436,11 @@
when searching for patches and files.
During the build process, BitBake searches each directory in
- ``FILESPATH`` in the specified order when looking for files and
+ :term:`FILESPATH` in the specified order when looking for files and
patches specified by each ``file://`` URI in a recipe's
:term:`SRC_URI` statements.
- The default value for the ``FILESPATH`` variable is defined in the
+ The default value for the :term:`FILESPATH` variable is defined in the
``base.bbclass`` class found in ``meta/classes`` in the
:term:`Source Directory`::
@@ -2441,22 +2448,22 @@
"${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
The
- ``FILESPATH`` variable is automatically extended using the overrides
+ :term:`FILESPATH` variable is automatically extended using the overrides
from the :term:`FILESOVERRIDES` variable.
.. note::
- - Do not hand-edit the ``FILESPATH`` variable. If you want the
+ - Do not hand-edit the :term:`FILESPATH` variable. If you want the
build system to look in directories other than the defaults,
- extend the ``FILESPATH`` variable by using the
+ extend the :term:`FILESPATH` variable by using the
:term:`FILESEXTRAPATHS` variable.
- - Be aware that the default ``FILESPATH`` directories do not map
+ - Be aware that the default :term:`FILESPATH` directories do not map
to directories in custom layers where append files
(``.bbappend``) are used. If you want the build system to find
patches or files that reside with your append files, you need
- to extend the ``FILESPATH`` variable by using the
- ``FILESEXTRAPATHS`` variable.
+ to extend the :term:`FILESPATH` variable by using the
+ :term:`FILESEXTRAPATHS` variable.
You can take advantage of this searching behavior in useful ways. For
example, consider a case where there is the following directory structure
@@ -2466,10 +2473,10 @@
files/MACHINEA/defconfig
files/MACHINEB/defconfig
- Also in the example, the ``SRC_URI`` statement contains
+ Also in the example, the :term:`SRC_URI` statement contains
"file://defconfig". Given this scenario, you can set
:term:`MACHINE` to "MACHINEA" and cause the build
- system to use files from ``files/MACHINEA``. Set ``MACHINE`` to
+ system to use files from ``files/MACHINEA``. Set :term:`MACHINE` to
"MACHINEB" and the build system uses files from ``files/MACHINEB``.
Finally, for any machine other than "MACHINEA" and "MACHINEB", the
build system uses files from ``files/defconfig``.
@@ -2494,7 +2501,7 @@
permissions setting table, you should place it in your layer or the
distro's layer.
- You define the ``FILESYSTEM_PERMS_TABLES`` variable in the
+ You define the :term:`FILESYSTEM_PERMS_TABLES` variable in the
``conf/local.conf`` file, which is found in the :term:`Build Directory`,
to point to your custom
``fs-perms.txt``. You can specify more than a single file permissions
@@ -2513,7 +2520,7 @@
:term:`FIT_GENERATE_KEYS`
Decides whether to generate the keys for signing fitImage if they
- don't already exist. The keys are created in ``UBOOT_SIGN_KEYDIR``.
+ don't already exist. The keys are created in :term:`UBOOT_SIGN_KEYDIR`.
The default value is 0.
:term:`FIT_HASH_ALG`
@@ -2594,7 +2601,7 @@
:term:`GCCVERSION`
Specifies the default version of the GNU C Compiler (GCC) used for
- compilation. By default, ``GCCVERSION`` is set to "8.x" in the
+ compilation. By default, :term:`GCCVERSION` is set to "8.x" in the
``meta/conf/distro/include/tcmode-default.inc`` include file::
GCCVERSION ?= "8.%"
@@ -2618,7 +2625,7 @@
If you specifically remove the locale ``en_US.UTF-8``, you must set
:term:`IMAGE_LINGUAS` appropriately.
- You can set ``GLIBC_GENERATE_LOCALES`` in your ``local.conf`` file.
+ You can set :term:`GLIBC_GENERATE_LOCALES` in your ``local.conf`` file.
By default, all locales are generated.
::
@@ -2660,7 +2667,7 @@
configuration. Use a semi-colon character (``;``) to separate
multiple options.
- The ``GRUB_OPTS`` variable is optional. See the
+ The :term:`GRUB_OPTS` variable is optional. See the
:ref:`grub-efi <ref-classes-grub-efi>` class for more information
on how this variable is used.
@@ -2668,7 +2675,7 @@
Specifies the timeout before executing the default ``LABEL`` in the
GNU GRand Unified Bootloader (GRUB).
- The ``GRUB_TIMEOUT`` variable is optional. See the
+ The :term:`GRUB_TIMEOUT` variable is optional. See the
:ref:`grub-efi <ref-classes-grub-efi>` class for more information
on how this variable is used.
@@ -2702,7 +2709,7 @@
Specifies architecture-specific compiler flags that are passed to the
C compiler.
- Default initialization for ``HOST_CC_ARCH`` varies depending on what
+ Default initialization for :term:`HOST_CC_ARCH` varies depending on what
is being built:
- :term:`TARGET_CC_ARCH` when building for the
@@ -2722,7 +2729,7 @@
"linux-musleabi" values possible.
:term:`HOST_PREFIX`
- Specifies the prefix for the cross-compile toolchain. ``HOST_PREFIX``
+ Specifies the prefix for the cross-compile toolchain. :term:`HOST_PREFIX`
is normally the same as :term:`TARGET_PREFIX`.
:term:`HOST_SYS`
@@ -2751,7 +2758,7 @@
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. If a tool
- specified in the value of ``HOSTTOOLS`` is not found on the build
+ specified in the value of :term:`HOSTTOOLS` is not found on the build
host, the OpenEmbedded build system produces an error and the build
is not started.
@@ -2764,11 +2771,11 @@
filter helps reduce the possibility of host contamination. Unlike
: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.
+ :term:`HOSTTOOLS_NONFATAL` is not found on the build host. Thus, you can
+ use :term:`HOSTTOOLS_NONFATAL` to filter optional host tools.
:term:`HOST_VENDOR`
- Specifies the name of the vendor. ``HOST_VENDOR`` is normally the
+ Specifies the name of the vendor. :term:`HOST_VENDOR` is normally the
same as :term:`TARGET_VENDOR`.
:term:`ICECC_DISABLED`
@@ -2813,12 +2820,12 @@
network lag, available memory, and existing machine loads can all
affect build time. Consequently, unlike the
:term:`PARALLEL_MAKE` variable, there is no
- rule-of-thumb for setting ``ICECC_PARALLEL_MAKE`` to achieve optimal
+ rule-of-thumb for setting :term:`ICECC_PARALLEL_MAKE` to achieve optimal
performance.
- If you do not set ``ICECC_PARALLEL_MAKE``, the build system does not
+ If you do not set :term:`ICECC_PARALLEL_MAKE`, the build system does not
use it (i.e. the system does not detect and assign the number of
- cores as is done with ``PARALLEL_MAKE``).
+ cores as is done with :term:`PARALLEL_MAKE`).
:term:`ICECC_PATH`
The location of the ``icecc`` binary. You can set this variable in
@@ -2931,7 +2938,7 @@
this variable to specify the list of classes that register the
different types of images the OpenEmbedded build system creates.
- The default value for ``IMAGE_CLASSES`` is ``image_types``. You can
+ The default value for :term:`IMAGE_CLASSES` is ``image_types``. You can
set this variable in your ``local.conf`` or in a distribution
configuration file.
@@ -2945,8 +2952,8 @@
``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 --output=${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.jffs2 \
+ IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} --faketime \
+ --output=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.jffs2 \
${EXTRA_IMAGECMD}"
You typically do not need to set this variable unless you are adding
@@ -2958,7 +2965,7 @@
Specifies one or more files that contain custom device tables that
are passed to the ``makedevs`` command as part of creating an image.
These files list basic device nodes that should be created under
- ``/dev`` within the image. If ``IMAGE_DEVICE_TABLES`` is not set,
+ ``/dev`` within the image. If :term:`IMAGE_DEVICE_TABLES` is not set,
``files/device_table-minimal.txt`` is used, which is located by
:term:`BBPATH`. For details on how you should write
device table files, see ``meta/files/device_table-minimal.txt`` as an
@@ -2986,7 +2993,7 @@
:term:`IMAGE_FSTYPES`
Specifies the formats the OpenEmbedded build system uses during the
build when creating the root filesystem. For example, setting
- ``IMAGE_FSTYPES`` as follows causes the build system to create root
+ :term:`IMAGE_FSTYPES` as follows causes the build system to create root
filesystems using two formats: ``.ext3`` and ``.tar.bz2``::
IMAGE_FSTYPES = "ext3 tar.bz2"
@@ -2997,25 +3004,25 @@
.. note::
- If an image recipe uses the "inherit image" line and you are
- setting ``IMAGE_FSTYPES`` inside the recipe, you must set
+ setting :term:`IMAGE_FSTYPES` inside the recipe, you must set
``IMAGE_FSTYPES`` prior to using the "inherit image" line.
- Due to the way the OpenEmbedded build system processes this
variable, you cannot update its contents by using ``_append``
or ``_prepend``. You must use the ``+=`` operator to add one or
- more options to the ``IMAGE_FSTYPES`` variable.
+ more options to the :term:`IMAGE_FSTYPES` variable.
:term:`IMAGE_INSTALL`
Used by recipes to specify the packages to install into an image
through the :ref:`image <ref-classes-image>` class. Use the
- ``IMAGE_INSTALL`` variable with care to avoid ordering issues.
+ :term:`IMAGE_INSTALL` variable with care to avoid ordering issues.
- Image recipes set ``IMAGE_INSTALL`` to specify the packages to
+ Image recipes set :term:`IMAGE_INSTALL` to specify the packages to
install into an image through ``image.bbclass``. Additionally,
there are "helper" classes such as the
:ref:`core-image <ref-classes-core-image>` class which can
- take lists used with ``IMAGE_FEATURES`` and turn them into
- auto-generated entries in ``IMAGE_INSTALL`` in addition to its
+ take lists used with :term:`IMAGE_FEATURES` and turn them into
+ auto-generated entries in :term:`IMAGE_INSTALL` in addition to its
default contents.
When you use this variable, it is best to use it as follows::
@@ -3030,24 +3037,24 @@
- When working with a
:ref:`core-image-minimal-initramfs <ref-manual/images:images>`
- image, do not use the ``IMAGE_INSTALL`` variable to specify
+ image, do not use the :term:`IMAGE_INSTALL` variable to specify
packages for installation. Instead, use the
: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``.
+ fixed set of packages and not be affected by :term:`IMAGE_INSTALL`.
For information on creating an initramfs, see the
":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`"
section in the Yocto Project Development Tasks Manual.
- - Using ``IMAGE_INSTALL`` with the
+ - Using :term:`IMAGE_INSTALL` with the
:ref:`+= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:appending (+=) and prepending (=+) with spaces>`
BitBake operator within the ``/conf/local.conf`` file or from
within an image recipe is not recommended. Use of this operator
in these ways can cause ordering issues. Since
- ``core-image.bbclass`` sets ``IMAGE_INSTALL`` to a default
+ ``core-image.bbclass`` sets :term:`IMAGE_INSTALL` to a default
value using the
:ref:`?= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:setting a default value (?=)>`
- operator, using a ``+=`` operation against ``IMAGE_INSTALL``
+ operator, using a ``+=`` operation against :term:`IMAGE_INSTALL`
results in unexpected behavior when used within
``conf/local.conf``. Furthermore, the same operation from
within an image recipe may or may not succeed depending on the
@@ -3058,7 +3065,7 @@
Specifies the list of locales to install into the image during the
root filesystem construction process. The OpenEmbedded build system
automatically splits locale files, which are used for localization,
- into separate packages. Setting the ``IMAGE_LINGUAS`` variable
+ into separate packages. Setting the :term:`IMAGE_LINGUAS` variable
ensures that any locale packages that correspond to packages already
selected for installation into the image are also installed. Here is
an example::
@@ -3092,13 +3099,13 @@
packagename packagearch version
- The :ref:`image <ref-classes-image>` class defines the manifest
+ The :ref:`rootfs-postcommands <ref-classes-rootfs*>` class defines the manifest
file as follows::
- IMAGE_MANIFEST ="${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest"
+ IMAGE_MANIFEST ="${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.manifest"
The location is
- derived using the :term:`DEPLOY_DIR_IMAGE`
+ derived using the :term:`IMGDEPLOYDIR`
and :term:`IMAGE_NAME` variables. You can find
information on how the image is created in the ":ref:`overview-manual/concepts:image generation`"
section in the Yocto Project Overview and Concepts Manual.
@@ -3122,7 +3129,7 @@
Defines a multiplier that the build system applies to the initial
image size for cases when the multiplier times the returned disk
usage value for the image is greater than the sum of
- ``IMAGE_ROOTFS_SIZE`` and ``IMAGE_ROOTFS_EXTRA_SPACE``. The result of
+ :term:`IMAGE_ROOTFS_SIZE` and :term:`IMAGE_ROOTFS_EXTRA_SPACE`. The result of
the multiplier applied to the initial image size creates free disk
space in the image as overhead. By default, the build process uses a
multiplier of 1.3 for this variable. This default value results in
@@ -3131,7 +3138,7 @@
post install scripts and the package management system uses disk
space inside this overhead area. Consequently, the multiplier does
not produce an image with all the theoretical free disk space. See
- ``IMAGE_ROOTFS_SIZE`` for information on how the build system
+ :term:`IMAGE_ROOTFS_SIZE` for information on how the build system
determines the overall image size.
The default 30% free disk space typically gives the image enough room
@@ -3143,7 +3150,7 @@
IMAGE_OVERHEAD_FACTOR = "1.5"
Alternatively, you can ensure a specific amount of free disk space is
- added to the image by using the ``IMAGE_ROOTFS_EXTRA_SPACE``
+ added to the image by using the :term:`IMAGE_ROOTFS_EXTRA_SPACE`
variable.
:term:`IMAGE_PKGTYPE`
@@ -3160,10 +3167,10 @@
recommended that you do not use it.
The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` and
- :ref:`image <ref-classes-image>` classes use the ``IMAGE_PKGTYPE``
+ :ref:`image <ref-classes-image>` classes use the :term:`IMAGE_PKGTYPE`
for packaging up images and SDKs.
- You should not set the ``IMAGE_PKGTYPE`` manually. Rather, the
+ You should not set the :term:`IMAGE_PKGTYPE` manually. Rather, the
variable is set indirectly through the appropriate
:ref:`package_* <ref-classes-package>` class using the
:term:`PACKAGE_CLASSES` variable. The
@@ -3218,7 +3225,7 @@
Defines additional free disk space created in the image in Kbytes. By
default, this variable is set to "0". This free disk space is added
to the image after the build system determines the image size as
- described in ``IMAGE_ROOTFS_SIZE``.
+ described in :term:`IMAGE_ROOTFS_SIZE`.
This variable is particularly useful when you want to ensure that a
specific amount of free disk space is available on a device after an
@@ -3279,6 +3286,9 @@
- cpio.lzma
- cpio.xz
- cramfs
+ - erofs
+ - erofs-lz4
+ - erofs-lz4hc
- ext2
- ext2.bz2
- ext2.gz
@@ -3321,6 +3331,18 @@
desired, and this suffix would then be used consistently across
the build artifacts.
+ :term:`IMGDEPLOYDIR`
+ When inheriting the :ref:`image <ref-classes-image>` class directly or
+ through the :ref:`core-image <ref-classes-core-image>` class, the
+ ``IMGDEPLOYDIR`` points to a temporary work area for deployed files
+ that is set in the ``image`` class as follows::
+
+ IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete"
+
+ Recipes inheriting the ``image`` class should copy files to be
+ deployed into ``IMGDEPLOYDIR``, and the class will take care of
+ copying them into :term:`DEPLOY_DIR_IMAGE` afterwards.
+
:term:`INC_PR`
Helps define the recipe revision for recipes that share a common
``include`` file. You can think of this variable as part of the
@@ -3336,16 +3358,16 @@
common functionality are upgraded to a new revision.
A more efficient way of dealing with this situation is to set the
- ``INC_PR`` variable inside the ``include`` files that the recipes
- share and then expand the ``INC_PR`` variable within the recipes to
+ :term:`INC_PR` variable inside the ``include`` files that the recipes
+ share and then expand the :term:`INC_PR` variable within the recipes to
help define the recipe revision.
The following provides an example that shows how to use the
- ``INC_PR`` variable given a common ``include`` file that defines the
+ :term:`INC_PR` variable given a common ``include`` file that defines the
variable. Once the variable is defined in the ``include`` file, you
- can use the variable to set the ``PR`` values in each recipe. You
- will notice that when you set a recipe's ``PR`` you can provide more
- granular revisioning by appending values to the ``INC_PR`` variable::
+ can use the variable to set the :term:`PR` values in each recipe. You
+ will notice that when you set a recipe's :term:`PR` you can provide more
+ granular revisioning by appending values to the :term:`INC_PR` variable::
recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
recipes-graphics/xorg-font/encodings_1.0.4.bb:PR = "${INC_PR}.1"
@@ -3356,7 +3378,7 @@
first line of the example establishes the baseline revision to be
used for all recipes that use the ``include`` file. The remaining
lines in the example are from individual recipes and show how the
- ``PR`` value is set.
+ :term:`PR` value is set.
:term:`INCOMPATIBLE_LICENSE`
Specifies a space-separated list of license names (as they would
@@ -3382,12 +3404,12 @@
It is possible to define a list of licenses that are allowed to be
used instead of the licenses that are excluded. To do this, define
a variable ``COMPATIBLE_LICENSES`` with the names of the licenses
- that are allowed. Then define ``INCOMPATIBLE_LICENSE`` as::
+ that are allowed. Then define :term:`INCOMPATIBLE_LICENSE` as::
INCOMPATIBLE_LICENSE = "${@' '.join(sorted(set(d.getVar('AVAILABLE_LICENSES').split()) - set(d.getVar('COMPATIBLE_LICENSES').split())))}"
- This will result in ``INCOMPATIBLE_LICENSE`` containing the names of
+ This will result in :term:`INCOMPATIBLE_LICENSE` containing the names of
all licenses from :term:`AVAILABLE_LICENSES` except the ones specified
in ``COMPATIBLE_LICENSES``, thus only allowing the latter licenses to
be used.
@@ -3396,9 +3418,9 @@
Causes the named class or classes to be inherited globally. Anonymous
functions in the class or classes are not executed for the base
configuration and in each individual recipe. The OpenEmbedded build
- system ignores changes to ``INHERIT`` in individual recipes.
+ system ignores changes to :term:`INHERIT` in individual recipes.
- For more information on ``INHERIT``, see the
+ For more information on :term:`INHERIT`, see the
:ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`"
section in the Bitbake User Manual.
@@ -3430,7 +3452,7 @@
variable.
To prevent the build system from splitting out debug information
- during packaging, set the ``INHIBIT_PACKAGE_DEBUG_SPLIT`` variable as
+ during packaging, set the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable as
follows::
INHIBIT_PACKAGE_DEBUG_SPLIT = "1"
@@ -3442,7 +3464,7 @@
By default, the OpenEmbedded build system strips binaries and puts
the debugging symbols into ``${``\ :term:`PN`\ ``}-dbg``.
- Consequently, you should not set ``INHIBIT_PACKAGE_STRIP`` when you
+ Consequently, you should not set :term:`INHIBIT_PACKAGE_STRIP` when you
plan to debug in general.
:term:`INHIBIT_SYSROOT_STRIP`
@@ -3451,7 +3473,7 @@
By default, the OpenEmbedded build system strips binaries in the
resulting sysroot. When you specifically set the
- ``INHIBIT_SYSROOT_STRIP`` variable to "1" in your recipe, you inhibit
+ :term:`INHIBIT_SYSROOT_STRIP` variable to "1" in your recipe, you inhibit
this stripping.
If you want to use this variable, include the
@@ -3461,7 +3483,7 @@
.. note::
- Use of the ``INHIBIT_SYSROOT_STRIP`` variable occurs in rare and
+ Use of the :term:`INHIBIT_SYSROOT_STRIP` variable occurs in rare and
special circumstances. For example, suppose you are building
bare-metal firmware by using an external GCC toolchain. Furthermore,
even if the toolchain's binaries are strippable, there are other files
@@ -3483,7 +3505,7 @@
:term:`INITRAMFS_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
+ image. In other words, the :term:`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
@@ -3499,16 +3521,16 @@
See the ``meta/recipes-core/images/core-image-minimal-initramfs.bb``
recipe in the :term:`Source Directory`
for an example initramfs recipe. To select this sample recipe as
- the one built to provide the initramfs image, set ``INITRAMFS_IMAGE``
+ the one built to provide the initramfs image, set :term:`INITRAMFS_IMAGE`
to "core-image-minimal-initramfs".
You can also find more information by referencing the
``meta-poky/conf/local.conf.sample.extended`` configuration file in
the Source Directory, the :ref:`image <ref-classes-image>` class,
and the :ref:`kernel <ref-classes-kernel>` class to see how to use
- the ``INITRAMFS_IMAGE`` variable.
+ the :term:`INITRAMFS_IMAGE` variable.
- If ``INITRAMFS_IMAGE`` is empty, which is the default, then no
+ If :term:`INITRAMFS_IMAGE` is empty, which is the default, then no
initramfs image is built.
For more information, you can also see the
@@ -3543,7 +3565,7 @@
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 specified in :term:`INITRAMFS_IMAGE` bundled within::
INITRAMFS_IMAGE_BUNDLE = "1"
@@ -3555,7 +3577,7 @@
.. note::
- You must set the ``INITRAMFS_IMAGE_BUNDLE`` variable in a
+ You must set the :term:`INITRAMFS_IMAGE_BUNDLE` variable in a
configuration file. You cannot set the variable in a recipe file.
See the
@@ -3596,13 +3618,13 @@
Indicates list of filesystem images to concatenate and use as an
initial RAM disk (``initrd``).
- The ``INITRD`` variable is an optional variable used with the
+ The :term:`INITRD` variable is an optional variable used with the
:ref:`image-live <ref-classes-image-live>` class.
:term:`INITRD_IMAGE`
When building a "live" bootable image (i.e. when
:term:`IMAGE_FSTYPES` contains "live"),
- ``INITRD_IMAGE`` specifies the image recipe that should be built to
+ :term:`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".
@@ -3636,7 +3658,7 @@
The variable's default value is "defaults", which is set in the
:ref:`update-rc.d <ref-classes-update-rc.d>` class.
- The value in ``INITSCRIPT_PARAMS`` is passed through to the
+ The value in :term:`INITSCRIPT_PARAMS` is passed through to the
``update-rc.d`` command. For more information on valid parameters,
please see the ``update-rc.d`` manual page at
https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html
@@ -3655,7 +3677,7 @@
:term:`INSTALL_TIMEZONE_FILE`
By default, the ``tzdata`` recipe packages an ``/etc/timezone`` file.
- Set the ``INSTALL_TIMEZONE_FILE`` variable to "0" at the
+ Set the :term:`INSTALL_TIMEZONE_FILE` variable to "0" at the
configuration level to disable this behavior.
:term:`IPK_FEED_URIS`
@@ -3687,7 +3709,7 @@
Values for this variable are set in the kernel's recipe file and the
kernel's append file. For example, if you are using the
``linux-yocto_4.12`` kernel, the kernel recipe file is the
- ``meta/recipes-kernel/linux/linux-yocto_4.12.bb`` file. ``KBRANCH``
+ ``meta/recipes-kernel/linux/linux-yocto_4.12.bb`` file. :term:`KBRANCH`
is set as follows in that kernel recipe file::
KBRANCH ?= "standard/base"
@@ -3707,7 +3729,7 @@
KBRANCH_edgerouter = "standard/edgerouter"
KBRANCH_beaglebone = "standard/beaglebone"
- The ``KBRANCH`` statements
+ The :term:`KBRANCH` statements
identify the kernel branch to use when building for each supported
BSP.
@@ -3721,7 +3743,7 @@
would place patch files and configuration fragment files (i.e.
"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
+ :term:`KBUILD_DEFCONFIG` variable and append the
:term:`KMACHINE` variable to point to the
``defconfig`` file.
@@ -3730,7 +3752,7 @@
KBUILD_DEFCONFIG_KMACHINE ?= defconfig_file
- Here is an example from a "raspberrypi2" ``KMACHINE`` build that uses
+ Here is an example from a "raspberrypi2" :term:`KMACHINE` build that uses
a ``defconfig`` file named "bcm2709_defconfig"::
KBUILD_DEFCONFIG_raspberrypi2 = "bcm2709_defconfig"
@@ -3740,7 +3762,7 @@
KBUILD_DEFCONFIG_pn-linux-yocto ?= defconfig_file
For more
- information on how to use the ``KBUILD_DEFCONFIG`` variable, see the
+ information on how to use the :term:`KBUILD_DEFCONFIG` variable, see the
":ref:`kernel-dev/common:using an "in-tree" \`\`defconfig\`\` file`"
section in the Yocto Project Linux Kernel Development Manual.
@@ -3757,27 +3779,27 @@
options not explicitly specified will be disabled in the kernel
config.
- In case ``KCONFIG_MODE`` is not set the behaviour will depend on where
+ In case :term:`KCONFIG_MODE` is not set the behaviour will depend on where
the ``defconfig`` file is coming from. An "in-tree" ``defconfig`` file
will be handled in ``alldefconfig`` mode, a ``defconfig`` file placed
in ``${WORKDIR}`` through a meta-layer will be handled in
``allnoconfig`` mode.
An "in-tree" ``defconfig`` file can be selected via the
- :term:`KBUILD_DEFCONFIG` variable. ``KCONFIG_MODE`` does not need to
+ :term:`KBUILD_DEFCONFIG` variable. :term:`KCONFIG_MODE` does not need to
be explicitly set.
A ``defconfig`` file compatible with ``allnoconfig`` mode can be
generated by copying the ``.config`` file from a working Linux kernel
build, renaming it to ``defconfig`` and placing it into the Linux
- kernel ``${WORKDIR}`` through your meta-layer. ``KCONFIG_MODE`` does
+ kernel ``${WORKDIR}`` through your meta-layer. :term:`KCONFIG_MODE` does
not need to be explicitly set.
A ``defconfig`` file compatible with ``alldefconfig`` mode can be
generated using the
:ref:`ref-tasks-savedefconfig`
task and placed into the Linux kernel ``${WORKDIR}`` through your
- meta-layer. Explicitely set ``KCONFIG_MODE``::
+ meta-layer. Explicitely set :term:`KCONFIG_MODE`::
KCONFIG_MODE = "alldefconfig"
@@ -3789,10 +3811,10 @@
:term:`KERNEL_ARTIFACT_NAME`
Specifies the name of all of the build artifacts. You can change the
- name of the artifacts by changing the ``KERNEL_ARTIFACT_NAME``
+ name of the artifacts by changing the :term:`KERNEL_ARTIFACT_NAME`
variable.
- The value of ``KERNEL_ARTIFACT_NAME``, which is set in the
+ The value of :term:`KERNEL_ARTIFACT_NAME`, which is set in the
``meta/classes/kernel-artifact-names.bbclass`` file, has the
following default value::
@@ -3869,13 +3891,13 @@
system, the default Board Support Packages (BSPs)
:term:`Metadata` is provided through the
:term:`KMACHINE` and :term:`KBRANCH`
- variables. You can use the ``KERNEL_FEATURES`` variable from within
+ variables. You can use the :term:`KERNEL_FEATURES` variable from within
the kernel recipe or kernel append file to further add metadata for
all BSPs or specific BSPs.
The metadata you add through this variable includes config fragments
and features descriptions, which usually includes patches as well as
- config fragments. You typically override the ``KERNEL_FEATURES``
+ config fragments. You typically override the :term:`KERNEL_FEATURES`
variable for a specific machine. In this way, you can provide
validated, but optional, sets of kernel configurations and features.
@@ -3935,12 +3957,12 @@
:term:`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
+ :term:`KERNEL_IMAGE_MAXSIZE` is set, the size of the kernel image file is
checked against the set value during the
: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
+ :term:`KERNEL_IMAGE_MAXSIZE` is useful for target devices that have a
limited amount of space in which the kernel image must be stored.
By default, this variable is not set, which means the size of the
@@ -3965,7 +3987,7 @@
build.
If you want to build an alternate kernel image type in addition to that
- specified by ``KERNEL_IMAGETYPE``, use the :term:`KERNEL_ALT_IMAGETYPE`
+ specified by :term:`KERNEL_IMAGETYPE`, use the :term:`KERNEL_ALT_IMAGETYPE`
variable.
:term:`KERNEL_MODULE_AUTOLOAD`
@@ -3976,7 +3998,7 @@
This variable replaces the deprecated :term:`module_autoload`
variable.
- You can use the ``KERNEL_MODULE_AUTOLOAD`` variable anywhere that it
+ You can use the :term:`KERNEL_MODULE_AUTOLOAD` variable anywhere that it
can be recognized by the kernel recipe or by an out-of-tree kernel
module recipe (e.g. a machine configuration file, a distribution
configuration file, an append file for the recipe, or the recipe
@@ -3986,7 +4008,7 @@
KERNEL_MODULE_AUTOLOAD += "module_name1 module_name2 module_name3"
- Including ``KERNEL_MODULE_AUTOLOAD`` causes the OpenEmbedded build
+ Including :term:`KERNEL_MODULE_AUTOLOAD` causes the OpenEmbedded build
system to populate the ``/etc/modules-load.d/modname.conf`` file with
the list of modules to be auto-loaded on boot. The modules appear
one-per-line in the file. Here is an example of the most common use
@@ -4015,7 +4037,7 @@
To help maximize compatibility with out-of-tree drivers used to build
modules, the OpenEmbedded build system also recognizes and uses the
:term:`KERNEL_SRC` variable, which is identical to
- the ``KERNEL_PATH`` variable. Both variables are common variables
+ the :term:`KERNEL_PATH` variable. Both variables are common variables
used by external Makefiles to point to the kernel source directory.
:term:`KERNEL_SRC`
@@ -4029,7 +4051,7 @@
To help maximize compatibility with out-of-tree drivers used to build
modules, the OpenEmbedded build system also recognizes and uses the
:term:`KERNEL_PATH` variable, which is identical
- to the ``KERNEL_SRC`` variable. Both variables are common variables
+ to the :term:`KERNEL_SRC` variable. Both variables are common variables
used by external Makefiles to point to the kernel source directory.
:term:`KERNEL_VERSION`
@@ -4042,9 +4064,9 @@
:term:`KERNELDEPMODDEPEND`
Specifies whether the data referenced through
:term:`PKGDATA_DIR` is needed or not.
- ``KERNELDEPMODDEPEND`` does not control whether or not that data
+ :term:`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
+ use the data, set the :term:`KERNELDEPMODDEPEND` variable in your
``initramfs`` recipe. Setting the variable there when the data is not
needed avoids a potential dependency loop.
@@ -4063,7 +4085,7 @@
OpenEmbedded build system understands as ``core2-32-intel-common``
goes by a different name in the Linux Yocto kernel. The kernel
understands that machine as ``intel-core2-32``. For cases like these,
- the ``KMACHINE`` variable maps the kernel machine name to the
+ the :term:`KMACHINE` variable maps the kernel machine name to the
OpenEmbedded build system machine name.
These mappings between different names occur in the Yocto Linux
@@ -4078,7 +4100,7 @@
KBRANCH_core2-32-intel-common = "standard/base"
KERNEL_FEATURES_append_core2-32-intel-common = "${KERNEL_FEATURES_INTEL_COMMON}"
- The ``KMACHINE`` statement says
+ The :term:`KMACHINE` statement says
that the kernel understands the machine name as "intel-core2-32".
However, the OpenEmbedded build system understands the machine as
"core2-32-intel-common".
@@ -4091,7 +4113,7 @@
Yocto Project Linux Kernel Development Manual for more information on
kernel types.
- You define the ``KTYPE`` variable in the
+ You define the :term:`KTYPE` variable in the
:ref:`kernel-dev/advanced:bsp descriptions`. The
value you use must match the value used for the
:term:`LINUX_KERNEL_TYPE` value used by the
@@ -4144,7 +4166,7 @@
:term:`LAYERSERIES_COMPAT`
Lists the versions of the :term:`OpenEmbedded-Core (OE-Core)` for which
- a layer is compatible. Using the ``LAYERSERIES_COMPAT`` variable
+ a layer is compatible. Using the :term:`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
system a way to detect when a layer has not been tested with new
@@ -4161,7 +4183,7 @@
.. note::
- Setting ``LAYERSERIES_COMPAT`` is required by the Yocto Project
+ Setting :term:`LAYERSERIES_COMPAT` is required by the Yocto Project
Compatible version 2 standard.
The OpenEmbedded build system produces a warning if the variable
is not set for any given layer.
@@ -4185,7 +4207,7 @@
to an environment variable and thus made visible to the software
being built during the compilation step.
- Default initialization for ``LDFLAGS`` varies depending on what is
+ Default initialization for :term:`LDFLAGS` varies depending on what is
being built:
- :term:`TARGET_LDFLAGS` when building for the
@@ -4260,7 +4282,7 @@
LICENSE_${PN}-doc = "GFDL-1.2"
:term:`LICENSE_CREATE_PACKAGE`
- Setting ``LICENSE_CREATE_PACKAGE`` to "1" causes the OpenEmbedded
+ Setting :term:`LICENSE_CREATE_PACKAGE` to "1" causes the OpenEmbedded
build system to create an extra package (i.e.
``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add
those packages to the
@@ -4305,9 +4327,9 @@
:term:`LICENSE_PATH`
Path to additional licenses used during the build. By default, the
- OpenEmbedded build system uses ``COMMON_LICENSE_DIR`` to define the
+ OpenEmbedded build system uses :term:`COMMON_LICENSE_DIR` to define the
directory that holds common license text used during the build. The
- ``LICENSE_PATH`` variable allows you to extend that location to other
+ :term:`LICENSE_PATH` variable allows you to extend that location to other
areas that have additional licenses::
LICENSE_PATH += "path-to-additional-common-licenses"
@@ -4320,9 +4342,9 @@
Yocto Project Linux Kernel Development Manual for more information on
kernel types.
- If you do not specify a ``LINUX_KERNEL_TYPE``, it defaults to
+ If you do not specify a :term:`LINUX_KERNEL_TYPE`, it defaults to
"standard". Together with :term:`KMACHINE`, the
- ``LINUX_KERNEL_TYPE`` variable defines the search arguments used by
+ :term:`LINUX_KERNEL_TYPE` variable defines the search arguments used by
the kernel tools to find the appropriate description within the
kernel :term:`Metadata` with which to build out the sources
and configuration.
@@ -4336,7 +4358,7 @@
LINUX_VERSION ?= "3.4.24"
- The ``LINUX_VERSION`` variable is used to define :term:`PV`
+ The :term:`LINUX_VERSION` variable is used to define :term:`PV`
for the recipe::
PV = "${LINUX_VERSION}+git${SRCPV}"
@@ -4366,8 +4388,8 @@
:term:`MACHINE`
Specifies the target device for which the image is built. You define
- ``MACHINE`` in the ``local.conf`` file found in the
- :term:`Build Directory`. By default, ``MACHINE`` is set to
+ :term:`MACHINE` in the ``local.conf`` file found in the
+ :term:`Build Directory`. By default, :term:`MACHINE` is set to
"qemux86", which is an x86-based architecture machine to be emulated
using QEMU::
@@ -4375,7 +4397,7 @@
The variable corresponds to a machine configuration file of the same
name, through which machine-specific configurations are set. Thus,
- when ``MACHINE`` is set to "qemux86", the corresponding
+ when :term:`MACHINE` is set to "qemux86", the corresponding
``qemux86.conf`` machine configuration file can be found in
the :term:`Source Directory` in
``meta/conf/machine``.
@@ -4401,13 +4423,13 @@
.. note::
Adding additional Board Support Package (BSP) layers to your
- configuration adds new possible settings for ``MACHINE``.
+ configuration adds new possible settings for :term:`MACHINE`.
:term:`MACHINE_ARCH`
Specifies the name of the machine-specific architecture. This
variable is set automatically from :term:`MACHINE` or
:term:`TUNE_PKGARCH`. You should not hand-edit
- the ``MACHINE_ARCH`` variable.
+ the :term:`MACHINE_ARCH` variable.
:term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
A list of required machine-specific packages to install as part of
@@ -4419,7 +4441,7 @@
image.
This variable is similar to the
- ``MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`` variable with the exception
+ :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` variable with the exception
that the image being built has a build dependency on the variable's
list of packages. In other words, the image will not build if a file
in this list is not found.
@@ -4440,7 +4462,7 @@
on ``packagegroup-core-boot``, including the ``core-image-minimal``
image.
- This variable is similar to the ``MACHINE_ESSENTIAL_EXTRA_RDEPENDS``
+ This variable is similar to the :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
variable with the exception that the image being built does not have
a build dependency on the variable's list of packages. In other
words, the image will still build if a package in this list is not
@@ -4482,7 +4504,7 @@
which does not include the ``core-image-minimal`` or
``core-image-full-cmdline`` images.
- The variable is similar to the ``MACHINE_EXTRA_RRECOMMENDS`` variable
+ The variable is similar to the :term:`MACHINE_EXTRA_RRECOMMENDS` variable
with the exception that the image being built has a build dependency
on the variable's list of packages. In other words, the image will
not build if a file in this list is not found.
@@ -4507,7 +4529,7 @@
which does not include the ``core-image-minimal`` or
``core-image-full-cmdline`` images.
- This variable is similar to the ``MACHINE_EXTRA_RDEPENDS`` variable
+ This variable is similar to the :term:`MACHINE_EXTRA_RDEPENDS` variable
with the exception that the image being built does not have a build
dependency on the variable's list of packages. In other words, the
image will build if a file in this list is not found.
@@ -4536,8 +4558,8 @@
shipped, see the ":ref:`ref-features-machine`" section.
:term:`MACHINE_FEATURES_BACKFILL`
- Features to be added to ``MACHINE_FEATURES`` if not also present in
- ``MACHINE_FEATURES_BACKFILL_CONSIDERED``.
+ Features to be added to :term:`MACHINE_FEATURES` if not also present in
+ :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`.
This variable is set in the ``meta/conf/bitbake.conf`` file. It is
not intended to be user-configurable. It is best to just reference
@@ -4546,8 +4568,8 @@
section for more information.
:term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`
- Features from ``MACHINE_FEATURES_BACKFILL`` that should not be
- backfilled (i.e. added to ``MACHINE_FEATURES``) during the build. See
+ Features from :term:`MACHINE_FEATURES_BACKFILL` that should not be
+ backfilled (i.e. added to :term:`MACHINE_FEATURES`) during the build. See
the ":ref:`ref-features-backfill`" section for more information.
:term:`MACHINEOVERRIDES`
@@ -4555,11 +4577,11 @@
machine. By default, this list includes the value of
:term:`MACHINE`.
- You can extend ``MACHINEOVERRIDES`` to add extra overrides that
+ You can extend :term:`MACHINEOVERRIDES` to add extra overrides that
should apply to a machine. For example, all machines emulated in QEMU
(e.g. ``qemuarm``, ``qemux86``, and so forth) include a file named
``meta/conf/machine/include/qemu.inc`` that prepends the following
- override to ``MACHINEOVERRIDES``::
+ override to :term:`MACHINEOVERRIDES`::
MACHINEOVERRIDES =. "qemuall:"
@@ -4573,7 +4595,7 @@
"
The underlying mechanism behind
- ``MACHINEOVERRIDES`` is simply that it is included in the default
+ :term:`MACHINEOVERRIDES` is simply that it is included in the default
value of :term:`OVERRIDES`.
:term:`MAINTAINER`
@@ -4593,10 +4615,10 @@
first tries the local download directory. If that location fails, the
build system tries locations defined by
:term:`PREMIRRORS`, the upstream source, and then
- locations specified by ``MIRRORS`` in that order.
+ locations specified by :term:`MIRRORS` in that order.
Assuming your distribution (:term:`DISTRO`) is "poky",
- the default value for ``MIRRORS`` is defined in the
+ the default value for :term:`MIRRORS` is defined in the
``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository.
:term:`MLPREFIX`
@@ -4604,16 +4626,16 @@
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 :term:`BPN` variable).
- ``MLPREFIX`` gets set when a prefix has been added to ``PN``.
+ :term:`MLPREFIX` gets set when a prefix has been added to :term:`PN`.
.. note::
- The "ML" in ``MLPREFIX`` stands for "MultiLib". This representation is
+ The "ML" in :term:`MLPREFIX` stands for "MultiLib". This representation is
historical and comes from a time when ``nativesdk`` was a suffix
rather than a prefix on the recipe name. When ``nativesdk`` was turned
- into a prefix, it made sense to set ``MLPREFIX`` for it as well.
+ into a prefix, it made sense to set :term:`MLPREFIX` for it as well.
- To help understand when ``MLPREFIX`` might be needed, consider when
+ To help understand when :term:`MLPREFIX` might be needed, consider when
: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
@@ -4629,10 +4651,10 @@
do_foo[depends] += "${MLPREFIX}recipe:do_foo"
- module_autoload
- This variable has been replaced by the ``KERNEL_MODULE_AUTOLOAD``
+ :term:`module_autoload`
+ This variable has been replaced by the :term:`KERNEL_MODULE_AUTOLOAD`
variable. You should replace all occurrences of ``module_autoload``
- with additions to ``KERNEL_MODULE_AUTOLOAD``, for example::
+ with additions to :term:`KERNEL_MODULE_AUTOLOAD`, for example::
module_autoload_rfcomm = "rfcomm"
@@ -4642,7 +4664,7 @@
See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information.
- module_conf
+ :term:`module_conf`
Specifies `modprobe.d <https://linux.die.net/man/5/modprobe.d>`_
syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf``
file.
@@ -4716,7 +4738,7 @@
Some classes (e.g.
:ref:`cross-canadian <ref-classes-cross-canadian>`) modify the
- ``MULTIMACH_TARGET_SYS`` value.
+ :term:`MULTIMACH_TARGET_SYS` value.
See the :term:`STAMP` variable for an example. See the
:term:`STAGING_DIR_TARGET` variable for more information.
@@ -4745,10 +4767,10 @@
licenses that are not in any way common. Also, new licenses are added
occasionally to avoid introducing a lot of common license files,
which are only applicable to a specific package.
- ``NO_GENERIC_LICENSE`` is used to allow copying a license that does
+ :term:`NO_GENERIC_LICENSE` is used to allow copying a license that does
not exist in common licenses.
- The following example shows how to add ``NO_GENERIC_LICENSE`` to a
+ The following example shows how to add :term:`NO_GENERIC_LICENSE` to a
recipe::
NO_GENERIC_LICENSE[license_name] = "license_file_in_fetched_source"
@@ -4763,7 +4785,7 @@
Prevents installation of all "recommended-only" packages.
Recommended-only packages are packages installed only through the
:term:`RRECOMMENDS` variable). Setting the
- ``NO_RECOMMENDATIONS`` variable to "1" turns this feature on::
+ :term:`NO_RECOMMENDATIONS` variable to "1" turns this feature on::
NO_RECOMMENDATIONS = "1"
@@ -4795,7 +4817,7 @@
:term:`NOAUTOPACKAGEDEBUG`
Disables auto package from splitting ``.debug`` files. If a recipe
requires ``FILES_${PN}-dbg`` to be set manually, the
- ``NOAUTOPACKAGEDEBUG`` can be defined allowing you to define the
+ :term:`NOAUTOPACKAGEDEBUG` can be defined allowing you to define the
content of the debug package. For example::
NOAUTOPACKAGEDEBUG = "1"
@@ -4803,6 +4825,13 @@
FILES_${PN}-dbg = "/usr/src/debug/"
FILES_${QT_BASE_NAME}-demos-doc = "${docdir}/${QT_DIR_NAME}/qch/qt.qch"
+ :term:`NON_MULTILIB_RECIPES`
+ A list of recipes that should not be built for multilib. OE-Core's
+ ``multilib.conf`` file defines a reasonable starting point for this
+ list with::
+
+ NON_MULTILIB_RECIPES = "grub grub-efi make-mod-scripts ovmf u-boot"
+
:term:`OBJCOPY`
The minimal command and arguments to run ``objcopy``.
@@ -4838,7 +4867,7 @@
value is "oe-init-build-env".
If you use a custom script to set up your build environment, set the
- ``OE_INIT_ENV_SCRIPT`` variable to its name.
+ :term:`OE_INIT_ENV_SCRIPT` variable to its name.
:term:`OE_TERMINAL`
Controls how the OpenEmbedded build system spawns interactive
@@ -4861,7 +4890,7 @@
The directory from which the top-level build environment setup script
is sourced. The Yocto Project provides a top-level build environment
setup script: :ref:`structure-core-script`. When you run this
- script, the ``OEROOT`` variable resolves to the directory that
+ script, the :term:`OEROOT` variable resolves to the directory that
contains the script.
For additional information on how this variable is used, see the
@@ -4881,12 +4910,12 @@
A colon-separated list of overrides that currently apply. Overrides
are a BitBake mechanism that allows variables to be selectively
overridden at the end of parsing. The set of overrides in
- ``OVERRIDES`` represents the "state" during building, which includes
+ :term:`OVERRIDES` represents the "state" during building, which includes
the current recipe being built, the machine for which it is being
built, and so forth.
As an example, if the string "an-override" appears as an element in
- the colon-separated list in ``OVERRIDES``, then the following
+ the colon-separated list in :term:`OVERRIDES`, then the following
assignment will override ``FOO`` with the value "overridden" at the
end of parsing::
@@ -4897,7 +4926,7 @@
section in the BitBake User Manual for more information on the
overrides mechanism.
- The default value of ``OVERRIDES`` includes the values of the
+ The default value of :term:`OVERRIDES` includes the values of the
:term:`CLASSOVERRIDE`,
:term:`MACHINEOVERRIDES`, and
:term:`DISTROOVERRIDES` variables. Another
@@ -4909,13 +4938,13 @@
.. note::
- An easy way to see what overrides apply is to search for ``OVERRIDES``
+ An easy way to see what overrides apply is to search for :term:`OVERRIDES`
in the output of the ``bitbake -e`` command. See the
":ref:`dev-manual/common-tasks:viewing variable values`" section in the Yocto
Project Development Tasks Manual for more information.
:term:`P`
- The recipe name and version. ``P`` is comprised of the following::
+ The recipe name and version. :term:`P` is comprised of the following::
${PN}-${PV}
@@ -4950,7 +4979,7 @@
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, you should set :term:`PACKAGE_ARCH` to the value of
:term:`MACHINE_ARCH` in the recipe as follows::
PACKAGE_ARCH = "${MACHINE_ARCH}"
@@ -4959,11 +4988,11 @@
Specifies a list of architectures compatible with the target machine.
This variable is set automatically and should not normally be
hand-edited. Entries are separated using spaces and listed in order
- of priority. The default value for ``PACKAGE_ARCHS`` is "all any
+ of priority. The default value for :term:`PACKAGE_ARCHS` is "all any
noarch ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}".
:term:`PACKAGE_BEFORE_PN`
- Enables easily adding packages to ``PACKAGES`` before ``${PN}`` so
+ Enables easily adding packages to :term:`PACKAGES` before ``${PN}`` so
that those added packages can pick up files that would normally be
included in the default package.
@@ -5003,7 +5032,7 @@
creating ``*-dbg`` packages to be used with the GNU Project Debugger
(GDB).
- With the ``PACKAGE_DEBUG_SPLIT_STYLE`` variable, you can control
+ With the :term:`PACKAGE_DEBUG_SPLIT_STYLE` variable, you can control
where debug information, which can include or exclude source files,
is stored:
@@ -5040,7 +5069,7 @@
are using :term:`IMAGE_FEATURES` to install
``dev-pkgs``, you might not want to install all packages from a
particular multilib. If you find yourself in this situation, you can
- use the ``PACKAGE_EXCLUDE_COMPLEMENTARY`` variable to specify regular
+ use the :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` variable to specify regular
expressions to match the packages you want to exclude.
:term:`PACKAGE_EXCLUDE`
@@ -5078,7 +5107,7 @@
:term:`PACKAGE_FEED_ARCHS`
Optionally specifies the package architectures used as part of the
package feed URIs during the build. When used, the
- ``PACKAGE_FEED_ARCHS`` variable is appended to the final package feed
+ :term:`PACKAGE_FEED_ARCHS` variable is appended to the final package feed
URI, which is constructed using the
:term:`PACKAGE_FEED_URIS` and
:term:`PACKAGE_FEED_BASE_PATHS`
@@ -5086,15 +5115,15 @@
.. note::
- You can use the ``PACKAGE_FEED_ARCHS``
+ You can use the :term:`PACKAGE_FEED_ARCHS`
variable to whitelist specific package architectures. If you do
not need to whitelist specific architectures, which is a common
case, you can omit this variable. Omitting the variable results in
all available architectures for the current machine being included
into remote package feeds.
- Consider the following example where the ``PACKAGE_FEED_URIS``,
- ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are
+ Consider the following example where the :term:`PACKAGE_FEED_URIS`,
+ :term:`PACKAGE_FEED_BASE_PATHS`, and :term:`PACKAGE_FEED_ARCHS` variables are
defined in your ``local.conf`` file::
PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
@@ -5117,13 +5146,13 @@
:term:`PACKAGE_FEED_BASE_PATHS`
Specifies the base path used when constructing package feed URIs. The
- ``PACKAGE_FEED_BASE_PATHS`` variable makes up the middle portion of a
+ :term:`PACKAGE_FEED_BASE_PATHS` variable makes up the middle portion of a
package feed URI used by the OpenEmbedded build system. The base path
lies between the :term:`PACKAGE_FEED_URIS`
and :term:`PACKAGE_FEED_ARCHS` variables.
- Consider the following example where the ``PACKAGE_FEED_URIS``,
- ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are
+ Consider the following example where the :term:`PACKAGE_FEED_URIS`,
+ :term:`PACKAGE_FEED_BASE_PATHS`, and :term:`PACKAGE_FEED_ARCHS` variables are
defined in your ``local.conf`` file::
PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
@@ -5147,12 +5176,12 @@
:term:`PACKAGE_FEED_URIS`
Specifies the front portion of the package feed URI used by the
OpenEmbedded build system. Each final package feed URI is comprised
- of ``PACKAGE_FEED_URIS``,
+ of :term:`PACKAGE_FEED_URIS`,
:term:`PACKAGE_FEED_BASE_PATHS`, and
:term:`PACKAGE_FEED_ARCHS` variables.
- Consider the following example where the ``PACKAGE_FEED_URIS``,
- ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are
+ Consider the following example where the :term:`PACKAGE_FEED_URIS`,
+ :term:`PACKAGE_FEED_BASE_PATHS`, and :term:`PACKAGE_FEED_ARCHS` variables are
defined in your ``local.conf`` file::
PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
@@ -5178,7 +5207,7 @@
installation into the image.
Because the package manager controls actual installation of all
- packages, the list of packages passed using ``PACKAGE_INSTALL`` is
+ packages, the list of packages passed using :term:`PACKAGE_INSTALL` is
not the final list of packages that are actually installed. This
variable is internal to the image construction code. Consequently, in
general, you should use the
@@ -5186,7 +5215,7 @@
packages for installation. The exception to this is when working with
the :ref:`core-image-minimal-initramfs <ref-manual/images:images>`
image. When working with an initial RAM filesystem (initramfs) image,
- use the ``PACKAGE_INSTALL`` variable. For information on creating an
+ use the :term:`PACKAGE_INSTALL` variable. For information on creating an
initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section
in the Yocto Project Development Tasks Manual.
@@ -5207,7 +5236,7 @@
post-installation or pre-installation script can execute at rootfs
creation time rather than on the target but depends on a native tool
in order to execute, you need to list the tools in
- ``PACKAGE_WRITE_DEPS``.
+ :term:`PACKAGE_WRITE_DEPS`.
For information on running post-installation scripts, see the
":ref:`dev-manual/common-tasks:post-installation scripts`"
@@ -5215,7 +5244,7 @@
:term:`PACKAGECONFIG`
This variable provides a means of enabling or disabling features of a
- recipe on a per-recipe basis. ``PACKAGECONFIG`` blocks are defined in
+ recipe on a per-recipe basis. :term:`PACKAGECONFIG` blocks are defined in
recipes when you specify features and then arguments that define
feature behaviors. Here is the basic block structure (broken over
multiple lines for readability)::
@@ -5243,8 +5272,8 @@
:term:`PACKAGECONFIG_CONFARGS`) if
the feature is enabled.
- 2. Extra arguments that should be added to ``EXTRA_OECONF`` or
- ``PACKAGECONFIG_CONFARGS`` if the feature is disabled.
+ 2. Extra arguments that should be added to :term:`EXTRA_OECONF` or
+ :term:`PACKAGECONFIG_CONFARGS` if the feature is disabled.
3. Additional build dependencies (:term:`DEPENDS`)
that should be added if the feature is enabled.
@@ -5256,10 +5285,10 @@
(:term:`RRECOMMENDS`) that should be added if
the feature is enabled.
- 6. Any conflicting (that is, mutually exclusive) ``PACKAGECONFIG``
+ 6. Any conflicting (that is, mutually exclusive) :term:`PACKAGECONFIG`
settings for this feature.
- Consider the following ``PACKAGECONFIG`` block taken from the
+ Consider the following :term:`PACKAGECONFIG` block taken from the
``librsvg`` recipe. In this example the feature is ``gtk``, which has
three arguments that determine the feature's behavior.
::
@@ -5269,21 +5298,21 @@
The
``--with-gtk3`` and ``gtk+3`` arguments apply only if the feature is
enabled. In this case, ``--with-gtk3`` is added to the configure
- script argument list and ``gtk+3`` is added to ``DEPENDS``. On the
+ script argument list and ``gtk+3`` is added to :term:`DEPENDS`. On the
other hand, if the feature is disabled say through a ``.bbappend``
file in another layer, then the second argument ``--without-gtk3`` is
added to the configure script instead.
- The basic ``PACKAGECONFIG`` structure previously described holds true
+ The basic :term:`PACKAGECONFIG` structure previously described holds true
regardless of whether you are creating a block or changing a block.
When creating a block, use the structure inside your recipe.
- If you want to change an existing ``PACKAGECONFIG`` block, you can do
+ If you want to change an existing :term:`PACKAGECONFIG` block, you can do
so one of two ways:
- *Append file:* Create an append file named
recipename\ ``.bbappend`` in your layer and override the value of
- ``PACKAGECONFIG``. You can either completely override the
+ :term:`PACKAGECONFIG`. You can either completely override the
variable::
PACKAGECONFIG = "f4 f5"
@@ -5308,16 +5337,16 @@
:term:`PACKAGECONFIG` setting.
Classes such as :ref:`autotools <ref-classes-autotools>` and
- :ref:`cmake <ref-classes-cmake>` use ``PACKAGECONFIG_CONFARGS`` to
- pass ``PACKAGECONFIG`` options to ``configure`` and ``cmake``,
- respectively. If you are using ``PACKAGECONFIG`` but not a class that
+ :ref:`cmake <ref-classes-cmake>` use :term:`PACKAGECONFIG_CONFARGS` to
+ pass :term:`PACKAGECONFIG` options to ``configure`` and ``cmake``,
+ respectively. If you are using :term:`PACKAGECONFIG` but not a class that
handles the ``do_configure`` task, then you need to use
- ``PACKAGECONFIG_CONFARGS`` appropriately.
+ :term:`PACKAGECONFIG_CONFARGS` appropriately.
:term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY`
For recipes inheriting the
:ref:`packagegroup <ref-classes-packagegroup>` class, setting
- ``PACKAGEGROUP_DISABLE_COMPLEMENTARY`` to "1" specifies that the
+ :term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY` to "1" specifies that the
normal complementary packages (i.e. ``-dev``, ``-dbg``, and so forth)
should not be automatically created by the ``packagegroup`` recipe,
which is the default behavior.
@@ -5329,10 +5358,10 @@
${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN}
During packaging, the :ref:`ref-tasks-package` task
- goes through ``PACKAGES`` and uses the :term:`FILES`
+ goes through :term:`PACKAGES` and uses the :term:`FILES`
variable corresponding to each package to assign files to the
- package. If a file matches the ``FILES`` variable for more than one
- package in ``PACKAGES``, it will be assigned to the earliest
+ package. If a file matches the :term:`FILES` variable for more than one
+ package in :term:`PACKAGES`, it will be assigned to the earliest
(leftmost) package.
Packages in the variable's list that are empty (i.e. where none of
@@ -5344,10 +5373,10 @@
:term:`PACKAGES_DYNAMIC`
A promise that your recipe satisfies runtime dependencies for
optional modules that are found in other recipes.
- ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it
+ :term:`PACKAGES_DYNAMIC` does not actually satisfy the dependencies, it
only states that they should be satisfied. For example, if a hard,
runtime dependency (:term:`RDEPENDS`) of another
- package is satisfied at build time through the ``PACKAGES_DYNAMIC``
+ package is satisfied at build time through the :term:`PACKAGES_DYNAMIC`
variable, but a package with the module name is never actually
produced, then the other package will be broken. Thus, if you attempt
to include that package in an image, you will get a dependency
@@ -5357,9 +5386,9 @@
Typically, if there is a chance that such a situation can occur and
the package that is not created is valid without the dependency being
satisfied, then you should use :term:`RRECOMMENDS`
- (a soft runtime dependency) instead of ``RDEPENDS``.
+ (a soft runtime dependency) instead of :term:`RDEPENDS`.
- For an example of how to use the ``PACKAGES_DYNAMIC`` variable when
+ For an example of how to use the :term:`PACKAGES_DYNAMIC` variable when
you are splitting packages, see the
":ref:`dev-manual/common-tasks:handling optional module packaging`"
section in the Yocto Project Development Tasks Manual.
@@ -5383,7 +5412,7 @@
.. note::
- In order for ``PARALLEL_MAKE`` to be effective, ``make`` must be
+ In order for :term:`PARALLEL_MAKE` to be effective, ``make`` must be
called with ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy way to ensure
this is to use the ``oe_runmake`` function.
@@ -5394,7 +5423,7 @@
If the software being built experiences dependency issues during
the ``do_compile`` task that result in race conditions, you can clear
- the ``PARALLEL_MAKE`` variable within the recipe as a workaround. For
+ the :term:`PARALLEL_MAKE` variable within the recipe as a workaround. For
information on addressing race conditions, see the
":ref:`dev-manual/common-tasks:debugging parallel make races`"
section in the Yocto Project Development Tasks Manual.
@@ -5402,7 +5431,7 @@
For single socket systems (i.e. one CPU), you should not have to
override this variable to gain optimal parallelism during builds.
However, if you have very large systems that employ multiple physical
- CPUs, you might want to make sure the ``PARALLEL_MAKE`` variable is
+ CPUs, you might want to make sure the :term:`PARALLEL_MAKE` variable is
not set higher than "-j 20".
For more information on speeding up builds, see the
@@ -5417,14 +5446,14 @@
.. note::
- In order for ``PARALLEL_MAKEINST`` to be effective, ``make`` must
+ In order for :term:`PARALLEL_MAKEINST` to be effective, ``make`` must
be called with
``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy
way to ensure this is to use the ``oe_runmake`` function.
If the software being built experiences dependency issues during
the ``do_install`` task that result in race conditions, you can
- clear the ``PARALLEL_MAKEINST`` variable within the recipe as a
+ clear the :term:`PARALLEL_MAKEINST` variable within the recipe as a
workaround. For information on addressing race conditions, see the
":ref:`dev-manual/common-tasks:debugging parallel make races`"
section in the Yocto Project Development Tasks Manual.
@@ -5461,7 +5490,7 @@
variable is used to make upgrades possible when the versioning scheme
changes in some backwards incompatible way.
- ``PE`` is the default value of the :term:`PKGE` variable.
+ :term:`PE` is the default value of the :term:`PKGE` variable.
:term:`PF`
Specifies the recipe or package name and includes all version and
@@ -5483,7 +5512,7 @@
.. note::
- When using the ``PKG`` variable, you must use a package name override.
+ When using the :term:`PKG` variable, you must use a package name override.
For example, when the :ref:`debian <ref-classes-debian>` class
renames the output package, it does so by setting
@@ -5534,45 +5563,45 @@
:term:`PKGDESTWORK`
Points to a temporary work area where the
:ref:`ref-tasks-package` task saves package metadata.
- The ``PKGDESTWORK`` location defaults to the following::
+ The :term:`PKGDESTWORK` location defaults to the following::
${WORKDIR}/pkgdata
Do not change this default.
The :ref:`ref-tasks-packagedata` task copies the
- package metadata from ``PKGDESTWORK`` to
+ package metadata from :term:`PKGDESTWORK` to
:term:`PKGDATA_DIR` to make it available globally.
:term:`PKGE`
- The epoch of the package(s) built by the recipe. By default, ``PKGE``
+ The epoch of the package(s) built by the recipe. By default, :term:`PKGE`
is set to :term:`PE`.
:term:`PKGR`
The revision of the package(s) built by the recipe. By default,
- ``PKGR`` is set to :term:`PR`.
+ :term:`PKGR` is set to :term:`PR`.
:term:`PKGV`
The version of the package(s) built by the recipe. By default,
- ``PKGV`` is set to :term:`PV`.
+ :term:`PKGV` is set to :term:`PV`.
:term:`PN`
This variable can have two separate functions depending on the
context: a recipe name or a resulting package name.
- ``PN`` refers to a recipe name in the context of a file used by the
+ :term:`PN` refers to a recipe name in the context of a file used by the
OpenEmbedded build system as input to create a package. The name is
normally extracted from the recipe file name. For example, if the
- recipe is named ``expat_2.0.1.bb``, then the default value of ``PN``
+ recipe is named ``expat_2.0.1.bb``, then the default value of :term:`PN`
will be "expat".
The variable refers to a package name in the context of a file
created or produced by the OpenEmbedded build system.
- If applicable, the ``PN`` variable also contains any special suffix
+ If applicable, the :term:`PN` variable also contains any special suffix
or prefix. For example, using ``bash`` to build packages for the
native machine, ``PN`` is ``bash-native``. Using ``bash`` to build
- packages for the target and for Multilib, ``PN`` would be ``bash``
+ packages for the target and for Multilib, :term:`PN` would be ``bash``
and ``lib64-bash``, respectively.
:term:`PNBLACKLIST`
@@ -5581,7 +5610,7 @@
:ref:`blacklist <ref-classes-blacklist>` class, which is inherited
globally.
- To prevent a recipe from being built, use the ``PNBLACKLIST``
+ To prevent a recipe from being built, use the :term:`PNBLACKLIST`
variable in your ``local.conf`` file. Here is an example that
prevents ``myrecipe`` from being built::
@@ -5615,30 +5644,30 @@
The revision of the recipe. The default value for this variable is
"r0". Subsequent revisions of the recipe conventionally have the
values "r1", "r2", and so forth. When :term:`PV` increases,
- ``PR`` is conventionally reset to "r0".
+ :term:`PR` is conventionally reset to "r0".
.. note::
- The OpenEmbedded build system does not need the aid of ``PR``
+ The OpenEmbedded build system does not need the aid of :term:`PR`
to know when to rebuild a recipe. The build system uses the task
:ref:`input checksums <overview-manual/concepts:checksums (signatures)>` along with the
:ref:`stamp <structure-build-tmp-stamps>` and
:ref:`overview-manual/concepts:shared state cache`
mechanisms.
- The ``PR`` variable primarily becomes significant when a package
+ The :term:`PR` variable primarily becomes significant when a package
manager dynamically installs packages on an already built image. In
- this case, ``PR``, which is the default value of
+ this case, :term:`PR`, which is the default value of
:term:`PKGR`, helps the package manager distinguish which
package is the most recent one in cases where many packages have the
- same ``PV`` (i.e. ``PKGV``). A component having many packages with
- the same ``PV`` usually means that the packages all install the same
- upstream version, but with later (``PR``) version packages including
+ same :term:`PV` (i.e. :term:`PKGV`). A component having many packages with
+ the same :term:`PV` usually means that the packages all install the same
+ upstream version, but with later (:term:`PR`) version packages including
packaging fixes.
.. note::
- ``PR`` does not need to be increased for changes that do not change the
+ :term:`PR` does not need to be increased for changes that do not change the
package contents or metadata.
Because manually managing ``PR`` can be cumbersome and error-prone,
@@ -5657,7 +5686,7 @@
PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto"
In the previous example, multiple recipes are providing "virtual/kernel".
- The ``PREFERRED_PROVIDER`` variable is set with the name (``PN``) of
+ The :term:`PREFERRED_PROVIDER` variable is set with the name (:term:`PN`) of
the recipe you prefer to provide "virtual/kernel".
Following are more examples::
@@ -5671,9 +5700,9 @@
.. note::
- If you use a ``virtual/\*`` item with ``PREFERRED_PROVIDER``, then any
+ If you use a ``virtual/\*`` item with :term:`PREFERRED_PROVIDER`, then any
recipe that :term:`PROVIDES` that item but is not selected (defined)
- by ``PREFERRED_PROVIDER`` is prevented from building, which is usually
+ by :term:`PREFERRED_PROVIDER` is prevented from building, which is usually
desirable since this mechanism is designed to select between mutually
exclusive alternative providers.
@@ -5684,7 +5713,7 @@
the first example below), and you should specify the :term:`PV`
accordingly (`3.4.0` in the example).
- The ``PREFERRED_VERSION`` variable supports limited wildcard use
+ The :term:`PREFERRED_VERSION` variable supports limited wildcard use
through the "``%``" character. You can use the character to match any
number of characters, which can be useful when specifying versions
that contain long revision numbers that potentially change. Here are
@@ -5716,7 +5745,7 @@
PREFERRED_VERSION_foo = "git"
- Sometimes the ``PREFERRED_VERSION`` variable can be set by
+ Sometimes the :term:`PREFERRED_VERSION` variable can be set by
configuration files in a way that is hard to change. You can use
:term:`OVERRIDES` to set a machine-specific
override. Here is an example::
@@ -5732,7 +5761,7 @@
.. note::
The ``\_forcevariable`` override is not handled specially. This override
- only works because the default value of ``OVERRIDES`` includes "forcevariable".
+ only works because the default value of :term:`OVERRIDES` includes "forcevariable".
If a recipe with the specified version is not available, a warning
message will be shown. See :term:`REQUIRED_VERSION` if you want this
@@ -5742,12 +5771,12 @@
Specifies additional paths from which the OpenEmbedded build system
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``, the upstream
+ build system tries locations defined by :term:`PREMIRRORS`, the upstream
source, and then locations specified by
:term:`MIRRORS` in that order.
Assuming your distribution (:term:`DISTRO`) is "poky",
- the default value for ``PREMIRRORS`` is defined in the
+ the default value for :term:`PREMIRRORS` is defined in the
``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository.
Typically, you could add a specific server for the build system to
@@ -5770,12 +5799,12 @@
:term:`PRIORITY`
Indicates the importance of a package.
- ``PRIORITY`` is considered to be part of the distribution policy
+ :term:`PRIORITY` is considered to be part of the distribution policy
because the importance of any given recipe depends on the purpose for
- which the distribution is being produced. Thus, ``PRIORITY`` is not
+ which the distribution is being produced. Thus, :term:`PRIORITY` is not
normally set within recipes.
- You can set ``PRIORITY`` to "required", "standard", "extra", and
+ You can set :term:`PRIORITY` to "required", "standard", "extra", and
"optional", which is the default.
:term:`PRIVATE_LIBS`
@@ -5805,19 +5834,19 @@
:term:`PROVIDES`
A list of aliases by which a particular recipe can be known. By
- default, a recipe's own ``PN`` is implicitly already in its
- ``PROVIDES`` list and therefore does not need to mention that it
- provides itself. If a recipe uses ``PROVIDES``, the additional
+ default, a recipe's own :term:`PN` is implicitly already in its
+ :term:`PROVIDES` list and therefore does not need to mention that it
+ provides itself. If a recipe uses :term:`PROVIDES`, the additional
aliases are synonyms for the recipe and can be useful for satisfying
dependencies of other recipes during the build as specified by
- ``DEPENDS``.
+ :term:`DEPENDS`.
- Consider the following example ``PROVIDES`` statement from the recipe
+ Consider the following example :term:`PROVIDES` statement from the recipe
file ``eudev_3.2.9.bb``::
PROVIDES += "udev"
- The ``PROVIDES`` statement
+ The :term:`PROVIDES` statement
results in the "eudev" recipe also being available as simply "udev".
.. note::
@@ -5827,12 +5856,12 @@
strictly necessary it is recommended to avoid confusion.
In addition to providing recipes under alternate names, the
- ``PROVIDES`` mechanism is also used to implement virtual targets. A
+ :term:`PROVIDES` mechanism is also used to implement virtual targets. A
virtual target is a name that corresponds to some particular
functionality (e.g. a Linux kernel). Recipes that provide the
- functionality in question list the virtual target in ``PROVIDES``.
+ functionality in question list the virtual target in :term:`PROVIDES`.
Recipes that depend on the functionality in question can include the
- virtual target in ``DEPENDS`` to leave the choice of provider open.
+ virtual target in :term:`DEPENDS` to leave the choice of provider open.
Conventionally, virtual targets have names on the form
"virtual/function" (e.g. "virtual/kernel"). The slash is simply part
@@ -5860,14 +5889,14 @@
The ``conf/local.conf.sample.extended`` configuration file in the
:term:`Source Directory` shows how the
- ``PRSERV_HOST`` variable is set::
+ :term:`PRSERV_HOST` variable is set::
PRSERV_HOST = "localhost:0"
You must
set the variable if you want to automatically start a local :ref:`PR
service <dev-manual/common-tasks:working with a pr service>`. You can
- set ``PRSERV_HOST`` to other values to use a remote PR service.
+ set :term:`PRSERV_HOST` to other values to use a remote PR service.
:term:`PSEUDO_IGNORE_PATHS`
@@ -5889,12 +5918,12 @@
:term:`PV`
The version of the recipe. The version is normally extracted from the
recipe filename. For example, if the recipe is named
- ``expat_2.0.1.bb``, then the default value of ``PV`` will be "2.0.1".
- ``PV`` is generally not overridden within a recipe unless it is
+ ``expat_2.0.1.bb``, then the default value of :term:`PV` will be "2.0.1".
+ :term:`PV` is generally not overridden within a recipe unless it is
building an unstable (i.e. development) version from a source code
repository (e.g. Git or Subversion).
- ``PV`` is the default value of the :term:`PKGV` variable.
+ :term:`PV` is the default value of the :term:`PKGV` variable.
:term:`PYTHON_ABI`
When used by recipes that inherit the
@@ -5916,7 +5945,7 @@
When used by recipes that inherit the
`distutils3 <ref-classes-distutils3>`,
:ref:`setuptools3 <ref-classes-setuptools3>` classes, specifies the
- major Python version being built. For Python 3.x, ``PYTHON_PN`` would
+ major Python version being built. For Python 3.x, :term:`PYTHON_PN` would
be "python3". You do not have to set this variable as the
OpenEmbedded build system automatically sets it for you.
@@ -5926,7 +5955,7 @@
DEPENDS += "${PYTHON_PN}-native"
In the previous example,
- the version of the dependency is ``PYTHON_PN``.
+ the version of the dependency is :term:`PYTHON_PN`.
:term:`RANLIB`
The minimal command and arguments to run ``ranlib``.
@@ -5944,7 +5973,7 @@
specifying versioned dependencies. Although the syntax varies
depending on the packaging format, BitBake hides these differences
from you. Here is the general syntax to specify versions with the
- ``RCONFLICTS`` variable::
+ :term:`RCONFLICTS` variable::
RCONFLICTS_${PN} = "package (operator version)"
@@ -5972,12 +6001,12 @@
The most common types of package
runtime dependencies are automatically detected and added. Therefore,
- most recipes do not need to set ``RDEPENDS``. For more information,
+ most recipes do not need to set :term:`RDEPENDS`. For more information,
see the
":ref:`overview-manual/concepts:automatically added runtime dependencies`"
section in the Yocto Project Overview and Concepts Manual.
- The practical effect of the above ``RDEPENDS`` assignment is that
+ The practical effect of the above :term:`RDEPENDS` assignment is that
``bar`` and ``baz`` will be declared as dependencies inside the
package ``foo`` when it is written out by one of the
:ref:`do_package_write_\* <ref-tasks-package_write_deb>` tasks.
@@ -5988,26 +6017,26 @@
also install the packages on which it depends.
To ensure that the packages ``bar`` and ``baz`` get built, the
- previous ``RDEPENDS`` assignment also causes a task dependency to be
+ previous :term:`RDEPENDS` assignment also causes a task dependency to be
added. This dependency is from the recipe's
:ref:`ref-tasks-build` (not to be confused with
:ref:`ref-tasks-compile`) task to the
``do_package_write_*`` task of the recipes that build ``bar`` and
``baz``.
- The names of the packages you list within ``RDEPENDS`` must be the
+ The names of the packages you list within :term:`RDEPENDS` must be the
names of other packages - they cannot be recipe names. Although
package names and recipe names usually match, the important point
- here is that you are providing package names within the ``RDEPENDS``
+ here is that you are providing package names within the :term:`RDEPENDS`
variable. For an example of the default list of packages created from
a recipe, see the :term:`PACKAGES` variable.
- Because the ``RDEPENDS`` variable applies to packages being built,
+ Because the :term:`RDEPENDS` variable applies to packages being built,
you should always use the variable in a form with an attached package
name (remember that a single recipe can build multiple packages). For
example, suppose you are building a development package that depends
on the ``perl`` package. In this case, you would use the following
- ``RDEPENDS`` statement::
+ :term:`RDEPENDS` statement::
RDEPENDS_${PN}-dev += "perl"
@@ -6024,19 +6053,19 @@
``${PN}`` when modifying ``RDEPENDS_${PN}-dev``. Use the "+=" operator
rather than the "=" operator.
- The package names you use with ``RDEPENDS`` must appear as they would
- in the ``PACKAGES`` variable. The :term:`PKG` variable
+ The package names you use with :term:`RDEPENDS` must appear as they would
+ in the :term:`PACKAGES` variable. The :term:`PKG` variable
allows a different name to be used for the final package (e.g. the
:ref:`debian <ref-classes-debian>` class uses this to rename
packages), but this final package name cannot be used with
- ``RDEPENDS``, which makes sense as ``RDEPENDS`` is meant to be
+ :term:`RDEPENDS`, which makes sense as :term:`RDEPENDS` is meant to be
independent of the package format used.
BitBake, which the OpenEmbedded build system uses, supports
specifying versioned dependencies. Although the syntax varies
depending on the packaging format, BitBake hides these differences
from you. Here is the general syntax to specify versions with the
- ``RDEPENDS`` variable::
+ :term:`RDEPENDS` variable::
RDEPENDS_${PN} = "package (operator version)"
@@ -6052,7 +6081,7 @@
.. note::
- You can use ``EXTENDPKGV`` to provide a full package version
+ You can use :term:`EXTENDPKGV` to provide a full package version
specification.
For example, the following sets up a dependency on version 1.2 or
@@ -6073,8 +6102,8 @@
class, this variable identifies distribution features that must exist
in the current configuration in order for the OpenEmbedded build
system to build the recipe. In other words, if the
- ``REQUIRED_DISTRO_FEATURES`` variable lists a feature that does not
- appear in ``DISTRO_FEATURES`` within the current configuration, then
+ :term:`REQUIRED_DISTRO_FEATURES` variable lists a feature that does not
+ appear in :term:`DISTRO_FEATURES` within the current configuration, then
the recipe will be skipped, and if the build system attempts to build
the recipe then an error will be triggered.
@@ -6122,7 +6151,7 @@
:term:`ROOTFS`
Indicates a filesystem image to include as the root filesystem.
- The ``ROOTFS`` variable is an optional variable used with the
+ The :term:`ROOTFS` variable is an optional variable used with the
:ref:`image-live <ref-classes-image-live>` class.
:term:`ROOTFS_POSTINSTALL_COMMAND`
@@ -6183,11 +6212,11 @@
A list of package name aliases that a package also provides. These
aliases are useful for satisfying runtime dependencies of other
packages both during the build and on the target (as specified by
- ``RDEPENDS``).
+ :term:`RDEPENDS`).
.. note::
- A package's own name is implicitly already in its ``RPROVIDES`` list.
+ A package's own name is implicitly already in its :term:`RPROVIDES` list.
As with all package-controlling variables, you must always use the
variable in conjunction with a package name override. Here is an
@@ -6200,16 +6229,16 @@
built. The package being built does not depend on this list of
packages in order to successfully build, but rather uses them for
extended usability. To specify runtime dependencies for packages, see
- the ``RDEPENDS`` variable.
+ the :term:`RDEPENDS` variable.
- The package manager will automatically install the ``RRECOMMENDS``
+ The package manager will automatically install the :term:`RRECOMMENDS`
list of packages when installing the built package. However, you can
prevent listed packages from being installed by using the
:term:`BAD_RECOMMENDATIONS`,
:term:`NO_RECOMMENDATIONS`, and
:term:`PACKAGE_EXCLUDE` variables.
- Packages specified in ``RRECOMMENDS`` need not actually be produced.
+ Packages specified in :term:`RRECOMMENDS` need not actually be produced.
However, there must be a recipe providing each package, either
through the :term:`PACKAGES` or
:term:`PACKAGES_DYNAMIC` variables or the
@@ -6217,7 +6246,7 @@
during the build. If such a recipe does exist and the package is not
produced, the build continues without error.
- Because the ``RRECOMMENDS`` variable applies to packages being built,
+ Because the :term:`RRECOMMENDS` variable applies to packages being built,
you should always attach an override to the variable to specify the
particular package whose usability is being extended. For example,
suppose you are building a development package that is extended to
@@ -6228,14 +6257,14 @@
In the
example, the package name (``${PN}-dev``) must appear as it would in
- the ``PACKAGES`` namespace before any renaming of the output package
+ the :term:`PACKAGES` namespace before any renaming of the output package
by classes such as ``debian.bbclass``.
BitBake, which the OpenEmbedded build system uses, supports
specifying versioned recommends. Although the syntax varies depending
on the packaging format, BitBake hides these differences from you.
Here is the general syntax to specify versions with the
- ``RRECOMMENDS`` variable::
+ :term:`RRECOMMENDS` variable::
RRECOMMENDS_${PN} = "package (operator version)"
@@ -6257,7 +6286,7 @@
this variable to determine which package should be installed to
replace other package(s) during an upgrade. In order to also have the
other package(s) removed at the same time, you must add the name of
- the other package to the ``RCONFLICTS`` variable.
+ the other package to the :term:`RCONFLICTS` variable.
As with all package-controlling variables, you must use this variable
in conjunction with a package name override. Here is an example::
@@ -6268,7 +6297,7 @@
specifying versioned replacements. Although the syntax varies
depending on the packaging format, BitBake hides these differences
from you. Here is the general syntax to specify versions with the
- ``RREPLACES`` variable::
+ :term:`RREPLACES` variable::
RREPLACES_${PN} = "package (operator version)"
@@ -6304,7 +6333,7 @@
version. If the source tarball extracts the code to a directory named
anything other than ``${BPN}-${PV}``, or if the source code is
fetched from an SCM such as Git or Subversion, then you must set
- ``S`` in the recipe so that the OpenEmbedded build system knows where
+ :term:`S` in the recipe so that the OpenEmbedded build system knows where
to find the unpacked source.
As an example, assume a :term:`Source Directory`
@@ -6319,7 +6348,7 @@
This next example assumes a Git repository. By default, Git
repositories are cloned to ``${WORKDIR}/git`` during
:ref:`ref-tasks-fetch`. Since this path is different
- from the default value of ``S``, you must set it specifically so the
+ from the default value of :term:`S`, you must set it specifically so the
source can be located::
SRC_URI = "git://path/to/repo.git"
@@ -6336,7 +6365,7 @@
been tested against. Identifiers consist of the host distributor ID
followed by the release, as reported by the ``lsb_release`` tool or
as read from ``/etc/lsb-release``. Separate the list items with
- explicit newline characters (``\n``). If ``SANITY_TESTED_DISTROS`` is
+ explicit newline characters (``\n``). If :term:`SANITY_TESTED_DISTROS` is
not empty and the current value of
:term:`NATIVELSBSTRING` does not appear in the
list, then the build system reports a warning that indicates the
@@ -6347,7 +6376,7 @@
set this variable. Instead, use :term:`SDKMACHINE`.
:term:`SDK_CUSTOM_TEMPLATECONF`
- When building the extensible SDK, if ``SDK_CUSTOM_TEMPLATECONF`` is set to
+ When building the extensible SDK, if :term:`SDK_CUSTOM_TEMPLATECONF` is set to
"1" and a ``conf/templateconf.conf`` file exists in the build directory
(:term:`TOPDIR`) then this will be copied into the SDK.
@@ -6355,7 +6384,7 @@
The directory set up and used by the
:ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which
the SDK is deployed. The ``populate_sdk_base`` class defines
- ``SDK_DEPLOY`` as follows::
+ :term:`SDK_DEPLOY` as follows::
SDK_DEPLOY = "${TMPDIR}/deploy/sdk"
@@ -6369,8 +6398,8 @@
.. note::
- The ``SDK_DIR`` directory is a temporary directory as it is part of
- ``WORKDIR``. The final output directory is :term:`SDK_DEPLOY`.
+ The :term:`SDK_DIR` directory is a temporary directory as it is part of
+ :term:`WORKDIR`. The final output directory is :term:`SDK_DEPLOY`.
:term:`SDK_EXT_TYPE`
Controls whether or not shared state artifacts are copied into the
@@ -6409,7 +6438,7 @@
.. note::
- Enabling the ``SDK_INCLUDE_PKGDATA``
+ Enabling the :term:`SDK_INCLUDE_PKGDATA`
variable significantly increases build time because all of world
needs to be built. Enabling the variable also slightly increases
the size of the extensible SDK.
@@ -6423,9 +6452,9 @@
IDE or from other tools and you do not want to perform additional
steps to install the toolchain.
- The ``SDK_INCLUDE_TOOLCHAIN`` variable defaults to "0" if
- ``SDK_EXT_TYPE`` is set to "minimal", and defaults to "1" if
- ``SDK_EXT_TYPE`` is set to "full".
+ The :term:`SDK_INCLUDE_TOOLCHAIN` variable defaults to "0" if
+ :term:`SDK_EXT_TYPE` is set to "minimal", and defaults to "1" if
+ :term:`SDK_EXT_TYPE` is set to "full".
:term:`SDK_INHERIT_BLACKLIST`
A list of classes to remove from the :term:`INHERIT`
@@ -6451,7 +6480,7 @@
build system is running and thus would be potentially problematic
within the extensible SDK.
- By default, ``SDK_LOCAL_CONF_BLACKLIST`` is set in the
+ By default, :term:`SDK_LOCAL_CONF_BLACKLIST` is set in the
:ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class and
excludes the following variables:
@@ -6513,7 +6542,7 @@
.. note::
- The ``SDK_OUTPUT`` directory is a temporary directory as it is part of
+ The :term:`SDK_OUTPUT` directory is a temporary directory as it is part of
:term:`WORKDIR` by way of :term:`SDK_DIR`. The final output directory is
:term:`SDK_DEPLOY`.
@@ -6521,7 +6550,7 @@
Specifies a list of architectures compatible with the SDK machine.
This variable is set automatically and should not normally be
hand-edited. Entries are separated using spaces and listed in order
- of priority. The default value for ``SDK_PACKAGE_ARCHS`` is "all any
+ of priority. The default value for :term:`SDK_PACKAGE_ARCHS` is "all any
noarch ${SDK_ARCH}-${SDKPKGSUFFIX}".
:term:`SDK_POSTPROCESS_COMMAND`
@@ -6536,7 +6565,7 @@
:term:`SDK_PREFIX`
The toolchain binary prefix used for ``nativesdk`` recipes. The
- OpenEmbedded build system uses the ``SDK_PREFIX`` value to set the
+ OpenEmbedded build system uses the :term:`SDK_PREFIX` value to set the
:term:`TARGET_PREFIX` when building
``nativesdk`` recipes. The default value is "${SDK_SYS}-".
@@ -6550,9 +6579,9 @@
- do_deploy
Despite the default value of "" for the
- ``SDK_RECRDEP_TASKS`` variable, the above four tasks are always added
+ :term:`SDK_RECRDEP_TASKS` variable, the above four tasks are always added
to the SDK. To specify tasks beyond these four, you need to use the
- ``SDK_RECRDEP_TASKS`` variable (e.g. you are defining additional
+ :term:`SDK_RECRDEP_TASKS` variable (e.g. you are defining additional
tasks that are needed in order to build
:term:`SDK_TARGETS`).
@@ -6563,7 +6592,7 @@
The OpenEmbedded build system automatically sets this variable based
on :term:`SDK_ARCH`,
:term:`SDK_VENDOR`, and
- :term:`SDK_OS`. You do not need to set the ``SDK_SYS``
+ :term:`SDK_OS`. You do not need to set the :term:`SDK_SYS`
variable yourself.
:term:`SDK_TARGET_MANIFEST`
@@ -6587,7 +6616,7 @@
standard or extensible SDK installation. The default value is "${PN}"
(i.e. the image from which the SDK is built).
- The ``SDK_TARGETS`` variable is an internal variable and typically
+ The :term:`SDK_TARGETS` variable is an internal variable and typically
would not be changed.
:term:`SDK_TITLE`
@@ -6600,7 +6629,7 @@
SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK"
For the default distribution "poky",
- ``SDK_TITLE`` is set to "Poky (Yocto Project Reference Distro)".
+ :term:`SDK_TITLE` is set to "Poky (Yocto Project Reference Distro)".
For information on how to change this default title, see the
":ref:`sdk-manual/appendix-customizing:changing the extensible sdk installer title`"
@@ -6618,7 +6647,7 @@
:term:`SDK_VERSION`
Specifies the version of the SDK. The Poky distribution configuration file
(``/meta-poky/conf/distro/poky.conf``) sets the default
- ``SDK_VERSION`` as follows::
+ :term:`SDK_VERSION` as follows::
SDK_VERSION = "${@d.getVar('DISTRO_VERSION').replace('snapshot-${METADATA_REVISION}', 'snapshot')}"
@@ -6636,7 +6665,7 @@
SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk"
For the
- default distribution "poky", the ``SDKEXTPATH`` is set to "poky_sdk".
+ default distribution "poky", the :term:`SDKEXTPATH` is set to "poky_sdk".
For information on how to change this default directory, see the
":ref:`sdk-manual/appendix-customizing:changing the default sdk installation directory`"
@@ -6644,7 +6673,7 @@
Extensible Software Development Kit (eSDK) manual.
:term:`SDKIMAGE_FEATURES`
- Equivalent to ``IMAGE_FEATURES``. However, this variable applies to
+ Equivalent to :term:`IMAGE_FEATURES`. However, this variable applies to
the SDK generated from an image using the following command::
$ bitbake -c populate_sdk imagename
@@ -6652,7 +6681,7 @@
:term:`SDKMACHINE`
The machine for which the SDK is built. In other words, the SDK is
built such that it runs on the target you specify with the
- ``SDKMACHINE`` value. The value points to a corresponding ``.conf``
+ :term:`SDKMACHINE` value. The value points to a corresponding ``.conf``
file under ``conf/machine-sdk/``.
You can use "i686" and "x86_64" as possible values for this variable.
@@ -6664,7 +6693,7 @@
.. note::
- You cannot set the ``SDKMACHINE``
+ You cannot set the :term:`SDKMACHINE`
variable in your distribution configuration file. If you do, the
configuration will not take affect.
@@ -6689,7 +6718,7 @@
building for the target. The flags are passed through the default
value of the :term:`TARGET_CFLAGS` variable.
- The ``SELECTED_OPTIMIZATION`` variable takes the value of
+ The :term:`SELECTED_OPTIMIZATION` variable takes the value of
:term:`FULL_OPTIMIZATION` unless :term:`DEBUG_BUILD` = "1", in which
case the value of :term:`DEBUG_OPTIMIZATION` is used.
@@ -6703,7 +6732,7 @@
.. note::
- The ``SERIAL_CONSOLE`` variable is deprecated. Please use the
+ The :term:`SERIAL_CONSOLE` variable is deprecated. Please use the
:term:`SERIAL_CONSOLES` variable.
:term:`SERIAL_CONSOLES`
@@ -6821,7 +6850,7 @@
:term:`SOURCE_MIRROR_FETCH`
When you are fetching files to create a mirror of sources (i.e.
- creating a source mirror), setting ``SOURCE_MIRROR_FETCH`` to "1" in
+ creating a source mirror), setting :term:`SOURCE_MIRROR_FETCH` to "1" in
your ``local.conf`` configuration file ensures the source for all
recipes are fetched regardless of whether or not a recipe is
compatible with the configuration. A recipe is considered
@@ -6833,7 +6862,7 @@
.. note::
- Do not set the ``SOURCE_MIRROR_FETCH``
+ Do not set the :term:`SOURCE_MIRROR_FETCH`
variable unless you are creating a source mirror. In other words,
do not set the variable during a normal build.
@@ -6851,11 +6880,11 @@
.. note::
- You can specify only a single URL in ``SOURCE_MIRROR_URL``.
+ You can specify only a single URL in :term:`SOURCE_MIRROR_URL`.
:term:`SPDXLICENSEMAP`
Maps commonly used license names to their SPDX counterparts found in
- ``meta/files/common-licenses/``. For the default ``SPDXLICENSEMAP``
+ ``meta/files/common-licenses/``. For the default :term:`SPDXLICENSEMAP`
mappings, see the ``meta/conf/licenses.conf`` file.
For additional information, see the :term:`LICENSE`
@@ -6886,7 +6915,7 @@
SPL_IMAGE ?= "${SPL_BINARYNAME}-${MACHINE}-${PV}-${PR}"
SPL_SYMLINK ?= "${SPL_BINARYNAME}-${MACHINE}"
- The ``SPL_BINARY`` variable helps form
+ The :term:`SPL_BINARY` variable helps form
various ``SPL_*`` variables used by the OpenEmbedded build system.
See the BeagleBone machine configuration example in the
@@ -6899,7 +6928,7 @@
OpenEmbedded build system which bits to pull in for the build and how
to pull them in. For example, if the recipe or append file only needs
to fetch a tarball from the Internet, the recipe or append file uses
- a single ``SRC_URI`` entry. On the other hand, if the recipe or
+ a single :term:`SRC_URI` entry. On the other hand, if the recipe or
append file needs to fetch a tarball, apply two patches, and include
a custom file, the recipe or append file would include four instances
of the variable.
@@ -6978,7 +7007,7 @@
- ``az://`` - Fetches files from an Azure Storage account.
- There are standard and recipe-specific options for ``SRC_URI``. Here are
+ There are standard and recipe-specific options for :term:`SRC_URI`. Here are
standard ones:
- ``apply`` - Whether to apply the patch or not. The default
@@ -6997,19 +7026,19 @@
:term:`SRCDATE` is equal to or greater than
``mindate``.
- - ``maxdate`` - Apply the patch only if ``SRCDATE`` is not later
+ - ``maxdate`` - Apply the patch only if :term:`SRCDATE` is not later
than ``maxdate``.
- - ``minrev`` - Apply the patch only if ``SRCREV`` is equal to or
+ - ``minrev`` - Apply the patch only if :term:`SRCREV` is equal to or
greater than ``minrev``.
- - ``maxrev`` - Apply the patch only if ``SRCREV`` is not later
+ - ``maxrev`` - Apply the patch only if :term:`SRCREV` is not later
than ``maxrev``.
- - ``rev`` - Apply the patch only if ``SRCREV`` is equal to
+ - ``rev`` - Apply the patch only if :term:`SRCREV` is equal to
``rev``.
- - ``notrev`` - Apply the patch only if ``SRCREV`` is not equal to
+ - ``notrev`` - Apply the patch only if :term:`SRCREV` is not equal to
``rev``.
Here are some additional options worth mentioning:
@@ -7022,19 +7051,19 @@
the Git fetcher is used.
- ``subdir`` - Places the file (or extracts its contents) into the
- specified subdirectory of ``WORKDIR`` when the local (``file://``)
+ specified subdirectory of :term:`WORKDIR` when the local (``file://``)
fetcher is used.
- ``localdir`` - Places the file (or extracts its contents) into
- the specified subdirectory of ``WORKDIR`` when the CVS fetcher is
+ the specified subdirectory of :term:`WORKDIR` when the CVS fetcher is
used.
- ``subpath`` - Limits the checkout to a specific subpath of the
tree when using the Git fetcher is used.
- ``name`` - Specifies a name to be used for association with
- ``SRC_URI`` checksums or :term:`SRCREV` when you have more than one
- file or git repository specified in ``SRC_URI``. For example::
+ :term:`SRC_URI` checksums or :term:`SRCREV` when you have more than one
+ file or git repository specified in :term:`SRC_URI`. For example::
SRC_URI = "git://example.com/foo.git;name=first \
git://example.com/bar.git;name=second \
@@ -7051,7 +7080,7 @@
:term:`SRC_URI_OVERRIDES_PACKAGE_ARCH`
By default, the OpenEmbedded build system automatically detects
whether ``SRC_URI`` contains files that are machine-specific. If so,
- the build system automatically changes ``PACKAGE_ARCH``. Setting this
+ the build system automatically changes :term:`PACKAGE_ARCH`. Setting this
variable to "0" disables this behavior.
:term:`SRCDATE`
@@ -7063,16 +7092,16 @@
Returns the version string of the current package. This string is
used to help define the value of :term:`PV`.
- The ``SRCPV`` variable is defined in the ``meta/conf/bitbake.conf``
+ The :term:`SRCPV` variable is defined in the ``meta/conf/bitbake.conf``
configuration file in the :term:`Source Directory` as
follows::
SRCPV = "${@bb.fetch2.get_srcrev(d)}"
- Recipes that need to define ``PV`` do so with the help of the
- ``SRCPV``. For example, the ``ofono`` recipe (``ofono_git.bb``)
+ Recipes that need to define :term:`PV` do so with the help of the
+ :term:`SRCPV`. For example, the ``ofono`` recipe (``ofono_git.bb``)
located in ``meta/recipes-connectivity`` in the Source Directory
- defines ``PV`` as follows::
+ defines :term:`PV` as follows::
PV = "0.12-git${SRCPV}"
@@ -7081,26 +7110,50 @@
variable applies to Subversion, Git, Mercurial, and Bazaar only. Note
that if you want to build a fixed revision and you want to avoid
performing a query on the remote repository every time BitBake parses
- your recipe, you should specify a ``SRCREV`` that is a full revision
+ your recipe, you should specify a :term:`SRCREV` that is a full revision
identifier and not just a tag.
.. note::
For information on limitations when inheriting the latest revision
- of software using ``SRCREV``, see the :term:`AUTOREV` variable
+ of software using :term:`SRCREV`, see the :term:`AUTOREV` variable
description and the
":ref:`dev-manual/common-tasks:automatically incrementing a package version number`"
section, which is in the Yocto Project Development Tasks Manual.
+ :term:`SRCTREECOVEREDTASKS`
+ A list of tasks that are typically not relevant (and therefore skipped)
+ when building using the :ref:`externalsrc <ref-classes-externalsrc>`
+ class. The default value as set in that class file is the set of tasks
+ that are rarely needed when using external source::
+
+ SRCTREECOVEREDTASKS ?= "do_patch do_unpack do_fetch"
+
+ The notable exception is when processing external kernel source as
+ defined in the :ref:`kernel-yocto <ref-classes-kernel-yocto>`
+ class file (formatted for aesthetics)::
+
+ SRCTREECOVEREDTASKS += "\
+ do_validate_branches \
+ do_kernel_configcheck \
+ do_kernel_checkout \
+ do_fetch \
+ do_unpack \
+ do_patch \
+ "
+
+ See the associated :term:`EXTERNALSRC` and :term:`EXTERNALSRC_BUILD`
+ variables for more information.
+
:term:`SSTATE_DIR`
The directory for the shared state cache.
:term:`SSTATE_MIRROR_ALLOW_NETWORK`
If set to "1", allows fetches from mirrors that are specified in
:term:`SSTATE_MIRRORS` to work even when
- fetching from the network is disabled by setting ``BB_NO_NETWORK`` to
- "1". Using the ``SSTATE_MIRROR_ALLOW_NETWORK`` variable is useful if
- you have set ``SSTATE_MIRRORS`` to point to an internal server for
+ fetching from the network is disabled by setting :term:`BB_NO_NETWORK` to
+ "1". Using the :term:`SSTATE_MIRROR_ALLOW_NETWORK` variable is useful if
+ you have set :term:`SSTATE_MIRRORS` to point to an internal server for
your shared state cache, but you want to disable any other fetching
from the network.
@@ -7118,7 +7171,7 @@
When pointing to sstate build artifacts on another machine that uses
a different GCC version for native builds, you must configure
- ``SSTATE_MIRRORS`` with a regular expression that maps local search
+ :term:`SSTATE_MIRRORS` with a regular expression that maps local search
paths to server paths. The paths need to take into account
:term:`NATIVELSBSTRING` set by the
:ref:`uninative <ref-classes-uninative>` class. For example, the
@@ -7147,8 +7200,8 @@
(sstate) object during the first stage of preparing the sysroots.
That object is scanned for hardcoded paths for original installation
locations. The list of files that are scanned for paths is controlled
- by the ``SSTATE_SCAN_FILES`` variable. Typically, recipes add files
- they want to be scanned to the value of ``SSTATE_SCAN_FILES`` rather
+ by the :term:`SSTATE_SCAN_FILES` variable. Typically, recipes add files
+ they want to be scanned to the value of :term:`SSTATE_SCAN_FILES` rather
than the variable being comprehensively set. The
:ref:`sstate <ref-classes-sstate>` class specifies the default list
of files.
@@ -7210,7 +7263,7 @@
.. note::
- Recipes should never write files directly under the ``STAGING_DIR``
+ Recipes should never write files directly under the :term:`STAGING_DIR`
directory because the OpenEmbedded build system manages the
directory automatically. Instead, files should be installed to
``${``\ :term:`D`\ ``}`` within your recipe's :ref:`ref-tasks-install`
@@ -7225,7 +7278,7 @@
files. Exceptions include ``-native`` recipes, where the
``do_populate_sysroot`` task instead uses
:term:`STAGING_DIR_NATIVE`. Depending on
- the type of recipe and the build target, ``STAGING_DIR_HOST`` can
+ the type of recipe and the build target, :term:`STAGING_DIR_HOST` can
have the following values:
- For recipes building for the target machine, the value is
@@ -7243,7 +7296,7 @@
standard build environment variables such as
:term:`CPPFLAGS` and
:term:`CFLAGS` are set up so that both host paths
- and ``STAGING_DIR_NATIVE`` are searched for libraries and
+ and :term:`STAGING_DIR_NATIVE` are searched for libraries and
headers using, for example, GCC's ``-isystem`` option.
Thus, the emphasis is that the ``STAGING_DIR*`` variables
@@ -7251,7 +7304,7 @@
:ref:`ref-tasks-configure`,
:ref:`ref-tasks-compile`, and
:ref:`ref-tasks-install`. Having the real system
- root correspond to ``STAGING_DIR_HOST`` makes conceptual sense
+ root correspond to :term:`STAGING_DIR_HOST` makes conceptual sense
for ``-native`` recipes, as they make use of host headers and
libraries.
@@ -7262,7 +7315,7 @@
:term:`STAGING_DIR_TARGET`
Specifies the path to the sysroot used for the system for which the
component generates code. For components that do not generate code,
- which is the majority, ``STAGING_DIR_TARGET`` is set to match
+ which is the majority, :term:`STAGING_DIR_TARGET` is set to match
:term:`STAGING_DIR_HOST`.
Some recipes build binaries that can run on the target system but
@@ -7271,8 +7324,8 @@
primary system is referred to as the "HOST" and the secondary, or
different, system is referred to as the "TARGET". Thus, the binaries
run on the "HOST" system and generate binaries for the "TARGET"
- system. The ``STAGING_DIR_HOST`` variable points to the sysroot used
- for the "HOST" system, while ``STAGING_DIR_TARGET`` points to the
+ system. The :term:`STAGING_DIR_HOST` variable points to the sysroot used
+ for the "HOST" system, while :term:`STAGING_DIR_TARGET` points to the
sysroot used for the "TARGET" system.
:term:`STAGING_ETCDIR_NATIVE`
@@ -7297,7 +7350,7 @@
Points to the directory containing the kernel build artifacts.
Recipes building software that needs to access kernel build artifacts
(e.g. ``systemtap-uprobes``) can look in the directory specified with
- the ``STAGING_KERNEL_BUILDDIR`` variable to find these artifacts
+ the :term:`STAGING_KERNEL_BUILDDIR` variable to find these artifacts
after the kernel has been built.
:term:`STAGING_KERNEL_DIR`
@@ -7317,7 +7370,7 @@
Specifies the base path used to create recipe stamp files. The path
to an actual stamp file is constructed by evaluating this string and
then appending additional information. Currently, the default
- assignment for ``STAMP`` as set in the ``meta/conf/bitbake.conf``
+ assignment for :term:`STAMP` as set in the ``meta/conf/bitbake.conf``
file is::
STAMP = "${STAMPS_DIR}/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}"
@@ -7344,8 +7397,8 @@
:term:`SUMMARY`
The short (72 characters or less) summary of the binary package for
packaging systems such as ``opkg``, ``rpm``, or ``dpkg``. By default,
- ``SUMMARY`` is used to define the
- :term:`DESCRIPTION` variable if ``DESCRIPTION`` is
+ :term:`SUMMARY` is used to define the
+ :term:`DESCRIPTION` variable if :term:`DESCRIPTION` is
not set in the recipe.
:term:`SVNDIR`
@@ -7475,10 +7528,10 @@
:term:`SYSTEMD_BOOT_CFG`
When :term:`EFI_PROVIDER` is set to
- "systemd-boot", the ``SYSTEMD_BOOT_CFG`` variable specifies the
+ "systemd-boot", the :term:`SYSTEMD_BOOT_CFG` variable specifies the
configuration file that should be used. By default, the
:ref:`systemd-boot <ref-classes-systemd-boot>` class sets the
- ``SYSTEMD_BOOT_CFG`` as follows::
+ :term:`SYSTEMD_BOOT_CFG` as follows::
SYSTEMD_BOOT_CFG ?= "${:term:`S`}/loader.conf"
@@ -7487,11 +7540,11 @@
:term:`SYSTEMD_BOOT_ENTRIES`
When :term:`EFI_PROVIDER` is set to
- "systemd-boot", the ``SYSTEMD_BOOT_ENTRIES`` variable specifies a
+ "systemd-boot", the :term:`SYSTEMD_BOOT_ENTRIES` variable specifies a
list of entry files (``*.conf``) to install that contain one boot
entry per file. By default, the
:ref:`systemd-boot <ref-classes-systemd-boot>` class sets the
- ``SYSTEMD_BOOT_ENTRIES`` as follows::
+ :term:`SYSTEMD_BOOT_ENTRIES` as follows::
SYSTEMD_BOOT_ENTRIES ?= ""
@@ -7500,10 +7553,10 @@
:term:`SYSTEMD_BOOT_TIMEOUT`
When :term:`EFI_PROVIDER` is set to
- "systemd-boot", the ``SYSTEMD_BOOT_TIMEOUT`` variable specifies the
+ "systemd-boot", the :term:`SYSTEMD_BOOT_TIMEOUT` variable specifies the
boot menu timeout in seconds. By default, the
:ref:`systemd-boot <ref-classes-systemd-boot>` class sets the
- ``SYSTEMD_BOOT_TIMEOUT`` as follows::
+ :term:`SYSTEMD_BOOT_TIMEOUT` as follows::
SYSTEMD_BOOT_TIMEOUT ?= "10"
@@ -7513,14 +7566,14 @@
:term:`SYSTEMD_PACKAGES`
When inheriting the :ref:`systemd <ref-classes-systemd>` class,
this variable locates the systemd unit files when they are not found
- in the main recipe's package. By default, the ``SYSTEMD_PACKAGES``
+ in the main recipe's package. By default, the :term:`SYSTEMD_PACKAGES`
variable is set such that the systemd unit files are assumed to
reside in the recipes main package::
SYSTEMD_PACKAGES ?= "${PN}"
If these unit files are not in this recipe's main package, you need
- to use ``SYSTEMD_PACKAGES`` to list the package or packages in which
+ to use :term:`SYSTEMD_PACKAGES` to list the package or packages in which
the build system can find the systemd unit files.
:term:`SYSTEMD_SERVICE`
@@ -7541,7 +7594,7 @@
(allowing login), assuming :term:`USE_VT` is not set to
"0".
- The default value for ``SYSVINIT_ENABLED_GETTYS`` is "1" (i.e. only
+ The default value for :term:`SYSVINIT_ENABLED_GETTYS` is "1" (i.e. only
run a getty on the first virtual terminal).
:term:`T`
@@ -7555,7 +7608,7 @@
BitBake unpacks and builds the recipe. The default ``bitbake.conf``
file sets this variable.
- The ``T`` variable is not to be confused with the
+ The :term:`T` variable is not to be confused with the
:term:`TMPDIR` variable, which points to the root of
the directory tree where BitBake places the output of an entire
build.
@@ -7579,7 +7632,7 @@
:term:`TARGET_AS_ARCH`
Specifies architecture-specific assembler flags for the target
- system. ``TARGET_AS_ARCH`` is initialized from
+ system. :term:`TARGET_AS_ARCH` is initialized from
:term:`TUNE_ASARGS` by default in the BitBake
configuration file (``meta/conf/bitbake.conf``)::
@@ -7587,20 +7640,20 @@
:term:`TARGET_CC_ARCH`
Specifies architecture-specific C compiler flags for the target
- system. ``TARGET_CC_ARCH`` is initialized from
+ system. :term:`TARGET_CC_ARCH` is initialized from
:term:`TUNE_CCARGS` by default.
.. note::
It is a common workaround to append :term:`LDFLAGS` to
- ``TARGET_CC_ARCH`` in recipes that build software for the target that
- would not otherwise respect the exported ``LDFLAGS`` variable.
+ :term:`TARGET_CC_ARCH` in recipes that build software for the target that
+ would not otherwise respect the exported :term:`LDFLAGS` variable.
:term:`TARGET_CC_KERNEL_ARCH`
This is a specific kernel compiler flag for a CPU or Application
Binary Interface (ABI) tune. The flag is used rarely and only for
cases where a userspace :term:`TUNE_CCARGS` is not
- compatible with the kernel compilation. The ``TARGET_CC_KERNEL_ARCH``
+ compatible with the kernel compilation. The :term:`TARGET_CC_KERNEL_ARCH`
variable allows the kernel (and associated modules) to use a
different configuration. See the
``meta/conf/machine/include/arm/feature-arm-thumb.inc`` file in the
@@ -7612,8 +7665,8 @@
:term:`CFLAGS` is set to the value of this variable by
default.
- Additionally, the SDK's environment setup script sets the ``CFLAGS``
- variable in the environment to the ``TARGET_CFLAGS`` value so that
+ Additionally, the SDK's environment setup script sets the :term:`CFLAGS`
+ variable in the environment to the :term:`TARGET_CFLAGS` value so that
executables built using the SDK also have the flags applied.
:term:`TARGET_CPPFLAGS`
@@ -7623,7 +7676,7 @@
value of this variable by default.
Additionally, the SDK's environment setup script sets the
- ``CPPFLAGS`` variable in the environment to the ``TARGET_CPPFLAGS``
+ :term:`CPPFLAGS` variable in the environment to the :term:`TARGET_CPPFLAGS`
value so that executables built using the SDK also have the flags
applied.
@@ -7634,7 +7687,7 @@
by default.
Additionally, the SDK's environment setup script sets the
- ``CXXFLAGS`` variable in the environment to the ``TARGET_CXXFLAGS``
+ :term:`CXXFLAGS` variable in the environment to the :term:`TARGET_CXXFLAGS`
value so that executables built using the SDK also have the flags
applied.
@@ -7646,7 +7699,7 @@
:term:`TARGET_LD_ARCH`
Specifies architecture-specific linker flags for the target system.
- ``TARGET_LD_ARCH`` is initialized from
+ :term:`TARGET_LD_ARCH` is initialized from
:term:`TUNE_LDARGS` by default in the BitBake
configuration file (``meta/conf/bitbake.conf``)::
@@ -7660,7 +7713,7 @@
Additionally, the SDK's environment setup script sets the
:term:`LDFLAGS` variable in the environment to the
- ``TARGET_LDFLAGS`` value so that executables built using the SDK also
+ :term:`TARGET_LDFLAGS` value so that executables built using the SDK also
have the flags applied.
:term:`TARGET_OS`
@@ -7682,7 +7735,7 @@
value of ``BUILD_PREFIX``.
- For native SDK recipes (``nativesdk``), the build system sets the
- variable to the value of ``SDK_PREFIX``.
+ variable to the value of :term:`SDK_PREFIX`.
:term:`TARGET_SYS`
Specifies the system, including the architecture and the operating
@@ -7696,7 +7749,7 @@
.. note::
- You do not need to set the ``TARGET_SYS`` variable yourself.
+ You do not need to set the :term:`TARGET_SYS` variable yourself.
Consider these two examples:
@@ -7727,11 +7780,11 @@
In the ``defaultsetup.conf`` file, the default value of
``TCLIBCAPPEND`` is "-${TCLIBC}". However, distros such as poky,
which normally only support one ``libc`` variant, set
- ``TCLIBCAPPEND`` to "" in their distro configuration file resulting
+ :term:`TCLIBCAPPEND` to "" in their distro configuration file resulting
in no suffix being applied.
:term:`TCMODE`
- Specifies the toolchain selector. ``TCMODE`` controls the
+ Specifies the toolchain selector. :term:`TCMODE` controls the
characteristics of the generated packages and images by telling the
OpenEmbedded build system which toolchain profile to use. By default,
the OpenEmbedded build system builds its own internal toolchain. The
@@ -7740,7 +7793,7 @@
.. note::
- If ``TCMODE`` is set to a value other than "default", then it is your
+ If :term:`TCMODE` is set to a value other than "default", then it is your
responsibility to ensure that the toolchain is compatible with the
default toolchain. Using older or newer versions of these
components might cause build problems. See the Release Notes for
@@ -7750,7 +7803,7 @@
page on the Yocto Project website and click on the "RELEASE
INFORMATION" link for the appropriate release.
- The ``TCMODE`` variable is similar to :term:`TCLIBC`,
+ The :term:`TCMODE` variable is similar to :term:`TCLIBC`,
which controls the variant of the GNU standard C library (``libc``)
used during the build process: ``glibc`` or ``musl``.
@@ -7776,7 +7829,7 @@
the :term:`TEST_EXPORT_ONLY` variable is set
to "1".
- The ``TEST_EXPORT_DIR`` variable defaults to
+ The :term:`TEST_EXPORT_DIR` variable defaults to
``"${TMPDIR}/testimage/${PN}"``.
:term:`TEST_EXPORT_ONLY`
@@ -7786,7 +7839,7 @@
:term:`TEST_LOG_DIR`
Holds the SSH log and the boot log for QEMU machines. The
- ``TEST_LOG_DIR`` variable defaults to ``"${WORKDIR}/testimage"``.
+ :term:`TEST_LOG_DIR` variable defaults to ``"${WORKDIR}/testimage"``.
.. note::
@@ -7806,7 +7859,7 @@
For automated hardware testing, specifies additional arguments to
pass through to the command specified in
:term:`TEST_POWERCONTROL_CMD`. Setting
- ``TEST_POWERCONTROL_EXTRA_ARGS`` is optional. You can use it if you
+ :term:`TEST_POWERCONTROL_EXTRA_ARGS` is optional. You can use it if you
wish, for example, to separate the machine-specific and
non-machine-specific parts of the arguments.
@@ -7837,7 +7890,7 @@
For automated hardware testing, specifies additional arguments to
pass through to the command specified in
:term:`TEST_SERIALCONTROL_CMD`. Setting
- ``TEST_SERIALCONTROL_EXTRA_ARGS`` is optional. You can use it if you
+ :term:`TEST_SERIALCONTROL_EXTRA_ARGS` is optional. You can use it if you
wish, for example, to separate the machine-specific and
non-machine-specific parts of the command.
@@ -7849,7 +7902,7 @@
.. note::
- The ``TEST_SERVER_IP`` variable is only used for a small number of
+ The :term:`TEST_SERVER_IP` variable is only used for a small number of
tests such as the "dnf" test suite, which needs to download packages
from ``WORKDIR/oe-rootfs-repo``.
@@ -7866,7 +7919,7 @@
QEMU.
Tests include ``ping``, ``ssh``, ``df`` among others. You can add
- your own tests to the list of tests by appending ``TEST_SUITES`` as
+ your own tests to the list of tests by appending :term:`TEST_SUITES` as
follows::
TEST_SUITES_append = " mytest"
@@ -7905,7 +7958,7 @@
the controllers by adding a module in the layer's
``/lib/oeqa/controllers`` directory and by inheriting the
``BaseTarget`` class, which is an abstract class that cannot be used
- as a value of ``TEST_TARGET``.
+ as a value of :term:`TEST_TARGET`.
You can provide the following arguments with ``TEST_TARGET``:
@@ -7930,7 +7983,7 @@
section in the Yocto Project Development Tasks Manual.
:term:`TEST_TARGET_IP`
- The IP address of your hardware under test. The ``TEST_TARGET_IP``
+ The IP address of your hardware under test. The :term:`TEST_TARGET_IP`
variable has no effect when :term:`TEST_TARGET` is
set to "qemu".
@@ -7947,7 +8000,7 @@
:term:`TESTIMAGE_AUTO`
Automatically runs the series of automated tests for images when an
- image is successfully built. Setting ``TESTIMAGE_AUTO`` to "1" causes
+ image is successfully built. Setting :term:`TESTIMAGE_AUTO` to "1" causes
any image that successfully builds to automatically boot under QEMU.
Using the variable also adds in dependencies so that any SDK for
which testing is requested is automatically built first.
@@ -7979,7 +8032,7 @@
:term:`TMPDIR`
This variable is the base directory the OpenEmbedded build system
uses for all build output and intermediate files (other than the
- shared state cache). By default, the ``TMPDIR`` variable points to
+ shared state cache). By default, the :term:`TMPDIR` variable points to
``tmp`` within the :term:`Build Directory`.
If you want to establish this directory in a location other than the
@@ -7988,14 +8041,14 @@
#TMPDIR = "${TOPDIR}/tmp"
- An example use for this scenario is to set ``TMPDIR`` to a local disk,
+ An example use for this scenario is to set :term:`TMPDIR` to a local disk,
which does not use NFS, while having the Build Directory use NFS.
- The filesystem used by ``TMPDIR`` must have standard filesystem
+ The filesystem used by :term:`TMPDIR` must have standard filesystem
semantics (i.e. mixed-case files are unique, POSIX file locking, and
persistent inodes). Due to various issues with NFS and bugs in some
implementations, NFS does not meet this minimum requirement.
- Consequently, ``TMPDIR`` cannot be on NFS.
+ Consequently, :term:`TMPDIR` cannot be on NFS.
:term:`TOOLCHAIN_HOST_TASK`
This variable lists packages the OpenEmbedded build system uses when
@@ -8024,7 +8077,7 @@
:term:`TOOLCHAIN_OUTPUTNAME`
This variable defines the name used for the toolchain output. The
:ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class sets
- the ``TOOLCHAIN_OUTPUTNAME`` variable as follows::
+ the :term:`TOOLCHAIN_OUTPUTNAME` variable as follows::
TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}"
@@ -8060,7 +8113,7 @@
variable is used where the architecture is needed in a value where
underscores are not allowed, for example within package filenames. In
this case, dash characters replace any underscore characters used in
- ``TARGET_ARCH``.
+ :term:`TARGET_ARCH`.
Do not edit this variable.
@@ -8069,18 +8122,18 @@
``arm``, ``armeb``, ``mips``, ``mips64``, and so forth). BitBake uses
this value to setup configuration.
- ``TUNE_ARCH`` definitions are specific to a given architecture. The
+ :term:`TUNE_ARCH` definitions are specific to a given architecture. The
definitions can be a single static definition, or can be dynamically
adjusted. You can see details for a given CPU family by looking at
the architecture's ``README`` file. For example, the
``meta/conf/machine/include/mips/README`` file in the
:term:`Source Directory` provides information for
- ``TUNE_ARCH`` specific to the ``mips`` architecture.
+ :term:`TUNE_ARCH` specific to the ``mips`` architecture.
- ``TUNE_ARCH`` is tied closely to
+ :term:`TUNE_ARCH` is tied closely to
:term:`TARGET_ARCH`, which defines the target
machine's architecture. The BitBake configuration file
- (``meta/conf/bitbake.conf``) sets ``TARGET_ARCH`` as follows::
+ (``meta/conf/bitbake.conf``) sets :term:`TARGET_ARCH` as follows::
TARGET_ARCH = "${TUNE_ARCH}"
@@ -8098,7 +8151,7 @@
:term:`TUNE_ASARGS`
Specifies architecture-specific assembler flags for the target
system. The set of flags is based on the selected tune features.
- ``TUNE_ASARGS`` is set using the tune include files, which are
+ :term:`TUNE_ASARGS` is set using the tune include files, which are
typically under ``meta/conf/machine/include/`` and are influenced
through :term:`TUNE_FEATURES`. For example, the
``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags
@@ -8115,7 +8168,7 @@
:term:`TUNE_CCARGS`
Specifies architecture-specific C compiler flags for the target
system. The set of flags is based on the selected tune features.
- ``TUNE_CCARGS`` is set using the tune include files, which are
+ :term:`TUNE_CCARGS` is set using the tune include files, which are
typically under ``meta/conf/machine/include/`` and are influenced
through :term:`TUNE_FEATURES`.
@@ -8135,7 +8188,7 @@
are not conflicting and that they are supported.
The BitBake configuration file (``meta/conf/bitbake.conf``) defines
- ``TUNE_FEATURES`` as follows::
+ :term:`TUNE_FEATURES` as follows::
TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}"
@@ -8144,7 +8197,7 @@
:term:`TUNE_LDARGS`
Specifies architecture-specific linker flags for the target system.
The set of flags is based on the selected tune features.
- ``TUNE_LDARGS`` is set using the tune include files, which are
+ :term:`TUNE_LDARGS` is set using the tune include files, which are
typically under ``meta/conf/machine/include/`` and are influenced
through :term:`TUNE_FEATURES`. For example, the
``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags
@@ -8174,12 +8227,12 @@
:term:`TUNEABI`
An underlying Application Binary Interface (ABI) used by a particular
tuning in a given toolchain layer. Providers that use prebuilt
- libraries can use the ``TUNEABI``,
+ libraries can use the :term:`TUNEABI`,
:term:`TUNEABI_OVERRIDE`, and
:term:`TUNEABI_WHITELIST` variables to check
compatibility of tunings against their selection of libraries.
- If ``TUNEABI`` is undefined, then every tuning is allowed. See the
+ If :term:`TUNEABI` is undefined, then every tuning is allowed. See the
:ref:`sanity <ref-classes-sanity>` class to see how the variable is
used.
@@ -8187,7 +8240,7 @@
If set, the OpenEmbedded system ignores the
:term:`TUNEABI_WHITELIST` variable.
Providers that use prebuilt libraries can use the
- ``TUNEABI_OVERRIDE``, ``TUNEABI_WHITELIST``, and
+ :term:`TUNEABI_OVERRIDE`, :term:`TUNEABI_WHITELIST`, and
:term:`TUNEABI` variables to check compatibility of a
tuning against their selection of libraries.
@@ -8196,9 +8249,9 @@
:term:`TUNEABI_WHITELIST`
A whitelist of permissible :term:`TUNEABI` values. If
- ``TUNEABI_WHITELIST`` is not set, all tunes are allowed. Providers
- that use prebuilt libraries can use the ``TUNEABI_WHITELIST``,
- :term:`TUNEABI_OVERRIDE`, and ``TUNEABI``
+ :term:`TUNEABI_WHITELIST` is not set, all tunes are allowed. Providers
+ that use prebuilt libraries can use the :term:`TUNEABI_WHITELIST`,
+ :term:`TUNEABI_OVERRIDE`, and :term:`TUNEABI`
variables to check compatibility of a tuning against their selection
of libraries.
@@ -8243,35 +8296,35 @@
UBOOT_CONFIG[spinor] = "mx6qsabreauto_spinor_config"
In this example, "sd" is selected as the configuration of the possible four for the
- ``UBOOT_MACHINE``. The "sd" configuration defines
- "mx6qsabreauto_config" as the value for ``UBOOT_MACHINE``, while the
+ :term:`UBOOT_MACHINE`. The "sd" configuration defines
+ "mx6qsabreauto_config" as the value for :term:`UBOOT_MACHINE`, while the
"sdcard" specifies the ``IMAGE_FSTYPES`` to use for the U-Boot image.
- For more information on how the ``UBOOT_CONFIG`` is handled, see the
+ For more information on how the :term:`UBOOT_CONFIG` is handled, see the
:ref:`uboot-config <ref-classes-uboot-config>`
class.
:term:`UBOOT_DTB_LOADADDRESS`
Specifies the load address for the dtb image used by U-Boot. During FIT
- image creation, the ``UBOOT_DTB_LOADADDRESS`` variable is used in
+ image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in
:ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify
the load address to be used in
creating the dtb sections of Image Tree Source for the FIT image.
:term:`UBOOT_DTBO_LOADADDRESS`
Specifies the load address for the dtbo image used by U-Boot. During FIT
- image creation, the ``UBOOT_DTBO_LOADADDRESS`` variable is used in
+ image creation, the :term:`UBOOT_DTBO_LOADADDRESS` variable is used in
:ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the load address to be used in
creating the dtbo sections of Image Tree Source for the FIT image.
:term:`UBOOT_ENTRYPOINT`
Specifies the entry point for the U-Boot image. During U-Boot image
- creation, the ``UBOOT_ENTRYPOINT`` variable is passed as a
+ creation, the :term:`UBOOT_ENTRYPOINT` variable is passed as a
command-line parameter to the ``uboot-mkimage`` utility.
:term:`UBOOT_LOADADDRESS`
Specifies the load address for the U-Boot image. During U-Boot image
- creation, the ``UBOOT_LOADADDRESS`` variable is passed as a
+ creation, the :term:`UBOOT_LOADADDRESS` variable is passed as a
command-line parameter to the ``uboot-mkimage`` utility.
:term:`UBOOT_LOCALVERSION`
@@ -8322,7 +8375,7 @@
:term:`UBOOT_RD_ENTRYPOINT`
Specifies the entrypoint for the RAM disk image.
During FIT image creation, the
- ``UBOOT_RD_ENTRYPOINT`` variable is used
+ :term:`UBOOT_RD_ENTRYPOINT` variable is used
in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the
entrypoint to be used in creating the Image Tree Source for
the FIT image.
@@ -8330,7 +8383,7 @@
:term:`UBOOT_RD_LOADADDRESS`
Specifies the load address for the RAM disk image.
During FIT image creation, the
- ``UBOOT_RD_LOADADDRESS`` variable is used
+ :term:`UBOOT_RD_LOADADDRESS` variable is used
in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the
load address to be used in creating the Image Tree Source for
the FIT image.
@@ -8371,16 +8424,16 @@
However, there are common options that are passed to all
configure scripts at a class level, but might not be valid for some
configure scripts. Therefore warnings about these options are useless.
- For these cases, the options are added to ``UNKNOWN_CONFIGURE_WHITELIST``.
+ For these cases, the options are added to :term:`UNKNOWN_CONFIGURE_WHITELIST`.
The configure arguments check that uses
- ``UNKNOWN_CONFIGURE_WHITELIST`` is part of the
+ :term:`UNKNOWN_CONFIGURE_WHITELIST` is part of the
:ref:`insane <ref-classes-insane>` class and is only enabled if the
recipe inherits the :ref:`autotools <ref-classes-autotools>` class.
:term:`UPDATERCPN`
For recipes inheriting the
- :ref:`update-rc.d <ref-classes-update-rc.d>` class, ``UPDATERCPN``
+ :ref:`update-rc.d <ref-classes-update-rc.d>` class, :term:`UPDATERCPN`
specifies the package that contains the initscript that is enabled.
The default value is "${PN}". Given that almost all recipes that
@@ -8394,7 +8447,7 @@
OpenEmbedded build system determines the latest upstream version by
picking the latest tag from the list of all repository tags.
- You can use the ``UPSTREAM_CHECK_GITTAGREGEX`` variable to provide a
+ You can use the :term:`UPSTREAM_CHECK_GITTAGREGEX` variable to provide a
regular expression to filter only the relevant tags should the
default filter not work correctly.
::
@@ -8402,7 +8455,7 @@
UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex"
:term:`UPSTREAM_CHECK_REGEX`
- Use the ``UPSTREAM_CHECK_REGEX`` variable to specify a different
+ Use the :term:`UPSTREAM_CHECK_REGEX` variable to specify a different
regular expression instead of the default one when the package
checking system is parsing the page found using
:term:`UPSTREAM_CHECK_URI`.
@@ -8416,7 +8469,7 @@
the source code is provided from tarballs, the latest version is
determined by fetching the directory listing where the tarball is and
attempting to find a later tarball. When this approach does not work,
- you can use ``UPSTREAM_CHECK_URI`` to provide a different URI that
+ you can use :term:`UPSTREAM_CHECK_URI` to provide a different URI that
contains the link to the latest tarball.
::
@@ -8424,8 +8477,8 @@
:term:`USE_DEVFS`
Determines if ``devtmpfs`` is used for ``/dev`` population. The
- default value used for ``USE_DEVFS`` is "1" when no value is
- specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a
+ default value used for :term:`USE_DEVFS` is "1" when no value is
+ specifically set. Typically, you would set :term:`USE_DEVFS` to "0" for a
statically populated ``/dev`` directory.
See the ":ref:`dev-manual/common-tasks:selecting a device manager`" section in
@@ -8440,8 +8493,8 @@
virtual terminals in order to enable logging in through those
terminals.
- The default value used for ``USE_VT`` is "1" when no default value is
- specifically set. Typically, you would set ``USE_VT`` to "0" in the
+ The default value used for :term:`USE_VT` is "1" when no default value is
+ specifically set. Typically, you would set :term:`USE_VT` to "0" in the
machine configuration file for machines that do not have a graphical
display attached and therefore do not need virtual terminal
functionality.
@@ -8468,9 +8521,9 @@
The default behavior for the build system is to dynamically apply
``uid`` and ``gid`` values. Consequently, the
- ``USERADD_ERROR_DYNAMIC`` variable is by default not set. If you plan
+ :term:`USERADD_ERROR_DYNAMIC` variable is by default not set. If you plan
on using statically assigned ``gid`` and ``uid`` values, you should
- set the ``USERADD_ERROR_DYNAMIC`` variable in your ``local.conf``
+ set the :term:`USERADD_ERROR_DYNAMIC` variable in your ``local.conf``
file as follows::
USERADD_ERROR_DYNAMIC = "error"
@@ -8485,7 +8538,7 @@
.. note::
There is a difference in behavior between setting
- ``USERADD_ERROR_DYNAMIC`` to ``error`` and setting it to ``warn``.
+ :term:`USERADD_ERROR_DYNAMIC` to ``error`` and setting it to ``warn``.
When it is set to ``warn``, the build system will report a warning for
every undefined ``uid`` and ``gid`` in any recipe. But when it is set
to ``error``, it will only report errors for recipes that are actually
@@ -8524,7 +8577,7 @@
.. note::
- It follows that if you are going to use the ``USERADD_PACKAGES``
+ It follows that if you are going to use the :term:`USERADD_PACKAGES`
variable, you need to set one or more of the :term:`USERADD_PARAM`,
:term:`GROUPADD_PARAM`, or :term:`GROUPMEMS_PARAM` variables.
@@ -8587,7 +8640,7 @@
Specifies the persistence of the target's ``/var/log`` directory,
which is used to house postinstall target log files.
- By default, ``VOLATILE_LOG_DIR`` is set to "yes", which means the
+ By default, :term:`VOLATILE_LOG_DIR` is set to "yes", which means the
file is not persistent. You can override this setting by setting the
variable to "no" to make the log directory persistent.
@@ -8609,18 +8662,18 @@
:term:`WKS_FILE_DEPENDS`
When placed in the recipe that builds your image, this variable lists
- build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only
+ build-time dependencies. The :term:`WKS_FILE_DEPENDS` variable is only
applicable when Wic images are active (i.e. when
:term:`IMAGE_FSTYPES` contains entries related
to Wic). If your recipe does not create Wic images, the variable has
no effect.
- The ``WKS_FILE_DEPENDS`` variable is similar to the
+ The :term:`WKS_FILE_DEPENDS` variable is similar to the
:term:`DEPENDS` variable. When you use the variable in
your recipe that builds the Wic image, dependencies you list in the
- ``WKS_FILE_DEPENDS`` variable are added to the ``DEPENDS`` variable.
+ :term:`WKS_FILE_DEPENDS` variable are added to the :term:`DEPENDS` variable.
- With the ``WKS_FILE_DEPENDS`` variable, you have the possibility to
+ With the :term:`WKS_FILE_DEPENDS` variable, you have the possibility to
specify a list of additional dependencies (e.g. native tools,
bootloaders, and so forth), that are required to build Wic images.
Following is an example::
@@ -8637,7 +8690,7 @@
:term:`TMPDIR` directory structure and is specific to
the recipe being built and the system for which it is being built.
- The ``WORKDIR`` directory is defined as follows::
+ The :term:`WORKDIR` directory is defined as follows::
${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}
@@ -8667,6 +8720,6 @@
indirectly, includes "x11-base" in
:term:`IMAGE_FEATURES`.
- The default value of ``XSERVER``, if not specified in the machine
+ The default value of :term:`XSERVER`, if not specified in the machine
configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev".