diff options
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r-- | documentation/ref-manual/variables.rst | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 00d45a79f0..354721d1a8 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -280,7 +280,7 @@ system and gives an overview of their function and contents. | |||
280 | S = "${WORKDIR}/${BP}" | 280 | S = "${WORKDIR}/${BP}" |
281 | 281 | ||
282 | You can separate the (:term:`S`) directory and the directory pointed to | 282 | You can separate the (:term:`S`) directory and the directory pointed to |
283 | by the ``B`` variable. Most Autotools-based recipes support | 283 | by the :term:`B` variable. Most Autotools-based recipes support |
284 | separating these directories. The build system defaults to using | 284 | separating these directories. The build system defaults to using |
285 | separate directories for ``gcc`` and some kernel recipes. | 285 | separate directories for ``gcc`` and some kernel recipes. |
286 | 286 | ||
@@ -553,7 +553,7 @@ system and gives an overview of their function and contents. | |||
553 | BB_SERVER_TIMEOUT = "20" | 553 | BB_SERVER_TIMEOUT = "20" |
554 | 554 | ||
555 | If you want the server to never be unloaded, | 555 | If you want the server to never be unloaded, |
556 | set ``BB_SERVER_TIMEOUT`` to "-1". | 556 | set :term:`BB_SERVER_TIMEOUT` to "-1". |
557 | 557 | ||
558 | :term:`BBCLASSEXTEND` | 558 | :term:`BBCLASSEXTEND` |
559 | Allows you to extend a recipe so that it builds variants of the | 559 | Allows you to extend a recipe so that it builds variants of the |
@@ -577,7 +577,7 @@ system and gives an overview of their function and contents. | |||
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 ``DEPENDS`` on "foo-native". | 580 | to a :term:`DEPENDS` on "foo-native". |
581 | 581 | ||
582 | Even when using :term:`BBCLASSEXTEND`, the recipe is only parsed once. | 582 | Even when using :term:`BBCLASSEXTEND`, the recipe is only parsed once. |
583 | Parsing once adds some limitations. For example, it is not | 583 | Parsing once adds some limitations. For example, it is not |
@@ -892,13 +892,13 @@ system and gives an overview of their function and contents. | |||
892 | the :term:`BUILD_CFLAGS` and | 892 | the :term:`BUILD_CFLAGS` and |
893 | :term:`BUILDSDK_CFLAGS` default values. | 893 | :term:`BUILDSDK_CFLAGS` default values. |
894 | 894 | ||
895 | The default value of the ``BUILD_OPTIMIZATION`` variable is "-O2 | 895 | The default value of the :term:`BUILD_OPTIMIZATION` variable is "-O2 |
896 | -pipe". | 896 | -pipe". |
897 | 897 | ||
898 | :term:`BUILD_OS` | 898 | :term:`BUILD_OS` |
899 | Specifies the operating system in use on the build host (e.g. | 899 | Specifies the operating system in use on the build host (e.g. |
900 | "linux"). The OpenEmbedded build system sets the value of | 900 | "linux"). The OpenEmbedded build system sets the value of |
901 | ``BUILD_OS`` from the OS reported by the ``uname`` command - the | 901 | :term:`BUILD_OS` from the OS reported by the ``uname`` command - the |
902 | first word, converted to lower-case characters. | 902 | first word, converted to lower-case characters. |
903 | 903 | ||
904 | :term:`BUILD_PREFIX` | 904 | :term:`BUILD_PREFIX` |
@@ -1114,7 +1114,7 @@ system and gives an overview of their function and contents. | |||
1114 | 1114 | ||
1115 | .. note:: | 1115 | .. note:: |
1116 | 1116 | ||
1117 | ``CLASSOVERRIDE`` gets its default "class-target" value from the | 1117 | :term:`CLASSOVERRIDE` gets its default "class-target" value from the |
1118 | ``bitbake.conf`` file. | 1118 | ``bitbake.conf`` file. |
1119 | 1119 | ||
1120 | As an example, the following override allows you to install extra | 1120 | As an example, the following override allows you to install extra |
@@ -1205,7 +1205,7 @@ system and gives an overview of their function and contents. | |||
1205 | 1205 | ||
1206 | :term:`COMPONENTS_DIR` | 1206 | :term:`COMPONENTS_DIR` |
1207 | Stores sysroot components for each recipe. The OpenEmbedded build | 1207 | Stores sysroot components for each recipe. The OpenEmbedded build |
1208 | system uses ``COMPONENTS_DIR`` when constructing recipe-specific | 1208 | system uses :term:`COMPONENTS_DIR` when constructing recipe-specific |
1209 | sysroots for other recipes. | 1209 | sysroots for other recipes. |
1210 | 1210 | ||
1211 | The default is | 1211 | The default is |
@@ -1611,7 +1611,7 @@ system and gives an overview of their function and contents. | |||
1611 | ":ref:`overview-manual/concepts:automatically added runtime dependencies`" | 1611 | ":ref:`overview-manual/concepts:automatically added runtime dependencies`" |
1612 | section in the Yocto Project Overview and Concepts Manual, | 1612 | section in the Yocto Project Overview and Concepts Manual, |
1613 | runtime dependencies will often be added automatically, meaning | 1613 | runtime dependencies will often be added automatically, meaning |
1614 | ``DEPENDS`` alone is sufficient for most recipes. | 1614 | :term:`DEPENDS` alone is sufficient for most recipes. |
1615 | 1615 | ||
1616 | - Counterintuitively, :term:`DEPENDS` is often necessary even for | 1616 | - Counterintuitively, :term:`DEPENDS` is often necessary even for |
1617 | recipes that install precompiled components. For example, if | 1617 | recipes that install precompiled components. For example, if |
@@ -1652,7 +1652,7 @@ system and gives an overview of their function and contents. | |||
1652 | "package_deb". | 1652 | "package_deb". |
1653 | 1653 | ||
1654 | The BitBake configuration file initially defines the | 1654 | The BitBake configuration file initially defines the |
1655 | ``DEPLOY_DIR_DEB`` variable as a sub-folder of | 1655 | :term:`DEPLOY_DIR_DEB` variable as a sub-folder of |
1656 | :term:`DEPLOY_DIR`:: | 1656 | :term:`DEPLOY_DIR`:: |
1657 | 1657 | ||
1658 | DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb" | 1658 | DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb" |
@@ -2568,7 +2568,7 @@ system and gives an overview of their function and contents. | |||
2568 | :term:`FONT_EXTRA_RDEPENDS` | 2568 | :term:`FONT_EXTRA_RDEPENDS` |
2569 | When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, | 2569 | When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, |
2570 | this variable specifies the runtime dependencies for font packages. | 2570 | this variable specifies the runtime dependencies for font packages. |
2571 | By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils". | 2571 | By default, the :term:`FONT_EXTRA_RDEPENDS` is set to "fontconfig-utils". |
2572 | 2572 | ||
2573 | :term:`FONT_PACKAGES` | 2573 | :term:`FONT_PACKAGES` |
2574 | When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, | 2574 | When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, |
@@ -3005,7 +3005,7 @@ system and gives an overview of their function and contents. | |||
3005 | 3005 | ||
3006 | - If an image recipe uses the "inherit image" line and you are | 3006 | - If an image recipe uses the "inherit image" line and you are |
3007 | setting :term:`IMAGE_FSTYPES` inside the recipe, you must set | 3007 | setting :term:`IMAGE_FSTYPES` inside the recipe, you must set |
3008 | ``IMAGE_FSTYPES`` prior to using the "inherit image" line. | 3008 | :term:`IMAGE_FSTYPES` prior to using the "inherit image" line. |
3009 | 3009 | ||
3010 | - Due to the way the OpenEmbedded build system processes this | 3010 | - Due to the way the OpenEmbedded build system processes this |
3011 | variable, you cannot update its contents by using ``_append`` | 3011 | variable, you cannot update its contents by using ``_append`` |
@@ -3334,13 +3334,13 @@ system and gives an overview of their function and contents. | |||
3334 | :term:`IMGDEPLOYDIR` | 3334 | :term:`IMGDEPLOYDIR` |
3335 | When inheriting the :ref:`image <ref-classes-image>` class directly or | 3335 | When inheriting the :ref:`image <ref-classes-image>` class directly or |
3336 | through the :ref:`core-image <ref-classes-core-image>` class, the | 3336 | through the :ref:`core-image <ref-classes-core-image>` class, the |
3337 | ``IMGDEPLOYDIR`` points to a temporary work area for deployed files | 3337 | :term:`IMGDEPLOYDIR` points to a temporary work area for deployed files |
3338 | that is set in the ``image`` class as follows:: | 3338 | that is set in the ``image`` class as follows:: |
3339 | 3339 | ||
3340 | IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete" | 3340 | IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete" |
3341 | 3341 | ||
3342 | Recipes inheriting the ``image`` class should copy files to be | 3342 | Recipes inheriting the ``image`` class should copy files to be |
3343 | deployed into ``IMGDEPLOYDIR``, and the class will take care of | 3343 | deployed into :term:`IMGDEPLOYDIR`, and the class will take care of |
3344 | copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. | 3344 | copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. |
3345 | 3345 | ||
3346 | :term:`INC_PR` | 3346 | :term:`INC_PR` |
@@ -3698,7 +3698,7 @@ system and gives an overview of their function and contents. | |||
3698 | - qemu | 3698 | - qemu |
3699 | - mips | 3699 | - mips |
3700 | 3700 | ||
3701 | You define the ``KARCH`` variable in the :ref:`kernel-dev/advanced:bsp descriptions`. | 3701 | You define the :term:`KARCH` variable in the :ref:`kernel-dev/advanced:bsp descriptions`. |
3702 | 3702 | ||
3703 | :term:`KBRANCH` | 3703 | :term:`KBRANCH` |
3704 | A regular expression used by the build process to explicitly identify | 3704 | A regular expression used by the build process to explicitly identify |
@@ -4653,7 +4653,7 @@ system and gives an overview of their function and contents. | |||
4653 | 4653 | ||
4654 | :term:`module_autoload` | 4654 | :term:`module_autoload` |
4655 | This variable has been replaced by the :term:`KERNEL_MODULE_AUTOLOAD` | 4655 | This variable has been replaced by the :term:`KERNEL_MODULE_AUTOLOAD` |
4656 | variable. You should replace all occurrences of ``module_autoload`` | 4656 | variable. You should replace all occurrences of :term:`module_autoload` |
4657 | with additions to :term:`KERNEL_MODULE_AUTOLOAD`, for example:: | 4657 | with additions to :term:`KERNEL_MODULE_AUTOLOAD`, for example:: |
4658 | 4658 | ||
4659 | module_autoload_rfcomm = "rfcomm" | 4659 | module_autoload_rfcomm = "rfcomm" |
@@ -4684,9 +4684,9 @@ system and gives an overview of their function and contents. | |||
4684 | You must use the kernel module name override. | 4684 | You must use the kernel module name override. |
4685 | 4685 | ||
4686 | Run ``man modprobe.d`` in the shell to find out more information on | 4686 | Run ``man modprobe.d`` in the shell to find out more information on |
4687 | the exact syntax you want to provide with ``module_conf``. | 4687 | the exact syntax you want to provide with :term:`module_conf`. |
4688 | 4688 | ||
4689 | Including ``module_conf`` causes the OpenEmbedded build system to | 4689 | Including :term:`module_conf` causes the OpenEmbedded build system to |
4690 | populate the ``/etc/modprobe.d/modname.conf`` file with | 4690 | populate the ``/etc/modprobe.d/modname.conf`` file with |
4691 | ``modprobe.d`` syntax lines. Here is an example that adds the options | 4691 | ``modprobe.d`` syntax lines. Here is an example that adds the options |
4692 | ``arg1`` and ``arg2`` to a module named ``mymodule``:: | 4692 | ``arg1`` and ``arg2`` to a module named ``mymodule``:: |
@@ -4876,7 +4876,7 @@ system and gives an overview of their function and contents. | |||
4876 | information, see the ":ref:`dev-manual/common-tasks:using a development shell`" section in | 4876 | information, see the ":ref:`dev-manual/common-tasks:using a development shell`" section in |
4877 | the Yocto Project Development Tasks Manual. | 4877 | the Yocto Project Development Tasks Manual. |
4878 | 4878 | ||
4879 | You can use the following values for the ``OE_TERMINAL`` variable: | 4879 | You can use the following values for the :term:`OE_TERMINAL` variable: |
4880 | 4880 | ||
4881 | - auto | 4881 | - auto |
4882 | - gnome | 4882 | - gnome |
@@ -5260,7 +5260,7 @@ system and gives an overview of their function and contents. | |||
5260 | PACKAGECONFIG[f2] = "\ | 5260 | PACKAGECONFIG[f2] = "\ |
5261 | ... and so on and so on ... | 5261 | ... and so on and so on ... |
5262 | 5262 | ||
5263 | The ``PACKAGECONFIG`` variable itself specifies a space-separated | 5263 | The :term:`PACKAGECONFIG` variable itself specifies a space-separated |
5264 | list of the features to enable. Following the features, you can | 5264 | list of the features to enable. Following the features, you can |
5265 | determine the behavior of each feature by providing up to six | 5265 | determine the behavior of each feature by providing up to six |
5266 | order-dependent arguments, which are separated by commas. You can | 5266 | order-dependent arguments, which are separated by commas. You can |
@@ -5600,7 +5600,7 @@ system and gives an overview of their function and contents. | |||
5600 | 5600 | ||
5601 | If applicable, the :term:`PN` variable also contains any special suffix | 5601 | If applicable, the :term:`PN` variable also contains any special suffix |
5602 | or prefix. For example, using ``bash`` to build packages for the | 5602 | or prefix. For example, using ``bash`` to build packages for the |
5603 | native machine, ``PN`` is ``bash-native``. Using ``bash`` to build | 5603 | native machine, :term:`PN` is ``bash-native``. Using ``bash`` to build |
5604 | packages for the target and for Multilib, :term:`PN` would be ``bash`` | 5604 | packages for the target and for Multilib, :term:`PN` would be ``bash`` |
5605 | and ``lib64-bash``, respectively. | 5605 | and ``lib64-bash``, respectively. |
5606 | 5606 | ||
@@ -5670,7 +5670,7 @@ system and gives an overview of their function and contents. | |||
5670 | :term:`PR` does not need to be increased for changes that do not change the | 5670 | :term:`PR` does not need to be increased for changes that do not change the |
5671 | package contents or metadata. | 5671 | package contents or metadata. |
5672 | 5672 | ||
5673 | Because manually managing ``PR`` can be cumbersome and error-prone, | 5673 | Because manually managing :term:`PR` can be cumbersome and error-prone, |
5674 | an automated solution exists. See the | 5674 | an automated solution exists. See the |
5675 | ":ref:`dev-manual/common-tasks:working with a pr service`" section | 5675 | ":ref:`dev-manual/common-tasks:working with a pr service`" section |
5676 | in the Yocto Project Development Tasks Manual for more information. | 5676 | in the Yocto Project Development Tasks Manual for more information. |
@@ -6042,7 +6042,7 @@ system and gives an overview of their function and contents. | |||
6042 | 6042 | ||
6043 | In the example, | 6043 | In the example, |
6044 | the development package depends on the ``perl`` package. Thus, the | 6044 | the development package depends on the ``perl`` package. Thus, the |
6045 | ``RDEPENDS`` variable has the ``${PN}-dev`` package name as part of | 6045 | :term:`RDEPENDS` variable has the ``${PN}-dev`` package name as part of |
6046 | the variable. | 6046 | the variable. |
6047 | 6047 | ||
6048 | .. note:: | 6048 | .. note:: |
@@ -7079,7 +7079,7 @@ system and gives an overview of their function and contents. | |||
7079 | 7079 | ||
7080 | :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` | 7080 | :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` |
7081 | By default, the OpenEmbedded build system automatically detects | 7081 | By default, the OpenEmbedded build system automatically detects |
7082 | whether ``SRC_URI`` contains files that are machine-specific. If so, | 7082 | whether :term:`SRC_URI` contains files that are machine-specific. If so, |
7083 | the build system automatically changes :term:`PACKAGE_ARCH`. Setting this | 7083 | the build system automatically changes :term:`PACKAGE_ARCH`. Setting this |
7084 | variable to "0" disables this behavior. | 7084 | variable to "0" disables this behavior. |
7085 | 7085 | ||
@@ -7292,7 +7292,7 @@ system and gives an overview of their function and contents. | |||
7292 | 7292 | ||
7293 | ``-native`` recipes are not installed into host paths like such | 7293 | ``-native`` recipes are not installed into host paths like such |
7294 | as ``/usr``. Rather, these recipes are installed into | 7294 | as ``/usr``. Rather, these recipes are installed into |
7295 | ``STAGING_DIR_NATIVE``. When compiling ``-native`` recipes, | 7295 | :term:`STAGING_DIR_NATIVE`. When compiling ``-native`` recipes, |
7296 | standard build environment variables such as | 7296 | standard build environment variables such as |
7297 | :term:`CPPFLAGS` and | 7297 | :term:`CPPFLAGS` and |
7298 | :term:`CFLAGS` are set up so that both host paths | 7298 | :term:`CFLAGS` are set up so that both host paths |
@@ -7726,13 +7726,13 @@ system and gives an overview of their function and contents. | |||
7726 | Specifies the prefix used for the toolchain binary target tools. | 7726 | Specifies the prefix used for the toolchain binary target tools. |
7727 | 7727 | ||
7728 | Depending on the type of recipe and the build target, | 7728 | Depending on the type of recipe and the build target, |
7729 | ``TARGET_PREFIX`` is set as follows: | 7729 | :term:`TARGET_PREFIX` is set as follows: |
7730 | 7730 | ||
7731 | - For recipes building for the target machine, the value is | 7731 | - For recipes building for the target machine, the value is |
7732 | "${:term:`TARGET_SYS`}-". | 7732 | "${:term:`TARGET_SYS`}-". |
7733 | 7733 | ||
7734 | - For native recipes, the build system sets the variable to the | 7734 | - For native recipes, the build system sets the variable to the |
7735 | value of ``BUILD_PREFIX``. | 7735 | value of :term:`BUILD_PREFIX`. |
7736 | 7736 | ||
7737 | - For native SDK recipes (``nativesdk``), the build system sets the | 7737 | - For native SDK recipes (``nativesdk``), the build system sets the |
7738 | variable to the value of :term:`SDK_PREFIX`. | 7738 | variable to the value of :term:`SDK_PREFIX`. |
@@ -7778,7 +7778,7 @@ system and gives an overview of their function and contents. | |||
7778 | separate to avoid potential conflicts. | 7778 | separate to avoid potential conflicts. |
7779 | 7779 | ||
7780 | In the ``defaultsetup.conf`` file, the default value of | 7780 | In the ``defaultsetup.conf`` file, the default value of |
7781 | ``TCLIBCAPPEND`` is "-${TCLIBC}". However, distros such as poky, | 7781 | :term:`TCLIBCAPPEND` is "-${TCLIBC}". However, distros such as poky, |
7782 | which normally only support one ``libc`` variant, set | 7782 | which normally only support one ``libc`` variant, set |
7783 | :term:`TCLIBCAPPEND` to "" in their distro configuration file resulting | 7783 | :term:`TCLIBCAPPEND` to "" in their distro configuration file resulting |
7784 | in no suffix being applied. | 7784 | in no suffix being applied. |
@@ -7960,7 +7960,7 @@ system and gives an overview of their function and contents. | |||
7960 | ``BaseTarget`` class, which is an abstract class that cannot be used | 7960 | ``BaseTarget`` class, which is an abstract class that cannot be used |
7961 | as a value of :term:`TEST_TARGET`. | 7961 | as a value of :term:`TEST_TARGET`. |
7962 | 7962 | ||
7963 | You can provide the following arguments with ``TEST_TARGET``: | 7963 | You can provide the following arguments with :term:`TEST_TARGET`: |
7964 | 7964 | ||
7965 | - *"qemu":* Boots a QEMU image and runs the tests. See the | 7965 | - *"qemu":* Boots a QEMU image and runs the tests. See the |
7966 | ":ref:`dev-manual/common-tasks:enabling runtime tests on qemu`" section | 7966 | ":ref:`dev-manual/common-tasks:enabling runtime tests on qemu`" section |
@@ -8298,7 +8298,7 @@ system and gives an overview of their function and contents. | |||
8298 | In this example, "sd" is selected as the configuration of the possible four for the | 8298 | In this example, "sd" is selected as the configuration of the possible four for the |
8299 | :term:`UBOOT_MACHINE`. The "sd" configuration defines | 8299 | :term:`UBOOT_MACHINE`. The "sd" configuration defines |
8300 | "mx6qsabreauto_config" as the value for :term:`UBOOT_MACHINE`, while the | 8300 | "mx6qsabreauto_config" as the value for :term:`UBOOT_MACHINE`, while the |
8301 | "sdcard" specifies the ``IMAGE_FSTYPES`` to use for the U-Boot image. | 8301 | "sdcard" specifies the :term:`IMAGE_FSTYPES` to use for the U-Boot image. |
8302 | 8302 | ||
8303 | For more information on how the :term:`UBOOT_CONFIG` is handled, see the | 8303 | For more information on how the :term:`UBOOT_CONFIG` is handled, see the |
8304 | :ref:`uboot-config <ref-classes-uboot-config>` | 8304 | :ref:`uboot-config <ref-classes-uboot-config>` |
@@ -8357,7 +8357,7 @@ system and gives an overview of their function and contents. | |||
8357 | :term:`UBOOT_MKIMAGE_DTCOPTS` | 8357 | :term:`UBOOT_MKIMAGE_DTCOPTS` |
8358 | Options for the device tree compiler passed to mkimage '-D' | 8358 | Options for the device tree compiler passed to mkimage '-D' |
8359 | feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. | 8359 | feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. |
8360 | If ``UBOOT_MKIMAGE_DTCOPTS`` is not set then kernel-fitimage will not | 8360 | If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then kernel-fitimage will not |
8361 | pass the ``-D`` option to mkimage. | 8361 | pass the ``-D`` option to mkimage. |
8362 | 8362 | ||
8363 | :term:`UBOOT_MKIMAGE_SIGN` | 8363 | :term:`UBOOT_MKIMAGE_SIGN` |