summaryrefslogtreecommitdiff
path: root/poky/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
authorPatrick Williams <patrick@stwcx.xyz>2021-08-16 22:03:13 +0300
committerPatrick Williams <patrick@stwcx.xyz>2021-08-17 03:53:26 +0300
commit0ca19ccf045e022d8a24d26afbf346ab7f2f519f (patch)
tree2732b2bd7700fba730c034a547a2e0751696f2ce /poky/documentation/ref-manual/variables.rst
parent23ca3ffa9de533fecc0fcd48fea85e365c323370 (diff)
downloadopenbmc-0ca19ccf045e022d8a24d26afbf346ab7f2f519f.tar.xz
subtree updates
poky: 492205ea83..94dfcaff64: Alejandro Hernandez Samaniego (1): baremetal-helloworld: Enable RISC-V 32 port Alexandre Belloni (1): oeqa/runtime/cases: make date.DateTest.test_date more reliable Anton Blanchard (3): libjpeg-turbo: Handle powerpc64le without Altivec kmod: use nonarch_base_libdir for depmod.d and modprobe.d pixman: Handle PowerPC without Altivec Changqing Li (1): libconvert-asn1-perl: 0.27 -> 0.31 Chen Qi (4): convert-overrides.py: also convert comments without a leading whitespace meta: use new override syntax in comments multilib.bbclass: fix new override syntax for virtclass-multilib util-linux: add back manpages related settings Daniel Gomez (1): docs: fix typo in releases Dmitry Baryshkov (1): linux-firmware: add more Qualcomm firmware packages Dragos-Marian Panait (1): util-linux: fix CVE-2021-37600 Joe Slater (1): terminal.bbclass: force bash for devshell Jon Mason (1): tune-cortexm*: add support for all Arm Cortex-M processors Jose Quaresma (1): sstate.bbclass: fix error handling when sstate mirrors is ro Joshua Watt (2): classes/cve-check: Move get_patches_cves to library lib/packagedata: Fix for new overrides Khem Raj (4): glibc: Upgrade to 2.34 release glibc: Remove obsolete --enable-stackguard-randomization glibc: Drop DUMMY_LOCALE_T define patch glibc: Add missing symlinks for libpthread and librt dev files Michael Halstead (1): releases: update to include 3.1.10 Michael Opdenacker (12): manuals: mention license information in footer manuals: further documentation for cve-check cve-check: remove deprecated CVE_CHECK_CVE_WHITELIST bsp-guide: overrides syntax updates dev-manual: overrides syntax updates kernel-dev manual: overrides syntax updates ref-manual: overrides syntax updates sdk-manual: overrides syntax updates test-manual: overrides syntax updates sdk-manual: reference obsolete reference to ADT Manuals: replace "file name" by "filename" dev-manual: fix grammar in post-install script explanations Nisha Parrakat (1): dbus_%.bbappend: stop using selinux_set_mapping Olaf Mandel (1): kickstart: document which options accept units Patrick Williams (3): pixman: re-disable iwmmxt systemd: add zstd PACKAGECONFIG systemd: set zstd as default PACKAGECONFIG Paul Barker (2): u-boot: Package extlinux.conf separately pypi: Allow override of PyPI archive name Quentin Schulz (3): insane.bbclass: fix new override syntax migration docs: fix new override syntax migration docs: overview-manual: concepts: remove long-gone BBHASHDEPS variable Richard Purdie (6): test-manual: Add extra detail to YP Compatible section migration-3.4: Add extra notes to override syntax changes ruby: Fix DEBUG_PREFIX_MAP in LDFLAGS issue gettext: Fix reproducibility issue with LDFLAGS curl: Fix reproducibility issue with LDFLAGS libtool: Fix lto option passing for reproducible builds Ross Burton (11): e2fsprogs: ensure small images have 256-byte inodes wic: don't forcibly pass -T default parted: drop unneeded ld-is-gold patch parted: update patch status buildtools-tarball: add testsdk task oeqa/sdk: add some buildtools tests bitbake: utils: add environment updating context manager bitbake: fetch2: expose environment variable names that need to be exported bitbake: fetch2/wget: ensure all variables are set when calling urllib bitbake: fetch2/wget: fetch securely by default tar: ignore node-tar CVEs Thomas Perrot (2): kernel-fitimage: images should not be signed with the same keys as the configurations oeqa/selftest/fitimage: update tests to use two keys Tim Orling (3): python3-scons{-native}: upgrade 4.1.0 -> 4.2.0 perl: do_create_rdepends_inc override syntax package.bbclass: FILER* override syntax Tom Rini (2): common-tasks: Add a summary to the end of the bbappend example manuals: Rename the "Using .bbappend Files in Your Layer" section Tony Battersby (2): bitbake.conf: add DEBUG_PREFIX_MAP to TARGET_LDFLAGS ruby: Fix reproducibility issue with LDFLAGS Tony Tascioglu (1): valgrind: skip broken ptests for glibc 2.34 Vyacheslav Yurkov (7): lib/oe: add generic functions for overlayfs overlayfs.bbclass: generate overlayfs mount units rootfs-postcommands: add QA check for overlayfs systemd-machine-units: add bbappend for meta-selftest overlayfs: meta-selftest recipe oeqa/selftest: overlayfs unit tests MAINTAINERS: add overlayfs maintainer Yi Zhao (3): dbus: add PACKAGECONFIG for audit and selinux glib-2.0: add PACKAGECONFIG for selinux shadow: add PACKAGECONFIG for audit and selinux hongxu (1): sdk: fix relocate symlink failed wangmy (1): ell: upgrade 0.41 -> 0.42 meta-raspberrypi: c7f4c739a3..32921fc9bd: Omer Akram (1): linux-firmware-rpidistro: fix wifi driver loading on cm4 Otavio Salvador (1): rpi-config: Allow setting hdmi_cvt meta-openembedded: 3cf2475ea0..a13db91f19: Changqing Li (1): ndpi: fix CVE-2021-36082 Chen Qi (1): Convert to new override syntax using latest convert-overrides.py script Dmitry Baryshkov (1): image_types_sparse: fix sparse image generation Geoff Parker (1): cifs-utils: typo fix fakse --> false Kai Kang (2): libdbi-perl: fix CVE-2014-10402 python3-m2crypto: fix for new overrides syntax Khem Raj (1): packagegroup-meta-oe: Add ttf-ipa Leon Anavi (15): python3-astroid: Upgrade 2.6.5 -> 2.6.6 python3-gast: Upgrade 0.5.1 -> 0.5.2 python3-greenlet: Upgrade 1.1.0 -> 1.1.1 python3-bitarray: Upgrade 2.2.3 -> 2.2.5 python3-send2trash: Upgrade 1.7.1 -> 1.8.0 python3-zeroconf: Upgrade 0.33.2 -> 0.34.3 python3-aiohue: Upgrade 2.5.1 -> 2.6.1 python3-configargparse: Upgrade 1.5.1 -> 1.5.2 python3-pycurl: Upgrade 7.43.0.6 -> 7.44.0 python3-distro: Upgrade 1.5.0 -> 1.6.0 python3-google-api-core: Upgrade 1.30.0 -> 1.31.1 python3-google-auth: Upgrade 1.32.0 -> 1.34.0 python3-google-api-python-client: Upgrade 2.12.0 -> 2.15.0 python3-huey: Upgrade 2.3.2 -> 2.4.0 python3-apply-defaults: Upgrade 0.1.4 -> 0.1.6 Martin Jansa (1): python3-grpcio: make sure that GRPC_CFLAGS is expanded to empty Michael Opdenacker (3): vorbis-tools: update to 1.4.2 (latest in 1.4.x series) bigbuckbunny-1080p: fix sample video URL opus-tools: update to 0.2, move to meta-multimedia and fix license Mingli Yu (3): jemalloc: fix the race during do_install jemalloc: add ptest support jemalloc: improve the ptest output Naveen Saini (1): python3-defusedxml: extend recipe to add native support Philippe Coval (1): mycroft: Install more tools needed by scripts Tony Battersby (3): curlpp: fix QA Issue after LDFLAGS change ldns: fix QA Issue after LDFLAGS change tcsh: fix compile error after LDFLAGS change Yi Zhao (5): audit: upgrade 3.0.3 -> 3.0.4 augeas: rename PACKAGECONFIG[libselinux] to PACKAGECONFIG[selinux] network-manager-applet: add selinux to PACKAGECONFIG if enable selinux distro feature networkmanager: add PACKAGECONFIG for audit and selinux augeas: add selinux to PACKAGECONFIG if enable selinux distro feature leimaohui (1): ttf-ipa: Added a new font. wangmy (1): iwd: upgrade 1.15 -> 1.16 zangrc (1): python3-humanize: upgrade 3.10.0 -> 3.11.0 zhengruoqin (3): python3-engineio: upgrade 4.2.0 -> 4.2.1 python3-ipython: upgrade 7.25.0 -> 7.26.0 python3-isort: upgrade 5.9.2 -> 5.9.3 Signed-off-by: Patrick Williams <patrick@stwcx.xyz> Change-Id: I7a8bd19709f465db51254ed3fcaf2486fe64dcaf
Diffstat (limited to 'poky/documentation/ref-manual/variables.rst')
-rw-r--r--poky/documentation/ref-manual/variables.rst195
1 files changed, 103 insertions, 92 deletions
diff --git a/poky/documentation/ref-manual/variables.rst b/poky/documentation/ref-manual/variables.rst
index 115094013..7aecda017 100644
--- a/poky/documentation/ref-manual/variables.rst
+++ b/poky/documentation/ref-manual/variables.rst
@@ -38,9 +38,9 @@ system and gives an overview of their function and contents.
Like all package-controlling variables, you must always use them in
conjunction with a package name override, as in::
- ALLOW_EMPTY_${PN} = "1"
- ALLOW_EMPTY_${PN}-dev = "1"
- ALLOW_EMPTY_${PN}-staticdev = "1"
+ ALLOW_EMPTY:${PN} = "1"
+ ALLOW_EMPTY:${PN}-dev = "1"
+ ALLOW_EMPTY:${PN}-staticdev = "1"
:term:`ALTERNATIVE`
Lists commands in a package that need an alternative binary naming
@@ -53,7 +53,7 @@ system and gives an overview of their function and contents.
provided by another package. For example, if the ``busybox`` package
has four such commands, you identify them as follows::
- ALTERNATIVE_busybox = "sh sed test bracket"
+ ALTERNATIVE:busybox = "sh sed test bracket"
For more information on the alternatives system, see the
":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
@@ -297,7 +297,7 @@ system and gives an overview of their function and contents.
can attach it to a specific image recipe by using the recipe name
override::
- BAD_RECOMMENDATIONS_pn-target_image = "package_name"
+ BAD_RECOMMENDATIONS:pn-target_image = "package_name"
It is important to realize that if you choose to not install packages
using this variable and some other packages are dependent on them
@@ -575,7 +575,7 @@ system and gives an overview of their function and contents.
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
+ as ``:class-native``. For example, to generate a native version of
a recipe, a :term:`DEPENDS` on "foo" is rewritten
to a :term:`DEPENDS` on "foo-native".
@@ -1133,7 +1133,7 @@ system and gives an overview of their function and contents.
As an example, the following override allows you to install extra
files, but only when building for the target::
- do_install_append_class-target() {
+ do_install:append:class-target() {
install my-extra-file ${D}${sysconfdir}
}
@@ -1141,7 +1141,7 @@ system and gives an overview of their function and contents.
"native" when building for the build host, and to "other" when not
building for the build host::
- FOO_class-native = "native"
+ FOO:class-native = "native"
FOO = "other"
The underlying mechanism behind :term:`CLASSOVERRIDE` is simply
@@ -1246,7 +1246,7 @@ system and gives an overview of their function and contents.
that identifies the resulting package. Then, provide a
space-separated list of files. Here is an example::
- CONFFILES_${PN} += "${sysconfdir}/file1 \
+ CONFFILES:${PN} += "${sysconfdir}/file1 \
${sysconfdir}/file2 ${sysconfdir}/file3"
There is a relationship between the :term:`CONFFILES` and :term:`FILES`
@@ -1471,11 +1471,22 @@ system and gives an overview of their function and contents.
variable only in certain contexts (e.g. when building for kernel
and kernel module recipes).
+ :term:`CVE_CHECK_PN_WHITELIST`
+ The list of package names (:term:`PN`) for which
+ CVEs (Common Vulnerabilities and Exposures) are ignored.
+
+ :term:`CVE_CHECK_WHITELIST`
+ The list of CVE IDs which are ignored. Here is
+ an example from the :oe_layerindex:`Python3 recipe</layerindex/recipe/23823>`::
+
+ # This is windows only issue.
+ CVE_CHECK_WHITELIST += "CVE-2020-15523"
+
:term:`CVE_PRODUCT`
In a recipe, defines the name used to match the recipe name
against the name in the upstream `NIST CVE database <https://nvd.nist.gov/>`__.
- The default is ${:term:`BPN`}. If it does not match the name in NIST CVE
+ The default is ${:term:`BPN`}. If it does not match the name in the NIST CVE
database or matches with multiple entries in the database, the default
value needs to be changed.
@@ -1535,7 +1546,7 @@ system and gives an overview of their function and contents.
package naming. You must use the package name as an override when you
set this variable. Here is an example from the ``fontconfig`` recipe::
- DEBIAN_NOAUTONAME_fontconfig-utils = "1"
+ DEBIAN_NOAUTONAME:fontconfig-utils = "1"
:term:`DEBIANNAME`
When the :ref:`debian <ref-classes-debian>` class is inherited,
@@ -1545,7 +1556,7 @@ system and gives an overview of their function and contents.
override when you set this variable. Here is an example from the
``dbus`` recipe::
- DEBIANNAME_${PN} = "dbus-1"
+ DEBIANNAME:${PN} = "dbus-1"
:term:`DEBUG_BUILD`
Specifies to build packages with debugging information. This
@@ -2104,7 +2115,7 @@ system and gives an overview of their function and contents.
to fix a runtime dependency to the exact same version of another
package in the same recipe::
- RDEPENDS_${PN}-additional-module = "${PN} (= ${EXTENDPKGV})"
+ RDEPENDS:${PN}-additional-module = "${PN} (= ${EXTENDPKGV})"
The dependency relationships are intended to force the package
manager to upgrade these types of packages in lock-step.
@@ -2204,7 +2215,7 @@ system and gives an overview of their function and contents.
this variable, use an override for the associated image type. Here is
an example::
- EXTRA_IMAGECMD_ext3 ?= "-i 4096"
+ EXTRA_IMAGECMD:ext3 ?= "-i 4096"
:term:`EXTRA_IMAGEDEPENDS`
A list of recipes to build that do not provide packages for
@@ -2331,7 +2342,7 @@ system and gives an overview of their function and contents.
list of files or paths that identify the files you want included as
part of the resulting package. Here is an example::
- FILES_${PN} += "${bindir}/mydir1 ${bindir}/mydir2/myfile"
+ FILES:${PN} += "${bindir}/mydir1 ${bindir}/mydir2/myfile"
.. note::
@@ -2347,7 +2358,7 @@ system and gives an overview of their function and contents.
rather than ``/usr/bin``. You can find a list of these
variables at the top of the ``meta/conf/bitbake.conf`` file in
the :term:`Source Directory`. You will also
- find the default values of the various ``FILES_*`` variables in
+ find the default values of the various ``FILES:*`` variables in
this file.
If some of the files you provide with the :term:`FILES` variable are
@@ -2380,7 +2391,7 @@ system and gives an overview of their function and contents.
:term:`FILESEXTRAPATHS` from within a ``.bbappend`` file and that you
prepend paths as follows::
- FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
+ FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:"
In the above example, the build system first
looks for files in a directory that has the same name as the
@@ -2402,7 +2413,7 @@ system and gives an overview of their function and contents.
Here is another common use::
- FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
+ FILESEXTRAPATHS:prepend := "${THISDIR}/files:"
In this example, the build system extends the
:term:`FILESPATH` variable to include a directory named ``files`` that is
@@ -2410,13 +2421,13 @@ system and gives an overview of their function and contents.
This next example specifically adds three paths::
- FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:"
+ FILESEXTRAPATHS:prepend := "path_1:path_2:path_3:"
A final example shows how you can extend the search path and include
a :term:`MACHINE`-specific override, which is useful
in a BSP layer::
- FILESEXTRAPATHS_prepend_intel-x86-common := "${THISDIR}/${PN}:"
+ FILESEXTRAPATHS:prepend:intel-x86-common := "${THISDIR}/${PN}:"
The previous statement appears in the
``linux-yocto-dev.bbappend`` file, which is found in the
@@ -2664,7 +2675,7 @@ system and gives an overview of their function and contents.
Here is an example from the ``dbus`` recipe::
- GROUPADD_PARAM_${PN} = "-r netdev"
+ GROUPADD_PARAM:${PN} = "-r netdev"
For information on the standard Linux shell command
``groupadd``, see https://linux.die.net/man/8/groupadd.
@@ -2977,7 +2988,7 @@ system and gives an overview of their function and contents.
``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 \
+ IMAGE_CMD:jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} --faketime \
--output=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.jffs2 \
${EXTRA_IMAGECMD}"
@@ -3033,8 +3044,8 @@ system and gives an overview of their function and contents.
:term:`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
+ variable, you cannot update its contents by using ``:append``
+ or ``:prepend``. You must use the ``+=`` operator to add one or
more options to the :term:`IMAGE_FSTYPES` variable.
:term:`IMAGE_INSTALL`
@@ -3052,7 +3063,7 @@ system and gives an overview of their function and contents.
When you use this variable, it is best to use it as follows::
- IMAGE_INSTALL_append = " package-name"
+ IMAGE_INSTALL:append = " package-name"
Be sure to include the space
between the quotation character and the start of the package name or
@@ -3144,7 +3155,7 @@ system and gives an overview of their function and contents.
IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
:term:`IMAGE_NAME_SUFFIX`
- Suffix used for the image output file name - defaults to ``".rootfs"``
+ Suffix used for the image output filename - defaults to ``".rootfs"``
to distinguish the image file from other files created during image
building; however if this suffix is redundant or not desired you can
clear the value of this variable (set the value to ""). For example,
@@ -3292,7 +3303,7 @@ system and gives an overview of their function and contents.
Specifies a dependency from one image type on another. Here is an
example from the :ref:`image-live <ref-classes-image-live>` class::
- IMAGE_TYPEDEP_live = "ext3"
+ IMAGE_TYPEDEP:live = "ext3"
In the previous example, the variable ensures that when "live" is
listed with the :term:`IMAGE_FSTYPES` variable,
@@ -3695,7 +3706,7 @@ system and gives an overview of their function and contents.
recipe. The package name override must be used, which in this example
is ``${PN}``::
- INSANE_SKIP_${PN} += "dev-so"
+ INSANE_SKIP:${PN} += "dev-so"
See the ":ref:`insane.bbclass <ref-classes-insane>`" section for a
list of the valid QA checks you can specify using this variable.
@@ -3749,10 +3760,10 @@ system and gives an overview of their function and contents.
``meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.12.bbappend``.
Here are the related statements from that append file::
- KBRANCH_genericx86 = "standard/base"
- KBRANCH_genericx86-64 = "standard/base"
- KBRANCH_edgerouter = "standard/edgerouter"
- KBRANCH_beaglebone = "standard/beaglebone"
+ KBRANCH:genericx86 = "standard/base"
+ KBRANCH:genericx86-64 = "standard/base"
+ KBRANCH:edgerouter = "standard/edgerouter"
+ KBRANCH:beaglebone = "standard/beaglebone"
The :term:`KBRANCH` statements
identify the kernel branch to use when building for each supported
@@ -3780,11 +3791,11 @@ system and gives an overview of their function and contents.
Here is an example from a "raspberrypi2" :term:`KMACHINE` build that uses
a ``defconfig`` file named "bcm2709_defconfig"::
- KBUILD_DEFCONFIG_raspberrypi2 = "bcm2709_defconfig"
+ KBUILD_DEFCONFIG:raspberrypi2 = "bcm2709_defconfig"
As an alternative, you can use the following within your append file::
- KBUILD_DEFCONFIG_pn-linux-yocto ?= defconfig_file
+ KBUILD_DEFCONFIG:pn-linux-yocto ?= "defconfig_file"
For more
information on how to use the :term:`KBUILD_DEFCONFIG` variable, see the
@@ -3932,10 +3943,10 @@ system and gives an overview of their function and contents.
statements add specific configurations to targeted machine types::
KERNEL_EXTRA_FEATURES ?= "features/netfilter/netfilter.scc features/taskstats/taskstats.scc"
- KERNEL_FEATURES_append = "${KERNEL_EXTRA_FEATURES}"
- KERNEL_FEATURES_append_qemuall = "cfg/virtio.scc"
- KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc"
- KERNEL_FEATURES_append_qemux86-64 = "cfg/sound.scc"
+ KERNEL_FEATURES:append = "${KERNEL_EXTRA_FEATURES}"
+ KERNEL_FEATURES:append:qemuall = "cfg/virtio.scc"
+ KERNEL_FEATURES:append:qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc"
+ KERNEL_FEATURES:append:qemux86-64 = "cfg/sound.scc"
:term:`KERNEL_FIT_LINK_NAME`
The link name of the kernel flattened image tree (FIT) image. This
@@ -4117,13 +4128,13 @@ system and gives an overview of their function and contents.
Kernel's ``meta`` branch. As an example take a look in the
``common/recipes-kernel/linux/linux-yocto_3.19.bbappend`` file::
- LINUX_VERSION_core2-32-intel-common = "3.19.0"
- COMPATIBLE_MACHINE_core2-32-intel-common = "${MACHINE}"
- SRCREV_meta_core2-32-intel-common = "8897ef68b30e7426bc1d39895e71fb155d694974"
- SRCREV_machine_core2-32-intel-common = "43b9eced9ba8a57add36af07736344dcc383f711"
- KMACHINE_core2-32-intel-common = "intel-core2-32"
- KBRANCH_core2-32-intel-common = "standard/base"
- KERNEL_FEATURES_append_core2-32-intel-common = "${KERNEL_FEATURES_INTEL_COMMON}"
+ LINUX_VERSION:core2-32-intel-common = "3.19.0"
+ COMPATIBLE_MACHINE:core2-32-intel-common = "${MACHINE}"
+ SRCREV_meta:core2-32-intel-common = "8897ef68b30e7426bc1d39895e71fb155d694974"
+ SRCREV_machine:core2-32-intel-common = "43b9eced9ba8a57add36af07736344dcc383f711"
+ KMACHINE:core2-32-intel-common = "intel-core2-32"
+ KBRANCH:core2-32-intel-common = "standard/base"
+ KERNEL_FEATURES:append:core2-32-intel-common = "${KERNEL_FEATURES_INTEL_COMMON}"
The :term:`KMACHINE` statement says
that the kernel understands the machine name as "intel-core2-32".
@@ -4303,15 +4314,15 @@ system and gives an overview of their function and contents.
Documentation License 1.2 could be specified as follows::
LICENSE = "GFDL-1.2 & GPLv2"
- LICENSE_${PN} = "GPLv2"
- LICENSE_${PN}-doc = "GFDL-1.2"
+ LICENSE:${PN} = "GPLv2"
+ LICENSE:${PN}-doc = "GFDL-1.2"
:term:`LICENSE_CREATE_PACKAGE`
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
- :term:`RRECOMMENDS`\ ``_${PN}``.
+ :term:`RRECOMMENDS`\ ``:${PN}``.
The ``${PN}-lic`` package installs a directory in
``/usr/share/licenses`` named ``${PN}``, which is the recipe's base
@@ -4615,7 +4626,7 @@ system and gives an overview of their function and contents.
in QEMU, like in the following example from the ``connman-conf``
recipe::
- SRC_URI_append_qemuall = " file://wired.config \
+ SRC_URI:append:qemuall = " file://wired.config \
file://wired-setup \
"
@@ -4818,7 +4829,7 @@ system and gives an overview of their function and contents.
can attach it to a specific image recipe by using the recipe name
override::
- NO_RECOMMENDATIONS_pn-target_image = "1"
+ NO_RECOMMENDATIONS:pn-target_image = "1"
It is important to realize that if you choose to not install packages
using this variable and some other packages are dependent on them
@@ -4841,14 +4852,14 @@ system and gives an overview of their function and contents.
:term:`NOAUTOPACKAGEDEBUG`
Disables auto package from splitting ``.debug`` files. If a recipe
- requires ``FILES_${PN}-dbg`` to be set manually, the
+ requires ``FILES:${PN}-dbg`` to be set manually, the
:term:`NOAUTOPACKAGEDEBUG` can be defined allowing you to define the
content of the debug package. For example::
NOAUTOPACKAGEDEBUG = "1"
- FILES_${PN}-dev = "${includedir}/${QT_DIR_NAME}/Qt/*"
- FILES_${PN}-dbg = "/usr/src/debug/"
- FILES_${QT_BASE_NAME}-demos-doc = "${docdir}/${QT_DIR_NAME}/qch/qt.qch"
+ FILES:${PN}-dev = "${includedir}/${QT_DIR_NAME}/Qt/*"
+ 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
@@ -4944,7 +4955,7 @@ system and gives an overview of their function and contents.
assignment will override ``FOO`` with the value "overridden" at the
end of parsing::
- FOO_an-override = "overridden"
+ FOO:an-override = "overridden"
See the
":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
@@ -4959,7 +4970,7 @@ system and gives an overview of their function and contents.
allows variables to be set for a single recipe within configuration
(``.conf``) files. Here is an example::
- FOO_pn-myrecipe = "myrecipe-specific value"
+ FOO:pn-myrecipe = "myrecipe-specific value"
.. note::
@@ -5107,7 +5118,7 @@ system and gives an overview of their function and contents.
can attach it to a specific image recipe by using the recipe name
override::
- PACKAGE_EXCLUDE_pn-target_image = "package_name"
+ PACKAGE_EXCLUDE:pn-target_image = "package_name"
If you choose to not install a package using this variable and some
other package is dependent on it (i.e. listed in a recipe's
@@ -5344,18 +5355,18 @@ system and gives an overview of their function and contents.
Or, you can just append the variable::
- PACKAGECONFIG_append = " f4"
+ PACKAGECONFIG:append = " f4"
- *Configuration file:* This method is identical to changing the
block through an append file except you edit your ``local.conf``
or ``mydistro.conf`` file. As with append files previously
described, you can either completely override the variable::
- PACKAGECONFIG_pn-recipename = "f4 f5"
+ PACKAGECONFIG:pn-recipename = "f4 f5"
Or, you can just amend the variable::
- PACKAGECONFIG_append_pn-recipename = " f4"
+ PACKAGECONFIG:append:pn-recipename = " f4"
:term:`PACKAGECONFIG_CONFARGS`
A space-separated list of configuration options generated from the
@@ -5390,7 +5401,7 @@ system and gives an overview of their function and contents.
(leftmost) package.
Packages in the variable's list that are empty (i.e. where none of
- the patterns in ``FILES_``\ pkg match any files installed by the
+ the patterns in ``FILES:``\ pkg match any files installed by the
:ref:`ref-tasks-install` task) are not generated,
unless generation is forced through the
:term:`ALLOW_EMPTY` variable.
@@ -5541,7 +5552,7 @@ system and gives an overview of their function and contents.
For example, when the :ref:`debian <ref-classes-debian>` class
renames the output package, it does so by setting
- ``PKG_packagename``.
+ ``PKG:packagename``.
:term:`PKG_CONFIG_PATH`
The path to ``pkg-config`` files for the current build context.
@@ -5775,17 +5786,17 @@ system and gives an overview of their function and contents.
:term:`OVERRIDES` to set a machine-specific
override. Here is an example::
- PREFERRED_VERSION_linux-yocto_qemux86 = "5.0%"
+ PREFERRED_VERSION_linux-yocto:qemux86 = "5.0%"
Although not recommended, worst case, you can also use the
"forcevariable" override, which is the strongest override possible.
Here is an example::
- PREFERRED_VERSION_linux-yocto_forcevariable = "5.0%"
+ PREFERRED_VERSION_linux-yocto:forcevariable = "5.0%"
.. note::
- The ``\_forcevariable`` override is not handled specially. This override
+ The ``:forcevariable`` override is not handled specially. This override
only works because the default value of :term:`OVERRIDES` includes "forcevariable".
If a recipe with the specified version is not available, a warning
@@ -5809,7 +5820,7 @@ system and gives an overview of their function and contents.
the ``local.conf`` configuration file in the
:term:`Build Directory`::
- PREMIRRORS_prepend = "\
+ PREMIRRORS:prepend = "\
git://.*/.* http://www.yoctoproject.org/sources/ \n \
ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
http://.*/.* http://www.yoctoproject.org/sources/ \n \
@@ -5992,7 +6003,7 @@ system and gives an overview of their function and contents.
Like all package-controlling variables, you must always use them in
conjunction with a package name override. Here is an example::
- RCONFLICTS_${PN} = "another_conflicting_package_name"
+ RCONFLICTS:${PN} = "another_conflicting_package_name"
BitBake, which the OpenEmbedded build system uses, supports
specifying versioned dependencies. Although the syntax varies
@@ -6000,7 +6011,7 @@ system and gives an overview of their function and contents.
from you. Here is the general syntax to specify versions with the
:term:`RCONFLICTS` variable::
- RCONFLICTS_${PN} = "package (operator version)"
+ RCONFLICTS:${PN} = "package (operator version)"
For ``operator``, you can specify the following:
@@ -6013,7 +6024,7 @@ system and gives an overview of their function and contents.
For example, the following sets up a dependency on version 1.2 or
greater of the package ``foo``::
- RCONFLICTS_${PN} = "foo (>= 1.2)"
+ RCONFLICTS:${PN} = "foo (>= 1.2)"
:term:`RDEPENDS`
Lists runtime dependencies of a package. These dependencies are other
@@ -6022,7 +6033,7 @@ system and gives an overview of their function and contents.
package ``foo`` needs the packages ``bar`` and ``baz`` to be
installed::
- RDEPENDS_foo = "bar baz"
+ RDEPENDS:foo = "bar baz"
The most common types of package
runtime dependencies are automatically detected and added. Therefore,
@@ -6063,7 +6074,7 @@ system and gives an overview of their function and contents.
on the ``perl`` package. In this case, you would use the following
:term:`RDEPENDS` statement::
- RDEPENDS_${PN}-dev += "perl"
+ RDEPENDS:${PN}-dev += "perl"
In the example,
the development package depends on the ``perl`` package. Thus, the
@@ -6072,10 +6083,10 @@ system and gives an overview of their function and contents.
.. note::
- ``RDEPENDS_${PN}-dev`` includes ``${``\ :term:`PN`\ ``}``
+ ``RDEPENDS:${PN}-dev`` includes ``${``\ :term:`PN`\ ``}``
by default. This default is set in the BitBake configuration file
(``meta/conf/bitbake.conf``). Be careful not to accidentally remove
- ``${PN}`` when modifying ``RDEPENDS_${PN}-dev``. Use the "+=" operator
+ ``${PN}`` when modifying ``RDEPENDS:${PN}-dev``. Use the "+=" operator
rather than the "=" operator.
The package names you use with :term:`RDEPENDS` must appear as they would
@@ -6092,7 +6103,7 @@ system and gives an overview of their function and contents.
from you. Here is the general syntax to specify versions with the
:term:`RDEPENDS` variable::
- RDEPENDS_${PN} = "package (operator version)"
+ RDEPENDS:${PN} = "package (operator version)"
For ``operator``, you can specify the following:
@@ -6112,7 +6123,7 @@ system and gives an overview of their function and contents.
For example, the following sets up a dependency on version 1.2 or
greater of the package ``foo``::
- RDEPENDS_${PN} = "foo (>= 1.2)"
+ RDEPENDS:${PN} = "foo (>= 1.2)"
For information on build-time dependencies, see the
:term:`DEPENDS` variable. You can also see the
@@ -6247,7 +6258,7 @@ system and gives an overview of their function and contents.
variable in conjunction with a package name override. Here is an
example::
- RPROVIDES_${PN} = "widget-abi-2"
+ RPROVIDES:${PN} = "widget-abi-2"
:term:`RRECOMMENDS`
A list of packages that extends the usability of a package being
@@ -6278,7 +6289,7 @@ system and gives an overview of their function and contents.
support wireless functionality. In this case, you would use the
following::
- RRECOMMENDS_${PN}-dev += "wireless_package_name"
+ RRECOMMENDS:${PN}-dev += "wireless_package_name"
In the
example, the package name (``${PN}-dev``) must appear as it would in
@@ -6291,7 +6302,7 @@ system and gives an overview of their function and contents.
Here is the general syntax to specify versions with the
:term:`RRECOMMENDS` variable::
- RRECOMMENDS_${PN} = "package (operator version)"
+ RRECOMMENDS:${PN} = "package (operator version)"
For ``operator``, you can specify the following:
@@ -6304,7 +6315,7 @@ system and gives an overview of their function and contents.
For example, the following sets up a recommend on version 1.2 or
greater of the package ``foo``::
- RRECOMMENDS_${PN} = "foo (>= 1.2)"
+ RRECOMMENDS:${PN} = "foo (>= 1.2)"
:term:`RREPLACES`
A list of packages replaced by a package. The package manager uses
@@ -6316,7 +6327,7 @@ system and gives an overview of their function and contents.
As with all package-controlling variables, you must use this variable
in conjunction with a package name override. Here is an example::
- RREPLACES_${PN} = "other_package_being_replaced"
+ RREPLACES:${PN} = "other_package_being_replaced"
BitBake, which the OpenEmbedded build system uses, supports
specifying versioned replacements. Although the syntax varies
@@ -6324,7 +6335,7 @@ system and gives an overview of their function and contents.
from you. Here is the general syntax to specify versions with the
:term:`RREPLACES` variable::
- RREPLACES_${PN} = "package (operator version)"
+ RREPLACES:${PN} = "package (operator version)"
For ``operator``, you can specify the following:
@@ -6337,7 +6348,7 @@ system and gives an overview of their function and contents.
For example, the following sets up a replacement using version 1.2
or greater of the package ``foo``::
- RREPLACES_${PN} = "foo (>= 1.2)"
+ RREPLACES:${PN} = "foo (>= 1.2)"
:term:`RSUGGESTS`
A list of additional packages that you can suggest for installation
@@ -6348,7 +6359,7 @@ system and gives an overview of their function and contents.
variable in conjunction with a package name override. Here is an
example::
- RSUGGESTS_${PN} = "useful_package another_package"
+ RSUGGESTS:${PN} = "useful_package another_package"
:term:`S`
The location in the :term:`Build Directory` where
@@ -6862,7 +6873,7 @@ system and gives an overview of their function and contents.
defined in the ``meta/conf/bitbake.conf`` configuration file.
You will see this variable referenced in the default values of
- ``FILES_${PN}``.
+ ``FILES:${PN}``.
:term:`SOLIBSDEV`
Defines the suffix for the development symbolic link (symlink) for
@@ -6871,7 +6882,7 @@ system and gives an overview of their function and contents.
``meta/conf/bitbake.conf`` configuration file.
You will see this variable referenced in the default values of
- ``FILES_${PN}-dev``.
+ ``FILES:${PN}-dev``.
:term:`SOURCE_MIRROR_FETCH`
When you are fetching files to create a mirror of sources (i.e.
@@ -7609,7 +7620,7 @@ system and gives an overview of their function and contents.
override to indicate the package to which the value applies. Here is
an example from the connman recipe::
- SYSTEMD_SERVICE_${PN} = "connman.service"
+ SYSTEMD_SERVICE:${PN} = "connman.service"
:term:`SYSVINIT_ENABLED_GETTYS`
When using
@@ -7947,14 +7958,14 @@ system and gives an overview of their function and contents.
your own tests to the list of tests by appending :term:`TEST_SUITES` as
follows::
- TEST_SUITES_append = " mytest"
+ TEST_SUITES:append = " mytest"
Alternatively, you can
provide the "auto" option to have all applicable tests run against
the image.
::
- TEST_SUITES_append = " auto"
+ TEST_SUITES:append = " auto"
Using this option causes the
build system to automatically run tests that are applicable to the
@@ -8215,7 +8226,7 @@ system and gives an overview of their function and contents.
The BitBake configuration file (``meta/conf/bitbake.conf``) defines
:term:`TUNE_FEATURES` as follows::
- TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}"
+ TUNE_FEATURES ??= "${TUNE_FEATURES:tune-${DEFAULTTUNE}}"
See the :term:`DEFAULTTUNE` variable for more information.
@@ -8241,13 +8252,13 @@ system and gives an overview of their function and contents.
the architecture, ABI, and tuning of output packages. The specific
tune is defined using the "_tune" override as follows::
- TUNE_PKGARCH_tune-tune = "tune"
+ TUNE_PKGARCH:tune-tune = "tune"
These tune-specific package architectures are defined in the machine
include files. Here is an example of the "core2-32" tuning as used in
the ``meta/conf/machine/include/tune-core2.inc`` file::
- TUNE_PKGARCH_tune-core2-32 = "core2-32"
+ TUNE_PKGARCH:tune-core2-32 = "core2-32"
:term:`TUNEABI`
An underlying Application Binary Interface (ABI) used by a particular
@@ -8614,7 +8625,7 @@ system and gives an overview of their function and contents.
Here is an example from the ``dbus`` recipe::
- USERADD_PARAM_${PN} = "--system --home ${localstatedir}/lib/dbus \
+ USERADD_PARAM:${PN} = "--system --home ${localstatedir}/lib/dbus \
--no-create-home --shell /bin/false \
--user-group messagebus"