summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2021-08-11 22:06:01 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-08-14 12:04:23 +0100
commit3d93ddf9e8867ca3f331fc9d3f4eb658a2b7810f (patch)
tree58769f99fa5ac2af2bbff9fe2fc829ee7132023d /documentation/ref-manual
parented6482821c1cc04d3cd35f6b30631a4d09b594d1 (diff)
downloadpoky-3d93ddf9e8867ca3f331fc9d3f4eb658a2b7810f.tar.gz
docs: fix new override syntax migration
Fix bits missed by the migration script. (From yocto-docs rev: 452e0c5067476fd2ce81f09e6c73da84ced4bbd0) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/classes.rst8
-rw-r--r--documentation/ref-manual/qa-checks.rst16
-rw-r--r--documentation/ref-manual/variables.rst52
3 files changed, 38 insertions, 38 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 610d64bd46..3af023895e 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1198,7 +1198,7 @@ Here are the tests you can list with the :term:`WARN_QA` and
1198 its :term:`PN` value matches something already in :term:`OVERRIDES` (e.g. 1198 its :term:`PN` value matches something already in :term:`OVERRIDES` (e.g.
1199 :term:`PN` happens to be the same as :term:`MACHINE` or 1199 :term:`PN` happens to be the same as :term:`MACHINE` or
1200 :term:`DISTRO`), it can have unexpected consequences. 1200 :term:`DISTRO`), it can have unexpected consequences.
1201 For example, assignments such as ``FILES_${PN} = "xyz"`` effectively 1201 For example, assignments such as ``FILES:${PN} = "xyz"`` effectively
1202 turn into ``FILES = "xyz"``. 1202 turn into ``FILES = "xyz"``.
1203 1203
1204- ``rpaths:`` Checks for rpaths in the binaries that contain build 1204- ``rpaths:`` Checks for rpaths in the binaries that contain build
@@ -1224,7 +1224,7 @@ Here are the tests you can list with the :term:`WARN_QA` and
1224 1224
1225- ``unlisted-pkg-lics:`` Checks that all declared licenses applying 1225- ``unlisted-pkg-lics:`` Checks that all declared licenses applying
1226 for a package are also declared on the recipe level (i.e. any license 1226 for a package are also declared on the recipe level (i.e. any license
1227 in ``LICENSE_*`` should appear in :term:`LICENSE`). 1227 in ``LICENSE:*`` should appear in :term:`LICENSE`).
1228 1228
1229- ``useless-rpaths:`` Checks for dynamic library load paths (rpaths) 1229- ``useless-rpaths:`` Checks for dynamic library load paths (rpaths)
1230 in the binaries that by default on a standard system are searched by 1230 in the binaries that by default on a standard system are searched by
@@ -1621,7 +1621,7 @@ a couple different ways:
1621 BBCLASSEXTEND = "native" 1621 BBCLASSEXTEND = "native"
1622 1622
1623 Inside the 1623 Inside the
1624 recipe, use ``_class-native`` and ``_class-target`` overrides to 1624 recipe, use ``:class-native`` and ``:class-target`` overrides to
1625 specify any functionality specific to the respective native or target 1625 specify any functionality specific to the respective native or target
1626 case. 1626 case.
1627 1627
@@ -1652,7 +1652,7 @@ couple different ways:
1652 BBCLASSEXTEND = "nativesdk" 1652 BBCLASSEXTEND = "nativesdk"
1653 1653
1654 Inside the 1654 Inside the
1655 recipe, use ``_class-nativesdk`` and ``_class-target`` overrides to 1655 recipe, use ``:class-nativesdk`` and ``:class-target`` overrides to
1656 specify any functionality specific to the respective SDK machine or 1656 specify any functionality specific to the respective SDK machine or
1657 target case. 1657 target case.
1658 1658
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index 4b5d0abdba..d452de4119 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -263,7 +263,7 @@ Errors and Warnings
263 263
264 The ``/usr/share/info/dir`` should not be packaged. Add the following 264 The ``/usr/share/info/dir`` should not be packaged. Add the following
265 line to your :ref:`ref-tasks-install` task or to your 265 line to your :ref:`ref-tasks-install` task or to your
266 ``do_install_append`` within the recipe as follows:: 266 ``do_install:append`` within the recipe as follows::
267 267
268 rm ${D}${infodir}/dir 268 rm ${D}${infodir}/dir
269   269  
@@ -347,7 +347,7 @@ Errors and Warnings
347   347  
348.. _qa-check-dep-cmp: 348.. _qa-check-dep-cmp:
349 349
350- ``<var>_<packagename> is invalid: <comparison> (<value>) only comparisons <, =, >, <=, and >= are allowed [dep-cmp]`` 350- ``<var>:<packagename> is invalid: <comparison> (<value>) only comparisons <, =, >, <=, and >= are allowed [dep-cmp]``
351 351
352 If you are adding a versioned dependency relationship to one of the 352 If you are adding a versioned dependency relationship to one of the
353 dependency variables (:term:`RDEPENDS`, 353 dependency variables (:term:`RDEPENDS`,
@@ -454,14 +454,14 @@ Errors and Warnings
454 ``pkg_preinst``, ``pkg_postinst``, ``pkg_prerm``, ``pkg_postrm``, and 454 ``pkg_preinst``, ``pkg_postinst``, ``pkg_prerm``, ``pkg_postrm``, and
455 :term:`ALLOW_EMPTY`) should always be set specific 455 :term:`ALLOW_EMPTY`) should always be set specific
456 to a package (i.e. they should be set with a package name override 456 to a package (i.e. they should be set with a package name override
457 such as ``RDEPENDS_${PN} = "value"`` rather than 457 such as ``RDEPENDS:${PN} = "value"`` rather than
458 ``RDEPENDS = "value"``). If you receive this error, correct any 458 ``RDEPENDS = "value"``). If you receive this error, correct any
459 assignments to these variables within your recipe. 459 assignments to these variables within your recipe.
460 460
461 461
462- ``recipe uses DEPENDS_${PN}, should use DEPENDS [pkgvarcheck]`` 462- ``recipe uses DEPENDS:${PN}, should use DEPENDS [pkgvarcheck]``
463 463
464 This check looks for instances of setting ``DEPENDS_${PN}`` 464 This check looks for instances of setting ``DEPENDS:${PN}``
465 which is erroneous (:term:`DEPENDS` is a recipe-wide variable and thus 465 which is erroneous (:term:`DEPENDS` is a recipe-wide variable and thus
466 it is not correct to specify it for a particular package, nor will such 466 it is not correct to specify it for a particular package, nor will such
467 an assignment actually work.) Set :term:`DEPENDS` instead. 467 an assignment actually work.) Set :term:`DEPENDS` instead.
@@ -524,7 +524,7 @@ Errors and Warnings
524 following: 524 following:
525 525
526 - Add the files to :term:`FILES` for the package you want them to appear 526 - Add the files to :term:`FILES` for the package you want them to appear
527 in (e.g. ``FILES_${``\ :term:`PN`\ ``}`` for the main 527 in (e.g. ``FILES:${``\ :term:`PN`\ ``}`` for the main
528 package). 528 package).
529 529
530 - Delete the files at the end of the ``do_install`` task if the 530 - Delete the files at the end of the ``do_install`` task if the
@@ -546,11 +546,11 @@ Errors and Warnings
546 546
547.. _qa-check-unlisted-pkg-lics: 547.. _qa-check-unlisted-pkg-lics:
548 548
549- ``LICENSE_<packagename> includes licenses (<licenses>) that are not listed in LICENSE [unlisted-pkg-lics]`` 549- ``LICENSE:<packagename> includes licenses (<licenses>) that are not listed in LICENSE [unlisted-pkg-lics]``
550 550
551 The :term:`LICENSE` of the recipe should be a superset 551 The :term:`LICENSE` of the recipe should be a superset
552 of all the licenses of all packages produced by this recipe. In other 552 of all the licenses of all packages produced by this recipe. In other
553 words, any license in ``LICENSE_*`` should also appear in 553 words, any license in ``LICENSE:*`` should also appear in
554 :term:`LICENSE`. 554 :term:`LICENSE`.
555 555
556 556
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index c2b75dff84..d5df9ae41c 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -575,7 +575,7 @@ system and gives an overview of their function and contents.
575 575
576 Internally, the :term:`BBCLASSEXTEND` mechanism generates recipe 576 Internally, the :term:`BBCLASSEXTEND` mechanism generates recipe
577 variants by rewriting variable values and applying overrides such 577 variants by rewriting variable values and applying overrides such
578 as ``_class-native``. For example, to generate a native version of 578 as ``:class-native``. For example, to generate a native version of
579 a recipe, a :term:`DEPENDS` on "foo" is rewritten 579 a recipe, a :term:`DEPENDS` on "foo" is rewritten
580 to a :term:`DEPENDS` on "foo-native". 580 to a :term:`DEPENDS` on "foo-native".
581 581
@@ -2358,7 +2358,7 @@ system and gives an overview of their function and contents.
2358 rather than ``/usr/bin``. You can find a list of these 2358 rather than ``/usr/bin``. You can find a list of these
2359 variables at the top of the ``meta/conf/bitbake.conf`` file in 2359 variables at the top of the ``meta/conf/bitbake.conf`` file in
2360 the :term:`Source Directory`. You will also 2360 the :term:`Source Directory`. You will also
2361 find the default values of the various ``FILES_*`` variables in 2361 find the default values of the various ``FILES:*`` variables in
2362 this file. 2362 this file.
2363 2363
2364 If some of the files you provide with the :term:`FILES` variable are 2364 If some of the files you provide with the :term:`FILES` variable are
@@ -2427,7 +2427,7 @@ system and gives an overview of their function and contents.
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
@@ -3044,8 +3044,8 @@ system and gives an overview of their function and contents.
3044 :term:`IMAGE_FSTYPES` prior to using the "inherit image" line. 3044 :term:`IMAGE_FSTYPES` prior to using the "inherit image" line.
3045 3045
3046 - Due to the way the OpenEmbedded build system processes this 3046 - Due to the way the OpenEmbedded build system processes this
3047 variable, you cannot update its contents by using ``_append`` 3047 variable, you cannot update its contents by using ``:append``
3048 or ``_prepend``. You must use the ``+=`` operator to add one or 3048 or ``:prepend``. You must use the ``+=`` operator to add one or
3049 more options to the :term:`IMAGE_FSTYPES` variable. 3049 more options to the :term:`IMAGE_FSTYPES` variable.
3050 3050
3051 :term:`IMAGE_INSTALL` 3051 :term:`IMAGE_INSTALL`
@@ -3303,7 +3303,7 @@ system and gives an overview of their function and contents.
3303 Specifies a dependency from one image type on another. Here is an 3303 Specifies a dependency from one image type on another. Here is an
3304 example from the :ref:`image-live <ref-classes-image-live>` class:: 3304 example from the :ref:`image-live <ref-classes-image-live>` class::
3305 3305
3306 IMAGE_TYPEDEP_live = "ext3" 3306 IMAGE_TYPEDEP:live = "ext3"
3307 3307
3308 In the previous example, the variable ensures that when "live" is 3308 In the previous example, the variable ensures that when "live" is
3309 listed with the :term:`IMAGE_FSTYPES` variable, 3309 listed with the :term:`IMAGE_FSTYPES` variable,
@@ -3763,7 +3763,7 @@ system and gives an overview of their function and contents.
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
3769 identify the kernel branch to use when building for each supported 3769 identify the kernel branch to use when building for each supported
@@ -3791,11 +3791,11 @@ system and gives an overview of their function and contents.
3791 Here is an example from a "raspberrypi2" :term:`KMACHINE` build that uses 3791 Here is an example from a "raspberrypi2" :term:`KMACHINE` build that uses
3792 a ``defconfig`` file named "bcm2709_defconfig":: 3792 a ``defconfig`` file named "bcm2709_defconfig"::
3793 3793
3794 KBUILD_DEFCONFIG_raspberrypi2 = "bcm2709_defconfig" 3794 KBUILD_DEFCONFIG:raspberrypi2 = "bcm2709_defconfig"
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
@@ -4128,13 +4128,13 @@ system and gives an overview of their function and contents.
4128 Kernel's ``meta`` branch. As an example take a look in the 4128 Kernel's ``meta`` branch. As an example take a look in the
4129 ``common/recipes-kernel/linux/linux-yocto_3.19.bbappend`` file:: 4129 ``common/recipes-kernel/linux/linux-yocto_3.19.bbappend`` file::
4130 4130
4131 LINUX_VERSION_core2-32-intel-common = "3.19.0" 4131 LINUX_VERSION:core2-32-intel-common = "3.19.0"
4132 COMPATIBLE_MACHINE_core2-32-intel-common = "${MACHINE}" 4132 COMPATIBLE_MACHINE:core2-32-intel-common = "${MACHINE}"
4133 SRCREV_meta_core2-32-intel-common = "8897ef68b30e7426bc1d39895e71fb155d694974" 4133 SRCREV_meta:core2-32-intel-common = "8897ef68b30e7426bc1d39895e71fb155d694974"
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".
@@ -4322,7 +4322,7 @@ system and gives an overview of their function and contents.
4322 build system to create an extra package (i.e. 4322 build system to create an extra package (i.e.
4323 ``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add 4323 ``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add
4324 those packages to the 4324 those packages to the
4325 :term:`RRECOMMENDS`\ ``_${PN}``. 4325 :term:`RRECOMMENDS`\ ``:${PN}``.
4326 4326
4327 The ``${PN}-lic`` package installs a directory in 4327 The ``${PN}-lic`` package installs a directory in
4328 ``/usr/share/licenses`` named ``${PN}``, which is the recipe's base 4328 ``/usr/share/licenses`` named ``${PN}``, which is the recipe's base
@@ -4852,7 +4852,7 @@ system and gives an overview of their function and contents.
4852 4852
4853 :term:`NOAUTOPACKAGEDEBUG` 4853 :term:`NOAUTOPACKAGEDEBUG`
4854 Disables auto package from splitting ``.debug`` files. If a recipe 4854 Disables auto package from splitting ``.debug`` files. If a recipe
4855 requires ``FILES_${PN}-dbg`` to be set manually, the 4855 requires ``FILES:${PN}-dbg`` to be set manually, the
4856 :term:`NOAUTOPACKAGEDEBUG` can be defined allowing you to define the 4856 :term:`NOAUTOPACKAGEDEBUG` can be defined allowing you to define the
4857 content of the debug package. For example:: 4857 content of the debug package. For example::
4858 4858
@@ -4955,7 +4955,7 @@ system and gives an overview of their function and contents.
4955 assignment will override ``FOO`` with the value "overridden" at the 4955 assignment will override ``FOO`` with the value "overridden" at the
4956 end of parsing:: 4956 end of parsing::
4957 4957
4958 FOO_an-override = "overridden" 4958 FOO:an-override = "overridden"
4959 4959
4960 See the 4960 See the
4961 ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" 4961 ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
@@ -5401,7 +5401,7 @@ system and gives an overview of their function and contents.
5401 (leftmost) package. 5401 (leftmost) package.
5402 5402
5403 Packages in the variable's list that are empty (i.e. where none of 5403 Packages in the variable's list that are empty (i.e. where none of
5404 the patterns in ``FILES_``\ pkg match any files installed by the 5404 the patterns in ``FILES:``\ pkg match any files installed by the
5405 :ref:`ref-tasks-install` task) are not generated, 5405 :ref:`ref-tasks-install` task) are not generated,
5406 unless generation is forced through the 5406 unless generation is forced through the
5407 :term:`ALLOW_EMPTY` variable. 5407 :term:`ALLOW_EMPTY` variable.
@@ -5552,7 +5552,7 @@ system and gives an overview of their function and contents.
5552 5552
5553 For example, when the :ref:`debian <ref-classes-debian>` class 5553 For example, when the :ref:`debian <ref-classes-debian>` class
5554 renames the output package, it does so by setting 5554 renames the output package, it does so by setting
5555 ``PKG_packagename``. 5555 ``PKG:packagename``.
5556 5556
5557 :term:`PKG_CONFIG_PATH` 5557 :term:`PKG_CONFIG_PATH`
5558 The path to ``pkg-config`` files for the current build context. 5558 The path to ``pkg-config`` files for the current build context.
@@ -5796,7 +5796,7 @@ system and gives an overview of their function and contents.
5796 5796
5797 .. note:: 5797 .. note::
5798 5798
5799 The ``\_forcevariable`` override is not handled specially. This override 5799 The ``:forcevariable`` override is not handled specially. This override
5800 only works because the default value of :term:`OVERRIDES` includes "forcevariable". 5800 only works because the default value of :term:`OVERRIDES` includes "forcevariable".
5801 5801
5802 If a recipe with the specified version is not available, a warning 5802 If a recipe with the specified version is not available, a warning
@@ -6083,10 +6083,10 @@ system and gives an overview of their function and contents.
6083 6083
6084 .. note:: 6084 .. note::
6085 6085
6086 ``RDEPENDS_${PN}-dev`` includes ``${``\ :term:`PN`\ ``}`` 6086 ``RDEPENDS:${PN}-dev`` includes ``${``\ :term:`PN`\ ``}``
6087 by default. This default is set in the BitBake configuration file 6087 by default. This default is set in the BitBake configuration file
6088 (``meta/conf/bitbake.conf``). Be careful not to accidentally remove 6088 (``meta/conf/bitbake.conf``). Be careful not to accidentally remove
6089 ``${PN}`` when modifying ``RDEPENDS_${PN}-dev``. Use the "+=" operator 6089 ``${PN}`` when modifying ``RDEPENDS:${PN}-dev``. Use the "+=" operator
6090 rather than the "=" operator. 6090 rather than the "=" operator.
6091 6091
6092 The package names you use with :term:`RDEPENDS` must appear as they would 6092 The package names you use with :term:`RDEPENDS` must appear as they would
@@ -6873,7 +6873,7 @@ system and gives an overview of their function and contents.
6873 defined in the ``meta/conf/bitbake.conf`` configuration file. 6873 defined in the ``meta/conf/bitbake.conf`` configuration file.
6874 6874
6875 You will see this variable referenced in the default values of 6875 You will see this variable referenced in the default values of
6876 ``FILES_${PN}``. 6876 ``FILES:${PN}``.
6877 6877
6878 :term:`SOLIBSDEV` 6878 :term:`SOLIBSDEV`
6879 Defines the suffix for the development symbolic link (symlink) for 6879 Defines the suffix for the development symbolic link (symlink) for
@@ -6882,7 +6882,7 @@ system and gives an overview of their function and contents.
6882 ``meta/conf/bitbake.conf`` configuration file. 6882 ``meta/conf/bitbake.conf`` configuration file.
6883 6883
6884 You will see this variable referenced in the default values of 6884 You will see this variable referenced in the default values of
6885 ``FILES_${PN}-dev``. 6885 ``FILES:${PN}-dev``.
6886 6886
6887 :term:`SOURCE_MIRROR_FETCH` 6887 :term:`SOURCE_MIRROR_FETCH`
6888 When you are fetching files to create a mirror of sources (i.e. 6888 When you are fetching files to create a mirror of sources (i.e.