diff options
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r-- | documentation/ref-manual/variables.rst | 76 |
1 files changed, 37 insertions, 39 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 0b61f77cb4..a3401a4f1b 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -49,10 +49,9 @@ system and gives an overview of their function and contents. | |||
49 | alternatives system to create a different binary naming scheme so the | 49 | alternatives system to create a different binary naming scheme so the |
50 | commands can co-exist. | 50 | commands can co-exist. |
51 | 51 | ||
52 | To use the variable, list out the package's commands that also exist | 52 | To use the variable, list out the package's commands that are also |
53 | as part of another package. For example, if the ``busybox`` package | 53 | provided by another package. For example, if the ``busybox`` package |
54 | has four commands that also exist as part of another package, you | 54 | has four such commands, you identify them as follows:: |
55 | identify them as follows:: | ||
56 | 55 | ||
57 | ALTERNATIVE_busybox = "sh sed test bracket" | 56 | ALTERNATIVE_busybox = "sh sed test bracket" |
58 | 57 | ||
@@ -306,8 +305,8 @@ system and gives an overview of their function and contents. | |||
306 | variable), the OpenEmbedded build system ignores your request and | 305 | variable), the OpenEmbedded build system ignores your request and |
307 | will install the packages to avoid dependency errors. | 306 | will install the packages to avoid dependency errors. |
308 | 307 | ||
309 | Support for this variable exists only when using the IPK and RPM | 308 | This variable is supported only when using the IPK and RPM |
310 | packaging backend. Support does not exist for DEB. | 309 | packaging backends. DEB is not supported. |
311 | 310 | ||
312 | See the :term:`NO_RECOMMENDATIONS` and the | 311 | See the :term:`NO_RECOMMENDATIONS` and the |
313 | :term:`PACKAGE_EXCLUDE` variables for related | 312 | :term:`PACKAGE_EXCLUDE` variables for related |
@@ -336,8 +335,8 @@ system and gives an overview of their function and contents. | |||
336 | - This host list is only used if ``BB_NO_NETWORK`` is either not set | 335 | - This host list is only used if ``BB_NO_NETWORK`` is either not set |
337 | or set to "0". | 336 | or set to "0". |
338 | 337 | ||
339 | - Limited support for wildcard matching against the beginning of | 338 | - There is limited support for wildcard matching against the beginning of |
340 | host names exists. For example, the following setting matches | 339 | host names. For example, the following setting matches |
341 | ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``. | 340 | ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``. |
342 | :: | 341 | :: |
343 | 342 | ||
@@ -558,7 +557,7 @@ system and gives an overview of their function and contents. | |||
558 | 557 | ||
559 | :term:`BBCLASSEXTEND` | 558 | :term:`BBCLASSEXTEND` |
560 | 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 |
561 | software. Common variants for recipes exist such as "natives" like | 560 | software. There are common variants for recipes as "natives" like |
562 | ``quilt-native``, which is a copy of Quilt built to run on the build | 561 | ``quilt-native``, which is a copy of Quilt built to run on the build |
563 | system; "crosses" such as ``gcc-cross``, which is a compiler built to | 562 | system; "crosses" such as ``gcc-cross``, which is a compiler built to |
564 | run on the build machine but produces binaries that run on the target | 563 | run on the build machine but produces binaries that run on the target |
@@ -1237,7 +1236,7 @@ system and gives an overview of their function and contents. | |||
1237 | CONFFILES_${PN} += "${sysconfdir}/file1 \ | 1236 | CONFFILES_${PN} += "${sysconfdir}/file1 \ |
1238 | ${sysconfdir}/file2 ${sysconfdir}/file3" | 1237 | ${sysconfdir}/file2 ${sysconfdir}/file3" |
1239 | 1238 | ||
1240 | A relationship exists between the ``CONFFILES`` and ``FILES`` | 1239 | There is a relationship between the ``CONFFILES`` and ``FILES`` |
1241 | variables. The files listed within ``CONFFILES`` must be a subset of | 1240 | variables. The files listed within ``CONFFILES`` must be a subset of |
1242 | the files listed within ``FILES``. Because the configuration files | 1241 | the files listed within ``FILES``. Because the configuration files |
1243 | you provide with ``CONFFILES`` are simply being identified so that | 1242 | you provide with ``CONFFILES`` are simply being identified so that |
@@ -1417,8 +1416,8 @@ system and gives an overview of their function and contents. | |||
1417 | :term:`COREBASE_FILES` | 1416 | :term:`COREBASE_FILES` |
1418 | Lists files from the :term:`COREBASE` directory that | 1417 | Lists files from the :term:`COREBASE` directory that |
1419 | should be copied other than the layers listed in the | 1418 | should be copied other than the layers listed in the |
1420 | ``bblayers.conf`` file. The ``COREBASE_FILES`` variable exists for | 1419 | ``bblayers.conf`` file. The ``COREBASE_FILES`` variable allows |
1421 | the purpose of copying metadata from the OpenEmbedded build system | 1420 | to copy metadata from the OpenEmbedded build system |
1422 | into the extensible SDK. | 1421 | into the extensible SDK. |
1423 | 1422 | ||
1424 | Explicitly listing files in ``COREBASE`` is needed because it | 1423 | Explicitly listing files in ``COREBASE`` is needed because it |
@@ -2460,8 +2459,8 @@ system and gives an overview of their function and contents. | |||
2460 | ``FILESEXTRAPATHS`` variable. | 2459 | ``FILESEXTRAPATHS`` variable. |
2461 | 2460 | ||
2462 | You can take advantage of this searching behavior in useful ways. For | 2461 | You can take advantage of this searching behavior in useful ways. For |
2463 | example, consider a case where the following directory structure | 2462 | example, consider a case where there is the following directory structure |
2464 | exists for general and machine-specific configurations:: | 2463 | for general and machine-specific configurations:: |
2465 | 2464 | ||
2466 | files/defconfig | 2465 | files/defconfig |
2467 | files/MACHINEA/defconfig | 2466 | files/MACHINEA/defconfig |
@@ -3013,8 +3012,8 @@ system and gives an overview of their function and contents. | |||
3013 | 3012 | ||
3014 | Image recipes set ``IMAGE_INSTALL`` to specify the packages to | 3013 | Image recipes set ``IMAGE_INSTALL`` to specify the packages to |
3015 | install into an image through ``image.bbclass``. Additionally, | 3014 | install into an image through ``image.bbclass``. Additionally, |
3016 | "helper" classes such as the | 3015 | there are "helper" classes such as the |
3017 | :ref:`core-image <ref-classes-core-image>` class exist that can | 3016 | :ref:`core-image <ref-classes-core-image>` class which can |
3018 | take lists used with ``IMAGE_FEATURES`` and turn them into | 3017 | take lists used with ``IMAGE_FEATURES`` and turn them into |
3019 | auto-generated entries in ``IMAGE_INSTALL`` in addition to its | 3018 | auto-generated entries in ``IMAGE_INSTALL`` in addition to its |
3020 | default contents. | 3019 | default contents. |
@@ -3465,8 +3464,8 @@ system and gives an overview of their function and contents. | |||
3465 | Use of the ``INHIBIT_SYSROOT_STRIP`` variable occurs in rare and | 3464 | Use of the ``INHIBIT_SYSROOT_STRIP`` variable occurs in rare and |
3466 | special circumstances. For example, suppose you are building | 3465 | special circumstances. For example, suppose you are building |
3467 | bare-metal firmware by using an external GCC toolchain. Furthermore, | 3466 | bare-metal firmware by using an external GCC toolchain. Furthermore, |
3468 | even if the toolchain's binaries are strippable, other files exist | 3467 | even if the toolchain's binaries are strippable, there are other files |
3469 | that are needed for the build that are not strippable. | 3468 | needed for the build that are not strippable. |
3470 | 3469 | ||
3471 | :term:`INITRAMFS_FSTYPES` | 3470 | :term:`INITRAMFS_FSTYPES` |
3472 | Defines the format for the output image of an initial RAM filesystem | 3471 | Defines the format for the output image of an initial RAM filesystem |
@@ -3817,7 +3816,7 @@ system and gives an overview of their function and contents. | |||
3817 | 3816 | ||
3818 | .. note:: | 3817 | .. note:: |
3819 | 3818 | ||
3820 | Legacy support exists for specifying the full path to the device | 3819 | There is legacy support for specifying the full path to the device |
3821 | tree. However, providing just the ``.dtb`` file is preferred. | 3820 | tree. However, providing just the ``.dtb`` file is preferred. |
3822 | 3821 | ||
3823 | In order to use this variable, the | 3822 | In order to use this variable, the |
@@ -4042,7 +4041,7 @@ system and gives an overview of their function and contents. | |||
4042 | 4041 | ||
4043 | :term:`KERNELDEPMODDEPEND` | 4042 | :term:`KERNELDEPMODDEPEND` |
4044 | Specifies whether the data referenced through | 4043 | Specifies whether the data referenced through |
4045 | :term:`PKGDATA_DIR` is needed or not. The | 4044 | :term:`PKGDATA_DIR` is needed or not. |
4046 | ``KERNELDEPMODDEPEND`` does not control whether or not that data | 4045 | ``KERNELDEPMODDEPEND`` does not control whether or not that data |
4047 | exists, but simply whether or not it is used. If you do not need to | 4046 | exists, but simply whether or not it is used. If you do not need to |
4048 | use the data, set the ``KERNELDEPMODDEPEND`` variable in your | 4047 | use the data, set the ``KERNELDEPMODDEPEND`` variable in your |
@@ -4227,8 +4226,8 @@ system and gives an overview of their function and contents. | |||
4227 | - Separate license names using \| (pipe) when there is a choice | 4226 | - Separate license names using \| (pipe) when there is a choice |
4228 | between licenses. | 4227 | between licenses. |
4229 | 4228 | ||
4230 | - Separate license names using & (ampersand) when multiple licenses | 4229 | - Separate license names using & (ampersand) when there are |
4231 | exist that cover different parts of the source. | 4230 | multiple licenses for different parts of the source. |
4232 | 4231 | ||
4233 | - You can use spaces between license names. | 4232 | - You can use spaces between license names. |
4234 | 4233 | ||
@@ -4376,8 +4375,8 @@ system and gives an overview of their function and contents. | |||
4376 | 4375 | ||
4377 | The variable corresponds to a machine configuration file of the same | 4376 | The variable corresponds to a machine configuration file of the same |
4378 | name, through which machine-specific configurations are set. Thus, | 4377 | name, through which machine-specific configurations are set. Thus, |
4379 | when ``MACHINE`` is set to "qemux86" there exists the corresponding | 4378 | when ``MACHINE`` is set to "qemux86", the corresponding |
4380 | ``qemux86.conf`` machine configuration file, which can be found in | 4379 | ``qemux86.conf`` machine configuration file can be found in |
4381 | the :term:`Source Directory` in | 4380 | the :term:`Source Directory` in |
4382 | ``meta/conf/machine``. | 4381 | ``meta/conf/machine``. |
4383 | 4382 | ||
@@ -4742,7 +4741,7 @@ system and gives an overview of their function and contents. | |||
4742 | 4741 | ||
4743 | :term:`NO_GENERIC_LICENSE` | 4742 | :term:`NO_GENERIC_LICENSE` |
4744 | Avoids QA errors when you use a non-common, non-CLOSED license in a | 4743 | Avoids QA errors when you use a non-common, non-CLOSED license in a |
4745 | recipe. Packages exist, such as the linux-firmware package, with many | 4744 | recipe. There are packages, such as the linux-firmware package, with many |
4746 | licenses that are not in any way common. Also, new licenses are added | 4745 | licenses that are not in any way common. Also, new licenses are added |
4747 | occasionally to avoid introducing a lot of common license files, | 4746 | occasionally to avoid introducing a lot of common license files, |
4748 | which are only applicable to a specific package. | 4747 | which are only applicable to a specific package. |
@@ -4786,8 +4785,8 @@ system and gives an overview of their function and contents. | |||
4786 | functionality, such as kernel modules. It is up to you to add | 4785 | functionality, such as kernel modules. It is up to you to add |
4787 | packages with the :term:`IMAGE_INSTALL` variable. | 4786 | packages with the :term:`IMAGE_INSTALL` variable. |
4788 | 4787 | ||
4789 | Support for this variable exists only when using the IPK and RPM | 4788 | This variable is only supported when using the IPK and RPM |
4790 | packaging backend. Support does not exist for DEB. | 4789 | packaging backends. DEB is not supported. |
4791 | 4790 | ||
4792 | See the :term:`BAD_RECOMMENDATIONS` and | 4791 | See the :term:`BAD_RECOMMENDATIONS` and |
4793 | the :term:`PACKAGE_EXCLUDE` variables for | 4792 | the :term:`PACKAGE_EXCLUDE` variables for |
@@ -5064,8 +5063,8 @@ system and gives an overview of their function and contents. | |||
5064 | an iterative development process to remove specific components from a | 5063 | an iterative development process to remove specific components from a |
5065 | system. | 5064 | system. |
5066 | 5065 | ||
5067 | Support for this variable exists only when using the IPK and RPM | 5066 | This variable is supported only when using the IPK and RPM |
5068 | packaging backend. Support does not exist for DEB. | 5067 | packaging backends. DEB is not supported. |
5069 | 5068 | ||
5070 | See the :term:`NO_RECOMMENDATIONS` and the | 5069 | See the :term:`NO_RECOMMENDATIONS` and the |
5071 | :term:`BAD_RECOMMENDATIONS` variables for | 5070 | :term:`BAD_RECOMMENDATIONS` variables for |
@@ -6211,7 +6210,7 @@ system and gives an overview of their function and contents. | |||
6211 | :term:`PACKAGE_EXCLUDE` variables. | 6210 | :term:`PACKAGE_EXCLUDE` variables. |
6212 | 6211 | ||
6213 | Packages specified in ``RRECOMMENDS`` need not actually be produced. | 6212 | Packages specified in ``RRECOMMENDS`` need not actually be produced. |
6214 | However, a recipe must exist that provides each package, either | 6213 | However, there must be a recipe providing each package, either |
6215 | through the :term:`PACKAGES` or | 6214 | through the :term:`PACKAGES` or |
6216 | :term:`PACKAGES_DYNAMIC` variables or the | 6215 | :term:`PACKAGES_DYNAMIC` variables or the |
6217 | :term:`RPROVIDES` variable, or an error will occur | 6216 | :term:`RPROVIDES` variable, or an error will occur |
@@ -6979,8 +6978,8 @@ system and gives an overview of their function and contents. | |||
6979 | 6978 | ||
6980 | - ``az://`` - Fetches files from an Azure Storage account. | 6979 | - ``az://`` - Fetches files from an Azure Storage account. |
6981 | 6980 | ||
6982 | Standard and recipe-specific options for ``SRC_URI`` exist. Here are | 6981 | There are standard and recipe-specific options for ``SRC_URI``. Here are |
6983 | standard options: | 6982 | standard ones: |
6984 | 6983 | ||
6985 | - ``apply`` - Whether to apply the patch or not. The default | 6984 | - ``apply`` - Whether to apply the patch or not. The default |
6986 | action is to apply the patch. | 6985 | action is to apply the patch. |
@@ -7667,8 +7666,8 @@ system and gives an overview of their function and contents. | |||
7667 | :term:`TARGET_OS` | 7666 | :term:`TARGET_OS` |
7668 | Specifies the target's operating system. The variable can be set to | 7667 | Specifies the target's operating system. The variable can be set to |
7669 | "linux" for glibc-based systems (GNU C Library) and to "linux-musl" | 7668 | "linux" for glibc-based systems (GNU C Library) and to "linux-musl" |
7670 | for musl libc. For ARM/EABI targets, "linux-gnueabi" and | 7669 | for musl libc. For ARM/EABI targets, the possible values are |
7671 | "linux-musleabi" possible values exist. | 7670 | "linux-gnueabi" and "linux-musleabi". |
7672 | 7671 | ||
7673 | :term:`TARGET_PREFIX` | 7672 | :term:`TARGET_PREFIX` |
7674 | Specifies the prefix used for the toolchain binary target tools. | 7673 | Specifies the prefix used for the toolchain binary target tools. |
@@ -8369,11 +8368,10 @@ system and gives an overview of their function and contents. | |||
8369 | configure options are simply not passed to the configure script (e.g. | 8368 | configure options are simply not passed to the configure script (e.g. |
8370 | should be removed from :term:`EXTRA_OECONF` or | 8369 | should be removed from :term:`EXTRA_OECONF` or |
8371 | :term:`PACKAGECONFIG_CONFARGS`). | 8370 | :term:`PACKAGECONFIG_CONFARGS`). |
8372 | However, common options, for example, exist that are passed to all | 8371 | However, there are common options that are passed to all |
8373 | configure scripts at a class level that might not be valid for some | 8372 | configure scripts at a class level, but might not be valid for some |
8374 | configure scripts. It follows that no benefit exists in seeing a | 8373 | configure scripts. Therefore warnings about these options are useless. |
8375 | warning about these options. For these cases, the options are added | 8374 | For these cases, the options are added to ``UNKNOWN_CONFIGURE_WHITELIST``. |
8376 | to ``UNKNOWN_CONFIGURE_WHITELIST``. | ||
8377 | 8375 | ||
8378 | The configure arguments check that uses | 8376 | The configure arguments check that uses |
8379 | ``UNKNOWN_CONFIGURE_WHITELIST`` is part of the | 8377 | ``UNKNOWN_CONFIGURE_WHITELIST`` is part of the |