summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-08-04 20:20:03 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-08-14 12:04:23 +0100
commit956056e647e21a644908d761f072a00ea42a94f9 (patch)
tree338dfa8d0fb92bc6acac3724d423be1f1611b161 /documentation
parent80859f21b5ceea8efdc09d0f0de24cc70a749d48 (diff)
downloadpoky-956056e647e21a644908d761f072a00ea42a94f9.tar.gz
ref-manual: overrides syntax updates
Updated with openembedded-core/scripts/contrib/convert-overrides.py (From yocto-docs rev: 23ee6fbdf429d4cf1de4129e92dc7de4e6e9d184) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/classes.rst14
-rw-r--r--documentation/ref-manual/faq.rst4
-rw-r--r--documentation/ref-manual/qa-checks.rst4
-rw-r--r--documentation/ref-manual/variables.rst134
4 files changed, 78 insertions, 78 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index a98a64c432..610d64bd46 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -472,8 +472,8 @@ recipe that fetches from an alternative URI (e.g. Git) instead of a
472tarball. Following is an example:: 472tarball. Following is an example::
473 473
474 BBCLASSEXTEND = "devupstream:target" 474 BBCLASSEXTEND = "devupstream:target"
475 SRC_URI_class-devupstream = "git://git.example.com/example" 475 SRC_URI:class-devupstream = "git://git.example.com/example"
476 SRCREV_class-devupstream = "abcd1234" 476 SRCREV:class-devupstream = "abcd1234"
477 477
478Adding the above statements to your recipe creates a variant that has 478Adding the above statements to your recipe creates a variant that has
479:term:`DEFAULT_PREFERENCE` set to "-1". 479:term:`DEFAULT_PREFERENCE` set to "-1".
@@ -481,8 +481,8 @@ Consequently, you need to select the variant of the recipe to use it.
481Any development-specific adjustments can be done by using the 481Any development-specific adjustments can be done by using the
482``class-devupstream`` override. Here is an example:: 482``class-devupstream`` override. Here is an example::
483 483
484 DEPENDS_append_class-devupstream = " gperf-native" 484 DEPENDS:append:class-devupstream = " gperf-native"
485 do_configure_prepend_class-devupstream() { 485 do_configure:prepend:class-devupstream() {
486 touch ${S}/README 486 touch ${S}/README
487 } 487 }
488 488
@@ -862,7 +862,7 @@ sure that all builders start with the same sstate signatures. After
862inheriting the class, you can then disable the feature by setting the 862inheriting the class, you can then disable the feature by setting the
863:term:`ICECC_DISABLED` variable to "1" as follows:: 863:term:`ICECC_DISABLED` variable to "1" as follows::
864 864
865 INHERIT_DISTRO_append = " icecc" 865 INHERIT_DISTRO:append = " icecc"
866 ICECC_DISABLED ??= "1" 866 ICECC_DISABLED ??= "1"
867 867
868This practice 868This practice
@@ -990,7 +990,7 @@ the check for symbolic link ``.so`` files in the main package of a
990recipe, add the following to the recipe. You need to realize that the 990recipe, add the following to the recipe. You need to realize that the
991package name override, in this example ``${PN}``, must be used:: 991package name override, in this example ``${PN}``, must be used::
992 992
993 INSANE_SKIP_${PN} += "dev-so" 993 INSANE_SKIP:${PN} += "dev-so"
994 994
995Please keep in mind that the QA checks 995Please keep in mind that the QA checks
996are meant to detect real or potential problems in the packaged 996are meant to detect real or potential problems in the packaged
@@ -2497,7 +2497,7 @@ indicate the package to which the value applies. If the value applies to
2497the recipe's main package, use ``${``\ :term:`PN`\ ``}``. Here 2497the recipe's main package, use ``${``\ :term:`PN`\ ``}``. Here
2498is an example from the connman recipe:: 2498is an example from the connman recipe::
2499 2499
2500 SYSTEMD_SERVICE_${PN} = "connman.service" 2500 SYSTEMD_SERVICE:${PN} = "connman.service"
2501 2501
2502Services are set up to start on boot automatically 2502Services are set up to start on boot automatically
2503unless you have set 2503unless you have set
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index c7322e7623..d3a603d4a4 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -301,7 +301,7 @@ As an example, you could add a specific server for the build system to
301attempt before any others by adding something like the following to the 301attempt before any others by adding something like the following to the
302``local.conf`` configuration file:: 302``local.conf`` configuration file::
303 303
304 PREMIRRORS_prepend = "\ 304 PREMIRRORS:prepend = "\
305 git://.*/.* http://www.yoctoproject.org/sources/ \n \ 305 git://.*/.* http://www.yoctoproject.org/sources/ \n \
306 ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ 306 ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
307 http://.*/.* http://www.yoctoproject.org/sources/ \n \ 307 http://.*/.* http://www.yoctoproject.org/sources/ \n \
@@ -341,7 +341,7 @@ Finally, consider an example where you are behind an HTTP-only firewall.
341You could make the following changes to the ``local.conf`` configuration 341You could make the following changes to the ``local.conf`` configuration
342file as long as the :term:`PREMIRRORS` server is current:: 342file as long as the :term:`PREMIRRORS` server is current::
343 343
344 PREMIRRORS_prepend = "\ 344 PREMIRRORS:prepend = "\
345 ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ 345 ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
346 http://.*/.* http://www.yoctoproject.org/sources/ \n \ 346 http://.*/.* http://www.yoctoproject.org/sources/ \n \
347 https://.*/.* http://www.yoctoproject.org/sources/ \n" 347 https://.*/.* http://www.yoctoproject.org/sources/ \n"
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index 0ef203c70f..4b5d0abdba 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -223,7 +223,7 @@ Errors and Warnings
223 software that reads :term:`CFLAGS` when you build it, 223 software that reads :term:`CFLAGS` when you build it,
224 you could add the following to your recipe:: 224 you could add the following to your recipe::
225 225
226 CFLAGS_append = " -fPIC " 226 CFLAGS:append = " -fPIC "
227 227
228 For more information on text relocations at runtime, see 228 For more information on text relocations at runtime, see
229 https://www.akkadia.org/drepper/textrelocs.html. 229 https://www.akkadia.org/drepper/textrelocs.html.
@@ -620,7 +620,7 @@ Errors and Warnings
620 620
621.. _qa-check-missing-update-alternatives: 621.. _qa-check-missing-update-alternatives:
622 622
623- ``<recipename>: recipe defines ALTERNATIVE_<packagename> but doesn't inherit update-alternatives. This might fail during do_rootfs later! [missing-update-alternatives]`` 623- ``<recipename>: recipe defines ALTERNATIVE:<packagename> but doesn't inherit update-alternatives. This might fail during do_rootfs later! [missing-update-alternatives]``
624 624
625 This check ensures that if a recipe sets the :term:`ALTERNATIVE` variable that the 625 This check ensures that if a recipe sets the :term:`ALTERNATIVE` variable that the
626 recipe also inherits :ref:`update-alternatives <ref-classes-update-alternatives>` such 626 recipe also inherits :ref:`update-alternatives <ref-classes-update-alternatives>` such
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index f6d248a193..c2b75dff84 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -38,9 +38,9 @@ system and gives an overview of their function and contents.
38 Like all package-controlling variables, you must always use them in 38 Like all package-controlling variables, you must always use them in
39 conjunction with a package name override, as in:: 39 conjunction with a package name override, as in::
40 40
41 ALLOW_EMPTY_${PN} = "1" 41 ALLOW_EMPTY:${PN} = "1"
42 ALLOW_EMPTY_${PN}-dev = "1" 42 ALLOW_EMPTY:${PN}-dev = "1"
43 ALLOW_EMPTY_${PN}-staticdev = "1" 43 ALLOW_EMPTY:${PN}-staticdev = "1"
44 44
45 :term:`ALTERNATIVE` 45 :term:`ALTERNATIVE`
46 Lists commands in a package that need an alternative binary naming 46 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.
53 provided by another package. For example, if the ``busybox`` package 53 provided by another package. For example, if the ``busybox`` package
54 has four such commands, you identify them as follows:: 54 has four such commands, you identify them as follows::
55 55
56 ALTERNATIVE_busybox = "sh sed test bracket" 56 ALTERNATIVE:busybox = "sh sed test bracket"
57 57
58 For more information on the alternatives system, see the 58 For more information on the alternatives system, see the
59 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" 59 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
@@ -297,7 +297,7 @@ system and gives an overview of their function and contents.
297 can attach it to a specific image recipe by using the recipe name 297 can attach it to a specific image recipe by using the recipe name
298 override:: 298 override::
299 299
300 BAD_RECOMMENDATIONS_pn-target_image = "package_name" 300 BAD_RECOMMENDATIONS:pn-target_image = "package_name"
301 301
302 It is important to realize that if you choose to not install packages 302 It is important to realize that if you choose to not install packages
303 using this variable and some other packages are dependent on them 303 using this variable and some other packages are dependent on them
@@ -1133,7 +1133,7 @@ system and gives an overview of their function and contents.
1133 As an example, the following override allows you to install extra 1133 As an example, the following override allows you to install extra
1134 files, but only when building for the target:: 1134 files, but only when building for the target::
1135 1135
1136 do_install_append_class-target() { 1136 do_install:append:class-target() {
1137 install my-extra-file ${D}${sysconfdir} 1137 install my-extra-file ${D}${sysconfdir}
1138 } 1138 }
1139 1139
@@ -1141,7 +1141,7 @@ system and gives an overview of their function and contents.
1141 "native" when building for the build host, and to "other" when not 1141 "native" when building for the build host, and to "other" when not
1142 building for the build host:: 1142 building for the build host::
1143 1143
1144 FOO_class-native = "native" 1144 FOO:class-native = "native"
1145 FOO = "other" 1145 FOO = "other"
1146 1146
1147 The underlying mechanism behind :term:`CLASSOVERRIDE` is simply 1147 The underlying mechanism behind :term:`CLASSOVERRIDE` is simply
@@ -1246,7 +1246,7 @@ system and gives an overview of their function and contents.
1246 that identifies the resulting package. Then, provide a 1246 that identifies the resulting package. Then, provide a
1247 space-separated list of files. Here is an example:: 1247 space-separated list of files. Here is an example::
1248 1248
1249 CONFFILES_${PN} += "${sysconfdir}/file1 \ 1249 CONFFILES:${PN} += "${sysconfdir}/file1 \
1250 ${sysconfdir}/file2 ${sysconfdir}/file3" 1250 ${sysconfdir}/file2 ${sysconfdir}/file3"
1251 1251
1252 There is a relationship between the :term:`CONFFILES` and :term:`FILES` 1252 There is a relationship between the :term:`CONFFILES` and :term:`FILES`
@@ -1546,7 +1546,7 @@ system and gives an overview of their function and contents.
1546 package naming. You must use the package name as an override when you 1546 package naming. You must use the package name as an override when you
1547 set this variable. Here is an example from the ``fontconfig`` recipe:: 1547 set this variable. Here is an example from the ``fontconfig`` recipe::
1548 1548
1549 DEBIAN_NOAUTONAME_fontconfig-utils = "1" 1549 DEBIAN_NOAUTONAME:fontconfig-utils = "1"
1550 1550
1551 :term:`DEBIANNAME` 1551 :term:`DEBIANNAME`
1552 When the :ref:`debian <ref-classes-debian>` class is inherited, 1552 When the :ref:`debian <ref-classes-debian>` class is inherited,
@@ -1556,7 +1556,7 @@ system and gives an overview of their function and contents.
1556 override when you set this variable. Here is an example from the 1556 override when you set this variable. Here is an example from the
1557 ``dbus`` recipe:: 1557 ``dbus`` recipe::
1558 1558
1559 DEBIANNAME_${PN} = "dbus-1" 1559 DEBIANNAME:${PN} = "dbus-1"
1560 1560
1561 :term:`DEBUG_BUILD` 1561 :term:`DEBUG_BUILD`
1562 Specifies to build packages with debugging information. This 1562 Specifies to build packages with debugging information. This
@@ -2115,7 +2115,7 @@ system and gives an overview of their function and contents.
2115 to fix a runtime dependency to the exact same version of another 2115 to fix a runtime dependency to the exact same version of another
2116 package in the same recipe:: 2116 package in the same recipe::
2117 2117
2118 RDEPENDS_${PN}-additional-module = "${PN} (= ${EXTENDPKGV})" 2118 RDEPENDS:${PN}-additional-module = "${PN} (= ${EXTENDPKGV})"
2119 2119
2120 The dependency relationships are intended to force the package 2120 The dependency relationships are intended to force the package
2121 manager to upgrade these types of packages in lock-step. 2121 manager to upgrade these types of packages in lock-step.
@@ -2215,7 +2215,7 @@ system and gives an overview of their function and contents.
2215 this variable, use an override for the associated image type. Here is 2215 this variable, use an override for the associated image type. Here is
2216 an example:: 2216 an example::
2217 2217
2218 EXTRA_IMAGECMD_ext3 ?= "-i 4096" 2218 EXTRA_IMAGECMD:ext3 ?= "-i 4096"
2219 2219
2220 :term:`EXTRA_IMAGEDEPENDS` 2220 :term:`EXTRA_IMAGEDEPENDS`
2221 A list of recipes to build that do not provide packages for 2221 A list of recipes to build that do not provide packages for
@@ -2342,7 +2342,7 @@ system and gives an overview of their function and contents.
2342 list of files or paths that identify the files you want included as 2342 list of files or paths that identify the files you want included as
2343 part of the resulting package. Here is an example:: 2343 part of the resulting package. Here is an example::
2344 2344
2345 FILES_${PN} += "${bindir}/mydir1 ${bindir}/mydir2/myfile" 2345 FILES:${PN} += "${bindir}/mydir1 ${bindir}/mydir2/myfile"
2346 2346
2347 .. note:: 2347 .. note::
2348 2348
@@ -2391,7 +2391,7 @@ system and gives an overview of their function and contents.
2391 :term:`FILESEXTRAPATHS` from within a ``.bbappend`` file and that you 2391 :term:`FILESEXTRAPATHS` from within a ``.bbappend`` file and that you
2392 prepend paths as follows:: 2392 prepend paths as follows::
2393 2393
2394 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" 2394 FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:"
2395 2395
2396 In the above example, the build system first 2396 In the above example, the build system first
2397 looks for files in a directory that has the same name as the 2397 looks for files in a directory that has the same name as the
@@ -2413,7 +2413,7 @@ system and gives an overview of their function and contents.
2413 2413
2414 Here is another common use:: 2414 Here is another common use::
2415 2415
2416 FILESEXTRAPATHS_prepend := "${THISDIR}/files:" 2416 FILESEXTRAPATHS:prepend := "${THISDIR}/files:"
2417 2417
2418 In this example, the build system extends the 2418 In this example, the build system extends the
2419 :term:`FILESPATH` variable to include a directory named ``files`` that is 2419 :term:`FILESPATH` variable to include a directory named ``files`` that is
@@ -2421,13 +2421,13 @@ system and gives an overview of their function and contents.
2421 2421
2422 This next example specifically adds three paths:: 2422 This next example specifically adds three paths::
2423 2423
2424 FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" 2424 FILESEXTRAPATHS:prepend := "path_1:path_2:path_3:"
2425 2425
2426 A final example shows how you can extend the search path and include 2426 A final example shows how you can extend the search path and include
2427 a :term:`MACHINE`-specific override, which is useful 2427 a :term:`MACHINE`-specific override, which is useful
2428 in a BSP layer:: 2428 in a BSP layer::
2429 2429
2430 FILESEXTRAPATHS_prepend_intel-x86-common := "${THISDIR}/${PN}:" 2430 FILESEXTRAPATHS:prepend_intel-x86-common := "${THISDIR}/${PN}:"
2431 2431
2432 The previous statement appears in the 2432 The previous statement appears in the
2433 ``linux-yocto-dev.bbappend`` file, which is found in the 2433 ``linux-yocto-dev.bbappend`` file, which is found in the
@@ -2675,7 +2675,7 @@ system and gives an overview of their function and contents.
2675 2675
2676 Here is an example from the ``dbus`` recipe:: 2676 Here is an example from the ``dbus`` recipe::
2677 2677
2678 GROUPADD_PARAM_${PN} = "-r netdev" 2678 GROUPADD_PARAM:${PN} = "-r netdev"
2679 2679
2680 For information on the standard Linux shell command 2680 For information on the standard Linux shell command
2681 ``groupadd``, see https://linux.die.net/man/8/groupadd. 2681 ``groupadd``, see https://linux.die.net/man/8/groupadd.
@@ -2988,7 +2988,7 @@ system and gives an overview of their function and contents.
2988 ``btrfs``, and so forth). When setting this variable, you should use 2988 ``btrfs``, and so forth). When setting this variable, you should use
2989 an override for the associated type. Here is an example:: 2989 an override for the associated type. Here is an example::
2990 2990
2991 IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} --faketime \ 2991 IMAGE_CMD:jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} --faketime \
2992 --output=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.jffs2 \ 2992 --output=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.jffs2 \
2993 ${EXTRA_IMAGECMD}" 2993 ${EXTRA_IMAGECMD}"
2994 2994
@@ -3063,7 +3063,7 @@ system and gives an overview of their function and contents.
3063 3063
3064 When you use this variable, it is best to use it as follows:: 3064 When you use this variable, it is best to use it as follows::
3065 3065
3066 IMAGE_INSTALL_append = " package-name" 3066 IMAGE_INSTALL:append = " package-name"
3067 3067
3068 Be sure to include the space 3068 Be sure to include the space
3069 between the quotation character and the start of the package name or 3069 between the quotation character and the start of the package name or
@@ -3706,7 +3706,7 @@ system and gives an overview of their function and contents.
3706 recipe. The package name override must be used, which in this example 3706 recipe. The package name override must be used, which in this example
3707 is ``${PN}``:: 3707 is ``${PN}``::
3708 3708
3709 INSANE_SKIP_${PN} += "dev-so" 3709 INSANE_SKIP:${PN} += "dev-so"
3710 3710
3711 See the ":ref:`insane.bbclass <ref-classes-insane>`" section for a 3711 See the ":ref:`insane.bbclass <ref-classes-insane>`" section for a
3712 list of the valid QA checks you can specify using this variable. 3712 list of the valid QA checks you can specify using this variable.
@@ -3760,9 +3760,9 @@ system and gives an overview of their function and contents.
3760 ``meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.12.bbappend``. 3760 ``meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.12.bbappend``.
3761 Here are the related statements from that append file:: 3761 Here are the related statements from that append file::
3762 3762
3763 KBRANCH_genericx86 = "standard/base" 3763 KBRANCH:genericx86 = "standard/base"
3764 KBRANCH_genericx86-64 = "standard/base" 3764 KBRANCH:genericx86-64 = "standard/base"
3765 KBRANCH_edgerouter = "standard/edgerouter" 3765 KBRANCH:edgerouter = "standard/edgerouter"
3766 KBRANCH_beaglebone = "standard/beaglebone" 3766 KBRANCH_beaglebone = "standard/beaglebone"
3767 3767
3768 The :term:`KBRANCH` statements 3768 The :term:`KBRANCH` statements
@@ -3795,7 +3795,7 @@ system and gives an overview of their function and contents.
3795 3795
3796 As an alternative, you can use the following within your append file:: 3796 As an alternative, you can use the following within your append file::
3797 3797
3798 KBUILD_DEFCONFIG_pn-linux-yocto ?= defconfig_file 3798 KBUILD_DEFCONFIG:pn-linux-yocto ?= defconfig_file
3799 3799
3800 For more 3800 For more
3801 information on how to use the :term:`KBUILD_DEFCONFIG` variable, see the 3801 information on how to use the :term:`KBUILD_DEFCONFIG` variable, see the
@@ -3943,10 +3943,10 @@ system and gives an overview of their function and contents.
3943 statements add specific configurations to targeted machine types:: 3943 statements add specific configurations to targeted machine types::
3944 3944
3945 KERNEL_EXTRA_FEATURES ?= "features/netfilter/netfilter.scc features/taskstats/taskstats.scc" 3945 KERNEL_EXTRA_FEATURES ?= "features/netfilter/netfilter.scc features/taskstats/taskstats.scc"
3946 KERNEL_FEATURES_append = "${KERNEL_EXTRA_FEATURES}" 3946 KERNEL_FEATURES:append = "${KERNEL_EXTRA_FEATURES}"
3947 KERNEL_FEATURES_append_qemuall = "cfg/virtio.scc" 3947 KERNEL_FEATURES:append:qemuall = "cfg/virtio.scc"
3948 KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc" 3948 KERNEL_FEATURES:append:qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc"
3949 KERNEL_FEATURES_append_qemux86-64 = "cfg/sound.scc" 3949 KERNEL_FEATURES:append:qemux86-64 = "cfg/sound.scc"
3950 3950
3951 :term:`KERNEL_FIT_LINK_NAME` 3951 :term:`KERNEL_FIT_LINK_NAME`
3952 The link name of the kernel flattened image tree (FIT) image. This 3952 The link name of the kernel flattened image tree (FIT) image. This
@@ -4134,7 +4134,7 @@ system and gives an overview of their function and contents.
4134 SRCREV_machine_core2-32-intel-common = "43b9eced9ba8a57add36af07736344dcc383f711" 4134 SRCREV_machine_core2-32-intel-common = "43b9eced9ba8a57add36af07736344dcc383f711"
4135 KMACHINE_core2-32-intel-common = "intel-core2-32" 4135 KMACHINE_core2-32-intel-common = "intel-core2-32"
4136 KBRANCH_core2-32-intel-common = "standard/base" 4136 KBRANCH_core2-32-intel-common = "standard/base"
4137 KERNEL_FEATURES_append_core2-32-intel-common = "${KERNEL_FEATURES_INTEL_COMMON}" 4137 KERNEL_FEATURES:append_core2-32-intel-common = "${KERNEL_FEATURES_INTEL_COMMON}"
4138 4138
4139 The :term:`KMACHINE` statement says 4139 The :term:`KMACHINE` statement says
4140 that the kernel understands the machine name as "intel-core2-32". 4140 that the kernel understands the machine name as "intel-core2-32".
@@ -4314,8 +4314,8 @@ system and gives an overview of their function and contents.
4314 Documentation License 1.2 could be specified as follows:: 4314 Documentation License 1.2 could be specified as follows::
4315 4315
4316 LICENSE = "GFDL-1.2 & GPLv2" 4316 LICENSE = "GFDL-1.2 & GPLv2"
4317 LICENSE_${PN} = "GPLv2" 4317 LICENSE:${PN} = "GPLv2"
4318 LICENSE_${PN}-doc = "GFDL-1.2" 4318 LICENSE:${PN}-doc = "GFDL-1.2"
4319 4319
4320 :term:`LICENSE_CREATE_PACKAGE` 4320 :term:`LICENSE_CREATE_PACKAGE`
4321 Setting :term:`LICENSE_CREATE_PACKAGE` to "1" causes the OpenEmbedded 4321 Setting :term:`LICENSE_CREATE_PACKAGE` to "1" causes the OpenEmbedded
@@ -4626,7 +4626,7 @@ system and gives an overview of their function and contents.
4626 in QEMU, like in the following example from the ``connman-conf`` 4626 in QEMU, like in the following example from the ``connman-conf``
4627 recipe:: 4627 recipe::
4628 4628
4629 SRC_URI_append_qemuall = " file://wired.config \ 4629 SRC_URI:append:qemuall = " file://wired.config \
4630 file://wired-setup \ 4630 file://wired-setup \
4631 " 4631 "
4632 4632
@@ -4829,7 +4829,7 @@ system and gives an overview of their function and contents.
4829 can attach it to a specific image recipe by using the recipe name 4829 can attach it to a specific image recipe by using the recipe name
4830 override:: 4830 override::
4831 4831
4832 NO_RECOMMENDATIONS_pn-target_image = "1" 4832 NO_RECOMMENDATIONS:pn-target_image = "1"
4833 4833
4834 It is important to realize that if you choose to not install packages 4834 It is important to realize that if you choose to not install packages
4835 using this variable and some other packages are dependent on them 4835 using this variable and some other packages are dependent on them
@@ -4857,9 +4857,9 @@ system and gives an overview of their function and contents.
4857 content of the debug package. For example:: 4857 content of the debug package. For example::
4858 4858
4859 NOAUTOPACKAGEDEBUG = "1" 4859 NOAUTOPACKAGEDEBUG = "1"
4860 FILES_${PN}-dev = "${includedir}/${QT_DIR_NAME}/Qt/*" 4860 FILES:${PN}-dev = "${includedir}/${QT_DIR_NAME}/Qt/*"
4861 FILES_${PN}-dbg = "/usr/src/debug/" 4861 FILES:${PN}-dbg = "/usr/src/debug/"
4862 FILES_${QT_BASE_NAME}-demos-doc = "${docdir}/${QT_DIR_NAME}/qch/qt.qch" 4862 FILES:${QT_BASE_NAME}-demos-doc = "${docdir}/${QT_DIR_NAME}/qch/qt.qch"
4863 4863
4864 :term:`NON_MULTILIB_RECIPES` 4864 :term:`NON_MULTILIB_RECIPES`
4865 A list of recipes that should not be built for multilib. OE-Core's 4865 A list of recipes that should not be built for multilib. OE-Core's
@@ -4970,7 +4970,7 @@ system and gives an overview of their function and contents.
4970 allows variables to be set for a single recipe within configuration 4970 allows variables to be set for a single recipe within configuration
4971 (``.conf``) files. Here is an example:: 4971 (``.conf``) files. Here is an example::
4972 4972
4973 FOO_pn-myrecipe = "myrecipe-specific value" 4973 FOO:pn-myrecipe = "myrecipe-specific value"
4974 4974
4975 .. note:: 4975 .. note::
4976 4976
@@ -5118,7 +5118,7 @@ system and gives an overview of their function and contents.
5118 can attach it to a specific image recipe by using the recipe name 5118 can attach it to a specific image recipe by using the recipe name
5119 override:: 5119 override::
5120 5120
5121 PACKAGE_EXCLUDE_pn-target_image = "package_name" 5121 PACKAGE_EXCLUDE:pn-target_image = "package_name"
5122 5122
5123 If you choose to not install a package using this variable and some 5123 If you choose to not install a package using this variable and some
5124 other package is dependent on it (i.e. listed in a recipe's 5124 other package is dependent on it (i.e. listed in a recipe's
@@ -5355,18 +5355,18 @@ system and gives an overview of their function and contents.
5355 5355
5356 Or, you can just append the variable:: 5356 Or, you can just append the variable::
5357 5357
5358 PACKAGECONFIG_append = " f4" 5358 PACKAGECONFIG:append = " f4"
5359 5359
5360 - *Configuration file:* This method is identical to changing the 5360 - *Configuration file:* This method is identical to changing the
5361 block through an append file except you edit your ``local.conf`` 5361 block through an append file except you edit your ``local.conf``
5362 or ``mydistro.conf`` file. As with append files previously 5362 or ``mydistro.conf`` file. As with append files previously
5363 described, you can either completely override the variable:: 5363 described, you can either completely override the variable::
5364 5364
5365 PACKAGECONFIG_pn-recipename = "f4 f5" 5365 PACKAGECONFIG:pn-recipename = "f4 f5"
5366 5366
5367 Or, you can just amend the variable:: 5367 Or, you can just amend the variable::
5368 5368
5369 PACKAGECONFIG_append_pn-recipename = " f4" 5369 PACKAGECONFIG:append:pn-recipename = " f4"
5370 5370
5371 :term:`PACKAGECONFIG_CONFARGS` 5371 :term:`PACKAGECONFIG_CONFARGS`
5372 A space-separated list of configuration options generated from the 5372 A space-separated list of configuration options generated from the
@@ -5786,13 +5786,13 @@ system and gives an overview of their function and contents.
5786 :term:`OVERRIDES` to set a machine-specific 5786 :term:`OVERRIDES` to set a machine-specific
5787 override. Here is an example:: 5787 override. Here is an example::
5788 5788
5789 PREFERRED_VERSION_linux-yocto_qemux86 = "5.0%" 5789 PREFERRED_VERSION_linux-yocto:qemux86 = "5.0%"
5790 5790
5791 Although not recommended, worst case, you can also use the 5791 Although not recommended, worst case, you can also use the
5792 "forcevariable" override, which is the strongest override possible. 5792 "forcevariable" override, which is the strongest override possible.
5793 Here is an example:: 5793 Here is an example::
5794 5794
5795 PREFERRED_VERSION_linux-yocto_forcevariable = "5.0%" 5795 PREFERRED_VERSION_linux-yocto:forcevariable = "5.0%"
5796 5796
5797 .. note:: 5797 .. note::
5798 5798
@@ -5820,7 +5820,7 @@ system and gives an overview of their function and contents.
5820 the ``local.conf`` configuration file in the 5820 the ``local.conf`` configuration file in the
5821 :term:`Build Directory`:: 5821 :term:`Build Directory`::
5822 5822
5823 PREMIRRORS_prepend = "\ 5823 PREMIRRORS:prepend = "\
5824 git://.*/.* http://www.yoctoproject.org/sources/ \n \ 5824 git://.*/.* http://www.yoctoproject.org/sources/ \n \
5825 ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ 5825 ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
5826 http://.*/.* http://www.yoctoproject.org/sources/ \n \ 5826 http://.*/.* http://www.yoctoproject.org/sources/ \n \
@@ -6003,7 +6003,7 @@ system and gives an overview of their function and contents.
6003 Like all package-controlling variables, you must always use them in 6003 Like all package-controlling variables, you must always use them in
6004 conjunction with a package name override. Here is an example:: 6004 conjunction with a package name override. Here is an example::
6005 6005
6006 RCONFLICTS_${PN} = "another_conflicting_package_name" 6006 RCONFLICTS:${PN} = "another_conflicting_package_name"
6007 6007
6008 BitBake, which the OpenEmbedded build system uses, supports 6008 BitBake, which the OpenEmbedded build system uses, supports
6009 specifying versioned dependencies. Although the syntax varies 6009 specifying versioned dependencies. Although the syntax varies
@@ -6011,7 +6011,7 @@ system and gives an overview of their function and contents.
6011 from you. Here is the general syntax to specify versions with the 6011 from you. Here is the general syntax to specify versions with the
6012 :term:`RCONFLICTS` variable:: 6012 :term:`RCONFLICTS` variable::
6013 6013
6014 RCONFLICTS_${PN} = "package (operator version)" 6014 RCONFLICTS:${PN} = "package (operator version)"
6015 6015
6016 For ``operator``, you can specify the following: 6016 For ``operator``, you can specify the following:
6017 6017
@@ -6024,7 +6024,7 @@ system and gives an overview of their function and contents.
6024 For example, the following sets up a dependency on version 1.2 or 6024 For example, the following sets up a dependency on version 1.2 or
6025 greater of the package ``foo``:: 6025 greater of the package ``foo``::
6026 6026
6027 RCONFLICTS_${PN} = "foo (>= 1.2)" 6027 RCONFLICTS:${PN} = "foo (>= 1.2)"
6028 6028
6029 :term:`RDEPENDS` 6029 :term:`RDEPENDS`
6030 Lists runtime dependencies of a package. These dependencies are other 6030 Lists runtime dependencies of a package. These dependencies are other
@@ -6033,7 +6033,7 @@ system and gives an overview of their function and contents.
6033 package ``foo`` needs the packages ``bar`` and ``baz`` to be 6033 package ``foo`` needs the packages ``bar`` and ``baz`` to be
6034 installed:: 6034 installed::
6035 6035
6036 RDEPENDS_foo = "bar baz" 6036 RDEPENDS:foo = "bar baz"
6037 6037
6038 The most common types of package 6038 The most common types of package
6039 runtime dependencies are automatically detected and added. Therefore, 6039 runtime dependencies are automatically detected and added. Therefore,
@@ -6074,7 +6074,7 @@ system and gives an overview of their function and contents.
6074 on the ``perl`` package. In this case, you would use the following 6074 on the ``perl`` package. In this case, you would use the following
6075 :term:`RDEPENDS` statement:: 6075 :term:`RDEPENDS` statement::
6076 6076
6077 RDEPENDS_${PN}-dev += "perl" 6077 RDEPENDS:${PN}-dev += "perl"
6078 6078
6079 In the example, 6079 In the example,
6080 the development package depends on the ``perl`` package. Thus, the 6080 the development package depends on the ``perl`` package. Thus, the
@@ -6103,7 +6103,7 @@ system and gives an overview of their function and contents.
6103 from you. Here is the general syntax to specify versions with the 6103 from you. Here is the general syntax to specify versions with the
6104 :term:`RDEPENDS` variable:: 6104 :term:`RDEPENDS` variable::
6105 6105
6106 RDEPENDS_${PN} = "package (operator version)" 6106 RDEPENDS:${PN} = "package (operator version)"
6107 6107
6108 For ``operator``, you can specify the following: 6108 For ``operator``, you can specify the following:
6109 6109
@@ -6123,7 +6123,7 @@ system and gives an overview of their function and contents.
6123 For example, the following sets up a dependency on version 1.2 or 6123 For example, the following sets up a dependency on version 1.2 or
6124 greater of the package ``foo``:: 6124 greater of the package ``foo``::
6125 6125
6126 RDEPENDS_${PN} = "foo (>= 1.2)" 6126 RDEPENDS:${PN} = "foo (>= 1.2)"
6127 6127
6128 For information on build-time dependencies, see the 6128 For information on build-time dependencies, see the
6129 :term:`DEPENDS` variable. You can also see the 6129 :term:`DEPENDS` variable. You can also see the
@@ -6258,7 +6258,7 @@ system and gives an overview of their function and contents.
6258 variable in conjunction with a package name override. Here is an 6258 variable in conjunction with a package name override. Here is an
6259 example:: 6259 example::
6260 6260
6261 RPROVIDES_${PN} = "widget-abi-2" 6261 RPROVIDES:${PN} = "widget-abi-2"
6262 6262
6263 :term:`RRECOMMENDS` 6263 :term:`RRECOMMENDS`
6264 A list of packages that extends the usability of a package being 6264 A list of packages that extends the usability of a package being
@@ -6289,7 +6289,7 @@ system and gives an overview of their function and contents.
6289 support wireless functionality. In this case, you would use the 6289 support wireless functionality. In this case, you would use the
6290 following:: 6290 following::
6291 6291
6292 RRECOMMENDS_${PN}-dev += "wireless_package_name" 6292 RRECOMMENDS:${PN}-dev += "wireless_package_name"
6293 6293
6294 In the 6294 In the
6295 example, the package name (``${PN}-dev``) must appear as it would in 6295 example, the package name (``${PN}-dev``) must appear as it would in
@@ -6302,7 +6302,7 @@ system and gives an overview of their function and contents.
6302 Here is the general syntax to specify versions with the 6302 Here is the general syntax to specify versions with the
6303 :term:`RRECOMMENDS` variable:: 6303 :term:`RRECOMMENDS` variable::
6304 6304
6305 RRECOMMENDS_${PN} = "package (operator version)" 6305 RRECOMMENDS:${PN} = "package (operator version)"
6306 6306
6307 For ``operator``, you can specify the following: 6307 For ``operator``, you can specify the following:
6308 6308
@@ -6315,7 +6315,7 @@ system and gives an overview of their function and contents.
6315 For example, the following sets up a recommend on version 1.2 or 6315 For example, the following sets up a recommend on version 1.2 or
6316 greater of the package ``foo``:: 6316 greater of the package ``foo``::
6317 6317
6318 RRECOMMENDS_${PN} = "foo (>= 1.2)" 6318 RRECOMMENDS:${PN} = "foo (>= 1.2)"
6319 6319
6320 :term:`RREPLACES` 6320 :term:`RREPLACES`
6321 A list of packages replaced by a package. The package manager uses 6321 A list of packages replaced by a package. The package manager uses
@@ -6327,7 +6327,7 @@ system and gives an overview of their function and contents.
6327 As with all package-controlling variables, you must use this variable 6327 As with all package-controlling variables, you must use this variable
6328 in conjunction with a package name override. Here is an example:: 6328 in conjunction with a package name override. Here is an example::
6329 6329
6330 RREPLACES_${PN} = "other_package_being_replaced" 6330 RREPLACES:${PN} = "other_package_being_replaced"
6331 6331
6332 BitBake, which the OpenEmbedded build system uses, supports 6332 BitBake, which the OpenEmbedded build system uses, supports
6333 specifying versioned replacements. Although the syntax varies 6333 specifying versioned replacements. Although the syntax varies
@@ -6335,7 +6335,7 @@ system and gives an overview of their function and contents.
6335 from you. Here is the general syntax to specify versions with the 6335 from you. Here is the general syntax to specify versions with the
6336 :term:`RREPLACES` variable:: 6336 :term:`RREPLACES` variable::
6337 6337
6338 RREPLACES_${PN} = "package (operator version)" 6338 RREPLACES:${PN} = "package (operator version)"
6339 6339
6340 For ``operator``, you can specify the following: 6340 For ``operator``, you can specify the following:
6341 6341
@@ -6348,7 +6348,7 @@ system and gives an overview of their function and contents.
6348 For example, the following sets up a replacement using version 1.2 6348 For example, the following sets up a replacement using version 1.2
6349 or greater of the package ``foo``:: 6349 or greater of the package ``foo``::
6350 6350
6351 RREPLACES_${PN} = "foo (>= 1.2)" 6351 RREPLACES:${PN} = "foo (>= 1.2)"
6352 6352
6353 :term:`RSUGGESTS` 6353 :term:`RSUGGESTS`
6354 A list of additional packages that you can suggest for installation 6354 A list of additional packages that you can suggest for installation
@@ -6359,7 +6359,7 @@ system and gives an overview of their function and contents.
6359 variable in conjunction with a package name override. Here is an 6359 variable in conjunction with a package name override. Here is an
6360 example:: 6360 example::
6361 6361
6362 RSUGGESTS_${PN} = "useful_package another_package" 6362 RSUGGESTS:${PN} = "useful_package another_package"
6363 6363
6364 :term:`S` 6364 :term:`S`
6365 The location in the :term:`Build Directory` where 6365 The location in the :term:`Build Directory` where
@@ -7620,7 +7620,7 @@ system and gives an overview of their function and contents.
7620 override to indicate the package to which the value applies. Here is 7620 override to indicate the package to which the value applies. Here is
7621 an example from the connman recipe:: 7621 an example from the connman recipe::
7622 7622
7623 SYSTEMD_SERVICE_${PN} = "connman.service" 7623 SYSTEMD_SERVICE:${PN} = "connman.service"
7624 7624
7625 :term:`SYSVINIT_ENABLED_GETTYS` 7625 :term:`SYSVINIT_ENABLED_GETTYS`
7626 When using 7626 When using
@@ -7958,14 +7958,14 @@ system and gives an overview of their function and contents.
7958 your own tests to the list of tests by appending :term:`TEST_SUITES` as 7958 your own tests to the list of tests by appending :term:`TEST_SUITES` as
7959 follows:: 7959 follows::
7960 7960
7961 TEST_SUITES_append = " mytest" 7961 TEST_SUITES:append = " mytest"
7962 7962
7963 Alternatively, you can 7963 Alternatively, you can
7964 provide the "auto" option to have all applicable tests run against 7964 provide the "auto" option to have all applicable tests run against
7965 the image. 7965 the image.
7966 :: 7966 ::
7967 7967
7968 TEST_SUITES_append = " auto" 7968 TEST_SUITES:append = " auto"
7969 7969
7970 Using this option causes the 7970 Using this option causes the
7971 build system to automatically run tests that are applicable to the 7971 build system to automatically run tests that are applicable to the
@@ -8226,7 +8226,7 @@ system and gives an overview of their function and contents.
8226 The BitBake configuration file (``meta/conf/bitbake.conf``) defines 8226 The BitBake configuration file (``meta/conf/bitbake.conf``) defines
8227 :term:`TUNE_FEATURES` as follows:: 8227 :term:`TUNE_FEATURES` as follows::
8228 8228
8229 TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}" 8229 TUNE_FEATURES ??= "${TUNE_FEATURES:tune-${DEFAULTTUNE}}"
8230 8230
8231 See the :term:`DEFAULTTUNE` variable for more information. 8231 See the :term:`DEFAULTTUNE` variable for more information.
8232 8232
@@ -8252,13 +8252,13 @@ system and gives an overview of their function and contents.
8252 the architecture, ABI, and tuning of output packages. The specific 8252 the architecture, ABI, and tuning of output packages. The specific
8253 tune is defined using the "_tune" override as follows:: 8253 tune is defined using the "_tune" override as follows::
8254 8254
8255 TUNE_PKGARCH_tune-tune = "tune" 8255 TUNE_PKGARCH:tune-tune = "tune"
8256 8256
8257 These tune-specific package architectures are defined in the machine 8257 These tune-specific package architectures are defined in the machine
8258 include files. Here is an example of the "core2-32" tuning as used in 8258 include files. Here is an example of the "core2-32" tuning as used in
8259 the ``meta/conf/machine/include/tune-core2.inc`` file:: 8259 the ``meta/conf/machine/include/tune-core2.inc`` file::
8260 8260
8261 TUNE_PKGARCH_tune-core2-32 = "core2-32" 8261 TUNE_PKGARCH:tune-core2-32 = "core2-32"
8262 8262
8263 :term:`TUNEABI` 8263 :term:`TUNEABI`
8264 An underlying Application Binary Interface (ABI) used by a particular 8264 An underlying Application Binary Interface (ABI) used by a particular
@@ -8625,7 +8625,7 @@ system and gives an overview of their function and contents.
8625 8625
8626 Here is an example from the ``dbus`` recipe:: 8626 Here is an example from the ``dbus`` recipe::
8627 8627
8628 USERADD_PARAM_${PN} = "--system --home ${localstatedir}/lib/dbus \ 8628 USERADD_PARAM:${PN} = "--system --home ${localstatedir}/lib/dbus \
8629 --no-create-home --shell /bin/false \ 8629 --no-create-home --shell /bin/false \
8630 --user-group messagebus" 8630 --user-group messagebus"
8631 8631