diff options
Diffstat (limited to 'documentation/ref-manual/variables.rst')
| -rw-r--r-- | documentation/ref-manual/variables.rst | 122 |
1 files changed, 61 insertions, 61 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 00d45a79f06..e1d6a368a60 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. 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 @@ -1120,7 +1120,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} } @@ -1128,7 +1128,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 @@ -1233,7 +1233,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` @@ -1510,7 +1510,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, @@ -1520,7 +1520,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 @@ -2079,7 +2079,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. @@ -2179,7 +2179,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 @@ -2306,7 +2306,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:: @@ -2355,7 +2355,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 @@ -2377,7 +2377,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 @@ -2385,13 +2385,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 @@ -2639,7 +2639,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. @@ -2952,7 +2952,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}" @@ -3027,7 +3027,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 @@ -3670,7 +3670,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. @@ -3759,7 +3759,7 @@ system and gives an overview of their function and contents. 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 @@ -3907,10 +3907,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 @@ -4098,7 +4098,7 @@ system and gives an overview of their function and contents. 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}" + 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". @@ -4278,8 +4278,8 @@ 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 @@ -4590,7 +4590,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 \ " @@ -4793,7 +4793,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 @@ -4821,9 +4821,9 @@ system and gives an overview of their function and contents. 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 @@ -4934,7 +4934,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:: @@ -5082,7 +5082,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 @@ -5319,18 +5319,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 @@ -5750,7 +5750,7 @@ 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. @@ -5784,7 +5784,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 \ @@ -5967,7 +5967,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 @@ -5975,7 +5975,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: @@ -5988,7 +5988,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 @@ -5997,7 +5997,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, @@ -6038,7 +6038,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 @@ -6067,7 +6067,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: @@ -6087,7 +6087,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 @@ -6222,7 +6222,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 @@ -6253,7 +6253,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 @@ -6266,7 +6266,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: @@ -6279,7 +6279,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 @@ -6291,7 +6291,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 @@ -6299,7 +6299,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: @@ -6312,7 +6312,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 @@ -6323,7 +6323,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 @@ -7584,7 +7584,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 @@ -7922,14 +7922,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 @@ -8203,7 +8203,7 @@ system and gives an overview of their function and contents. ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags for the x86 architecture as follows:: - TUNE_LDARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", d)}" + TUNE_LDARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32:x86_64", "", d)}" .. note:: @@ -8589,7 +8589,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" |