summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r--documentation/ref-manual/variables.rst152
1 files changed, 150 insertions, 2 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 591c03028c..a80ef364ed 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1526,6 +1526,11 @@ system and gives an overview of their function and contents.
1526 :term:`CC` 1526 :term:`CC`
1527 The minimal command and arguments used to run the C compiler. 1527 The minimal command and arguments used to run the C compiler.
1528 1528
1529 :term:`CCACHE_DISABLE`
1530 When inheriting the :ref:`ref-classes-ccache` class, the
1531 :term:`CCACHE_DISABLE` variable can be set to "1" in a recipe to disable
1532 `Ccache` support. This is useful when the recipe is known to not support it.
1533
1529 :term:`CCLD` 1534 :term:`CCLD`
1530 The minimal command and arguments used to run the linker when the C 1535 The minimal command and arguments used to run the linker when the C
1531 compiler is being used as the linker. 1536 compiler is being used as the linker.
@@ -3956,6 +3961,70 @@ system and gives an overview of their function and contents.
3956 material for Wic is located in the 3961 material for Wic is located in the
3957 ":doc:`/ref-manual/kickstart`" chapter. 3962 ":doc:`/ref-manual/kickstart`" chapter.
3958 3963
3964 :term:`IMAGE_EXTRA_PARTITION_FILES`
3965 A space-separated list of files installed into the extra partition(s)
3966 when preparing an image using the Wic tool with the
3967 ``extra_partition`` source plugin. By default,
3968 the files are
3969 installed under the same name as the source files. To change the
3970 installed name, separate it from the original name with a semi-colon
3971 (;). Source files need to be located in
3972 :term:`DEPLOY_DIR_IMAGE`. Here is an
3973 example::
3974
3975 IMAGE_EXTRA_PARTITION_FILES = "foobar file.conf;config"
3976
3977 In the above example, the file ``foobar`` is installed with its original name
3978 ``foobar``, while the file ``file.conf`` is installed and renamed to ``config``.
3979
3980 Alternatively, source files can be picked up using a glob pattern.
3981 However, hidden files are ignored, and the pattern is non-recursive
3982 (subdirectories are ignored).
3983 The destination file will have the same name as the base
3984 name of the source file path. To install files into a renamed directory
3985 within the target location, pass its name after a semi-colon (;).
3986 Here are two examples::
3987
3988 IMAGE_EXTRA_PARTITION_FILES = "foo/*"
3989 IMAGE_EXTRA_PARTITION_FILES = "foo/*;bar/"
3990
3991 The first line in this example
3992 installs all files from ``foo`` directory
3993 into the root of the target partition. The second line in this example installs
3994 the same files into a ``bar`` directory within the target partition.
3995 The ``bar/`` directory is automatically created if it does not exist.
3996
3997 You can also specify the target by label, UUID or partition name if multiple
3998 extra partitions coexist. Let's take the following example. This would be
3999 the WKS file for the image currently being built::
4000
4001 part --source extra_partition --fstype=ext4 --label foo
4002 part --source extra_partition --fstype=ext4 --uuid e7d0824e-cda3-4bed-9f54-9ef5312d105d
4003 part --source extra_partition --fstype=ext4 --part-name config
4004
4005 And the following configuration::
4006
4007 IMAGE_EXTRA_PARTITION_FILES_label-foo = "foo/*"
4008 IMAGE_EXTRA_PARTITION_FILES_uuid-e7d0824e-cda3-4bed-9f54-9ef5312d105d = "foo/*;bar/"
4009 IMAGE_EXTRA_PARTITION_FILES_part-name-config = "config"
4010
4011 Then:
4012
4013 - The partition labeled "foo" would get all files from the ``foo``
4014 directory.
4015
4016 - The partition whose UUID is "e7d0824e-cda3-4bed-9f54-9ef5312d105d"
4017 would get all files from the ``foo`` directory, installed into a
4018 ``bar`` directory.
4019
4020 - The partition named "config" would get the file ``config``.
4021
4022 You can find information on how to use the Wic tool in the
4023 ":ref:`dev-manual/wic:creating partitioned images using wic`"
4024 section of the Yocto Project Development Tasks Manual. Reference
4025 material for Wic is located in the
4026 ":doc:`/ref-manual/kickstart`" chapter.
4027
3959 :term:`IMAGE_FEATURES` 4028 :term:`IMAGE_FEATURES`
3960 The primary list of features to include in an image. Typically, you 4029 The primary list of features to include in an image. Typically, you
3961 configure this variable in an image recipe. Although you can use this 4030 configure this variable in an image recipe. Although you can use this
@@ -5454,7 +5523,7 @@ system and gives an overview of their function and contents.
5454 information on how this variable is used. 5523 information on how this variable is used.
5455 5524
5456 :term:`LAYERDEPENDS` 5525 :term:`LAYERDEPENDS`
5457 Lists the layers, separated by spaces, on which this recipe depends. 5526 Lists the layers, separated by spaces, on which this layer depends.
5458 Optionally, you can specify a specific layer version for a dependency 5527 Optionally, you can specify a specific layer version for a dependency
5459 by adding it to the end of the layer name. Here is an example:: 5528 by adding it to the end of the layer name. Here is an example::
5460 5529
@@ -7871,6 +7940,16 @@ system and gives an overview of their function and contents.
7871 :term:`REPODIR` 7940 :term:`REPODIR`
7872 See :term:`bitbake:REPODIR` in the BitBake manual. 7941 See :term:`bitbake:REPODIR` in the BitBake manual.
7873 7942
7943 :term:`REQUIRED_COMBINED_FEATURES`
7944 When inheriting the :ref:`ref-classes-features_check` class, this variable
7945 identifies combined features (the intersection of :term:`MACHINE_FEATURES`
7946 and :term:`DISTRO_FEATURES`) that must exist in the current configuration
7947 in order for the :term:`OpenEmbedded Build System` to build the recipe. In
7948 other words, if the :term:`REQUIRED_COMBINED_FEATURES` variable lists a
7949 feature that does not appear in :term:`COMBINED_FEATURES` within the
7950 current configuration, then the recipe will be skipped, and if the build
7951 system attempts to build the recipe then an error will be triggered.
7952
7874 :term:`REQUIRED_DISTRO_FEATURES` 7953 :term:`REQUIRED_DISTRO_FEATURES`
7875 When inheriting the :ref:`ref-classes-features_check` 7954 When inheriting the :ref:`ref-classes-features_check`
7876 class, this variable identifies distribution features that must exist 7955 class, this variable identifies distribution features that must exist
@@ -7881,6 +7960,41 @@ system and gives an overview of their function and contents.
7881 the recipe will be skipped, and if the build system attempts to build 7960 the recipe will be skipped, and if the build system attempts to build
7882 the recipe then an error will be triggered. 7961 the recipe then an error will be triggered.
7883 7962
7963 :term:`REQUIRED_IMAGE_FEATURES`
7964 When inheriting the :ref:`ref-classes-features_check` class, this variable
7965 identifies image features that must exist in the current
7966 configuration in order for the :term:`OpenEmbedded Build System` to build
7967 the recipe. In other words, if the :term:`REQUIRED_IMAGE_FEATURES` variable
7968 lists a feature that does not appear in :term:`IMAGE_FEATURES` within the
7969 current configuration, then the recipe will be skipped, and if the build
7970 system attempts to build the recipe then an error will be triggered.
7971
7972 Compared to other ``REQUIRED_*_FEATURES`` variables, the
7973 :term:`REQUIRED_IMAGE_FEATURES` varible only targets image recipes, as the
7974 :term:`IMAGE_FEATURES` variable is handled by the :ref:`ref-classes-core-image`
7975 class). However, the :term:`REQUIRED_IMAGE_FEATURES` varible can also be
7976 set from a :term:`Configuration File`, such as a distro
7977 configuration file, if the list of required image features should apply to
7978 all images using this :term:`DISTRO`.
7979
7980 :term:`REQUIRED_MACHINE_FEATURES`
7981 When inheriting the :ref:`ref-classes-features_check` class, this variable
7982 identifies :term:`MACHINE_FEATURES` that must exist in the current
7983 configuration in order for the :term:`OpenEmbedded Build System` to build
7984 the recipe. In other words, if the :term:`REQUIRED_MACHINE_FEATURES` variable
7985 lists a feature that does not appear in :term:`MACHINE_FEATURES` within the
7986 current configuration, then the recipe will be skipped, and if the build
7987 system attempts to build the recipe then an error will be triggered.
7988
7989 :term:`REQUIRED_TUNE_FEATURES`
7990 When inheriting the :ref:`ref-classes-features_check` class, this variable
7991 identifies tune features that must exist in the current configuration in
7992 order for the :term:`OpenEmbedded Build System` to build the recipe. In
7993 other words, if the :term:`REQUIRED_TUNE_FEATURES` variable lists a
7994 feature that does not appear in :term:`TUNE_FEATURES` within the current
7995 configuration, then the recipe will be skipped, and if the build system
7996 attempts to build the recipe then an error will be triggered.
7997
7884 :term:`REQUIRED_VERSION` 7998 :term:`REQUIRED_VERSION`
7885 If there are multiple versions of a recipe available, this variable 7999 If there are multiple versions of a recipe available, this variable
7886 determines which version should be given preference. 8000 determines which version should be given preference.
@@ -10792,6 +10906,12 @@ system and gives an overview of their function and contents.
10792 Please see the "Selection of Processor Architecture and Board Type" 10906 Please see the "Selection of Processor Architecture and Board Type"
10793 section in the U-Boot README for valid values for this variable. 10907 section in the U-Boot README for valid values for this variable.
10794 10908
10909 :term:`UBOOT_MAKE_OPTS`
10910 The :term:`UBOOT_MAKE_OPTS` variable can be used to pass extra options to
10911 ``make`` when U-Boot is configured and compiled.
10912
10913 See the :ref:`ref-classes-uboot-config` class for more information.
10914
10795 :term:`UBOOT_MAKE_TARGET` 10915 :term:`UBOOT_MAKE_TARGET`
10796 Specifies the target called in the ``Makefile``. The default target 10916 Specifies the target called in the ``Makefile``. The default target
10797 is "all". 10917 is "all".
@@ -10914,6 +11034,22 @@ system and gives an overview of their function and contents.
10914 `Unified Kernel Image (UKI) <https://uapi-group.org/specifications/specs/unified_kernel_image/>`__. 11034 `Unified Kernel Image (UKI) <https://uapi-group.org/specifications/specs/unified_kernel_image/>`__.
10915 Defaults to ``ukify build``. 11035 Defaults to ``ukify build``.
10916 11036
11037 :term:`UNINATIVE_CHECKSUM`
11038 When inheriting the :ref:`ref-classes-uninative` class, the
11039 :term:`UNINATIVE_CHECKSUM` variable flags contain the checksums of the
11040 uninative tarball as specified by the :term:`UNINATIVE_URL` variable.
11041 There should be one checksum per tarballs published at
11042 :term:`UNINATIVE_URL`, which match architectures. For example::
11043
11044 UNINATIVE_CHECKSUM[aarch64] ?= "812045d826b7fda88944055e8526b95a5a9440bfef608d5b53fd52faab49bf85"
11045 UNINATIVE_CHECKSUM[i686] ?= "5cc28efd0c15a75de4bcb147c6cce65f1c1c9d442173a220f08427f40a3ffa09"
11046 UNINATIVE_CHECKSUM[x86_64] ?= "4c03d1ed2b7b4e823aca4a1a23d8f2e322f1770fc10e859adcede5777aff4f3a"
11047
11048 :term:`UNINATIVE_URL`
11049 When inheriting the :ref:`ref-classes-uninative` class, the
11050 :term:`UNINATIVE_URL` variable contains the URL where the uninative
11051 tarballs are published.
11052
10917 :term:`UNKNOWN_CONFIGURE_OPT_IGNORE` 11053 :term:`UNKNOWN_CONFIGURE_OPT_IGNORE`
10918 Specifies a list of options that, if reported by the configure script 11054 Specifies a list of options that, if reported by the configure script
10919 as being invalid, should not generate a warning during the 11055 as being invalid, should not generate a warning during the
@@ -10933,7 +11069,7 @@ system and gives an overview of their function and contents.
10933 11069
10934 :term:`UNPACKDIR` 11070 :term:`UNPACKDIR`
10935 This variable, used by the :ref:`ref-classes-base` class, 11071 This variable, used by the :ref:`ref-classes-base` class,
10936 specifies where fetches sources should be unpacked by the 11072 specifies where fetched sources should be unpacked by the
10937 :ref:`ref-tasks-unpack` task. 11073 :ref:`ref-tasks-unpack` task.
10938 11074
10939 :term:`UPDATERCPN` 11075 :term:`UPDATERCPN`
@@ -11009,6 +11145,18 @@ system and gives an overview of their function and contents.
11009 the Yocto Project Development Tasks Manual for information on how to 11145 the Yocto Project Development Tasks Manual for information on how to
11010 use this variable. 11146 use this variable.
11011 11147
11148 :term:`USE_NLS`
11149 Determine if language translations should be built for recipes that can
11150 build them. This variable can be equal to:
11151
11152 - ``yes``: translations are enabled.
11153 - ``no``: translation are disabled.
11154
11155 Recipes can use the value of this variable to enable language
11156 translations in their build. Classes such as :ref:`ref-classes-gettext`
11157 use the value of this variable to enable :wikipedia:`Gettext <Gettext>`
11158 support.
11159
11012 :term:`USE_VT` 11160 :term:`USE_VT`
11013 When using 11161 When using
11014 :ref:`SysVinit <dev-manual/new-recipe:enabling system services>`, 11162 :ref:`SysVinit <dev-manual/new-recipe:enabling system services>`,