summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2025-07-29 13:30:05 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-08-08 23:41:11 +0100
commit215c63ed3cbab7938d0a0d23d7c9b982acad2111 (patch)
treeb0d9d94c662b230f1eea5f1634185cdbce7cfbda /documentation/ref-manual
parente2af60778563afa74e8c1fe09d96af148b0375db (diff)
downloadpoky-215c63ed3cbab7938d0a0d23d7c9b982acad2111.tar.gz
ref-manual/variables.rst: sort variables
documentation/scripts/check-glossaries returns: WARNING: ref-manual/variables.rst: entries are not properly sorted: --- original_list +++ sorted_list @@ -12,8 +12,8 @@ ASSUME_PROVIDED ASSUME_SHLIBS AUTO_LIBNAME_PKGS +AUTO_SYSLINUXMENU AUTOREV -AUTO_SYSLINUXMENU AUTOTOOLS_SCRIPT_PATH AVAILTUNES AZ_SAS @@ -28,8 +28,8 @@ BB_CACHEDIR BB_CHECK_SSL_CERTS BB_CONSOLELOG +BB_CURRENT_MC BB_CURRENTTASK -BB_CURRENT_MC BB_DEFAULT_TASK BB_DEFAULT_UMASK BB_DEFER_BBCLASSES @@ -188,13 +188,13 @@ CVE_CHECK_REPORT_PATCHED CVE_CHECK_SHOW_WARNINGS CVE_CHECK_SKIP_RECIPE +CVE_CHECK_STATUSMAP +CVE_CHECK_VEX_JUSTIFICATION CVE_DB_INCR_UPDATE_AGE_THRES CVE_DB_UPDATE_INTERVAL CVE_PRODUCT CVE_STATUS CVE_STATUS_GROUPS -CVE_CHECK_STATUSMAP -CVE_CHECK_VEX_JUSTIFICATION CVE_VERSION CVSDIR CXX @@ -254,9 +254,8 @@ EXCLUDE_FROM_WORLD EXTENDPE EXTENDPKGV +EXTERNAL_KERNEL_DEVICETREE EXTERNAL_KERNEL_TOOLS -EXTERNAL_KERNEL_DEVICETREE -KERNEL_LOCALVERSION EXTERNAL_TOOLCHAIN EXTERNALSRC EXTERNALSRC_BUILD @@ -267,8 +266,8 @@ EXTRA_OECMAKE EXTRA_OECONF EXTRA_OEMAKE +EXTRA_OEMESON EXTRA_OESCONS -EXTRA_OEMESON EXTRA_USERS_PARAMS EXTRANATIVEPATH FAKEROOT @@ -300,8 +299,8 @@ FIT_KEY_GENRSA_ARGS FIT_KEY_REQ_ARGS FIT_KEY_SIGN_PKCS +FIT_PAD_ALG FIT_SIGN_ALG -FIT_PAD_ALG FIT_SIGN_INDIVIDUAL FIT_SIGN_NUMBITS FIT_UBOOT_ENV @@ -431,6 +430,7 @@ KERNEL_IMAGE_NAME KERNEL_IMAGETYPE KERNEL_IMAGETYPES +KERNEL_LOCALVERSION KERNEL_MODULE_AUTOLOAD KERNEL_MODULE_PROBECONF KERNEL_PACKAGE_NAME @@ -505,15 +505,15 @@ OBJCOPY OBJDUMP OE_BINCONFIG_EXTRA_MANGLE -OECMAKE_GENERATOR OE_INIT_ENV_SCRIPT OE_SHARED_UMASK OE_TERMINAL -OEROOT +OECMAKE_GENERATOR OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS OEQA_REPRODUCIBLE_TEST_PACKAGE +OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS OEQA_REPRODUCIBLE_TEST_TARGET -OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS +OEROOT OLDEST_KERNEL OPKG_MAKE_INDEX_EXTRA_PARAMS OPKGBUILDCMD @@ -691,11 +691,11 @@ SPDX_ARCHIVE_PACKAGED SPDX_ARCHIVE_SOURCES SPDX_CUSTOM_ANNOTATION_VARS +SPDX_INCLUDE_COMPILED_SOURCES SPDX_INCLUDE_SOURCES -SPDX_INCLUDE_COMPILED_SOURCES SPDX_NAMESPACE_PREFIX +SPDX_PACKAGE_URL SPDX_PACKAGE_VERSION -SPDX_PACKAGE_URL SPDX_PRETTY SPDXLICENSEMAP SPECIAL_PKGSUFFIX @@ -707,12 +707,12 @@ SPL_SIGN_KEYNAME SPLASH SPLASH_IMAGES -SRCREV_FORMAT SRC_URI SRC_URI_OVERRIDES_PACKAGE_ARCH SRCDATE SRCPV SRCREV +SRCREV_FORMAT SRCTREECOVEREDTASKS SSTATE_DIR SSTATE_EXCLUDEDEPS_SYSROOT @@ -779,9 +779,9 @@ TARGET_PREFIX TARGET_SYS TARGET_VENDOR +TC_CXX_RUNTIME TCLIBC TCMODE -TC_CXX_RUNTIME TEMPLATECONF TEST_EXPORT_DIR TEST_EXPORT_ONLY @@ -804,9 +804,9 @@ TOOLCHAIN TOOLCHAIN_HOST_TASK TOOLCHAIN_HOST_TASK_ESDK +TOOLCHAIN_NATIVE TOOLCHAIN_OPTIONS TOOLCHAIN_OUTPUTNAME -TOOLCHAIN_NATIVE TOOLCHAIN_TARGET_TASK TOPDIR TRANSLATED_TARGET_ARCH @@ -860,13 +860,13 @@ UBOOT_SUFFIX UBOOT_TARGET UBOOT_VERSION -UKIFY_CMD UKI_CMDLINE UKI_CONFIG_FILE UKI_FILENAME UKI_KERNEL_FILENAME UKI_SB_CERT UKI_SB_KEY +UKIFY_CMD UNKNOWN_CONFIGURE_OPT_IGNORE UNPACKDIR UPDATERCPN @@ -897,7 +897,7 @@ WKS_FILES WORKDIR XSERVER +XZ_MEMLIMIT XZ_THREADS -XZ_MEMLIMIT ZSTD_COMPRESSION_LEVEL ZSTD_THREADS (From yocto-docs rev: 5cc4f262844a202553112a01f7203c9220d30fae) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/variables.rst258
1 files changed, 129 insertions, 129 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 15ca6543a1..d559899c6e 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -209,6 +209,11 @@ system and gives an overview of their function and contents.
209 :ref:`ref-classes-debian` class to act on all packages that are 209 :ref:`ref-classes-debian` class to act on all packages that are
210 explicitly generated by the recipe. 210 explicitly generated by the recipe.
211 211
212 :term:`AUTO_SYSLINUXMENU`
213 Enables creating an automatic menu for the syslinux bootloader. You
214 must set this variable in your recipe. The
215 :ref:`ref-classes-syslinux` class checks this variable.
216
212 :term:`AUTOREV` 217 :term:`AUTOREV`
213 When :term:`SRCREV` is set to the value of this variable, it specifies to 218 When :term:`SRCREV` is set to the value of this variable, it specifies to
214 use the latest source revision in the repository. Here is an example:: 219 use the latest source revision in the repository. Here is an example::
@@ -226,11 +231,6 @@ system and gives an overview of their function and contents.
226 ":ref:`dev-manual/packages:automatically incrementing a package version number`" 231 ":ref:`dev-manual/packages:automatically incrementing a package version number`"
227 section in the Yocto Project Development Tasks Manual. 232 section in the Yocto Project Development Tasks Manual.
228 233
229 :term:`AUTO_SYSLINUXMENU`
230 Enables creating an automatic menu for the syslinux bootloader. You
231 must set this variable in your recipe. The
232 :ref:`ref-classes-syslinux` class checks this variable.
233
234 :term:`AUTOTOOLS_SCRIPT_PATH` 234 :term:`AUTOTOOLS_SCRIPT_PATH`
235 When using the :ref:`ref-classes-autotools` class, the 235 When using the :ref:`ref-classes-autotools` class, the
236 :term:`AUTOTOOLS_SCRIPT_PATH` variable stores the location of the 236 :term:`AUTOTOOLS_SCRIPT_PATH` variable stores the location of the
@@ -400,12 +400,12 @@ system and gives an overview of their function and contents.
400 :term:`BB_CONSOLELOG` 400 :term:`BB_CONSOLELOG`
401 See :term:`bitbake:BB_CONSOLELOG` in the BitBake manual. 401 See :term:`bitbake:BB_CONSOLELOG` in the BitBake manual.
402 402
403 :term:`BB_CURRENTTASK`
404 See :term:`bitbake:BB_CURRENTTASK` in the BitBake manual.
405
406 :term:`BB_CURRENT_MC` 403 :term:`BB_CURRENT_MC`
407 See :term:`bitbake:BB_CURRENT_MC` in the BitBake manual. 404 See :term:`bitbake:BB_CURRENT_MC` in the BitBake manual.
408 405
406 :term:`BB_CURRENTTASK`
407 See :term:`bitbake:BB_CURRENTTASK` in the BitBake manual.
408
409 :term:`BB_DEFAULT_TASK` 409 :term:`BB_DEFAULT_TASK`
410 See :term:`bitbake:BB_DEFAULT_TASK` in the BitBake manual. 410 See :term:`bitbake:BB_DEFAULT_TASK` in the BitBake manual.
411 411
@@ -1998,6 +1998,20 @@ system and gives an overview of their function and contents.
1998 The list of package names (:term:`PN`) for which 1998 The list of package names (:term:`PN`) for which
1999 CVEs (Common Vulnerabilities and Exposures) are ignored. 1999 CVEs (Common Vulnerabilities and Exposures) are ignored.
2000 2000
2001 :term:`CVE_CHECK_STATUSMAP`
2002 Mapping variable for all possible reasons of :term:`CVE_STATUS`:
2003 ``Patched``, ``Unpatched`` and ``Ignored``.
2004 See :ref:`ref-classes-cve-check` or ``meta/conf/cve-check-map.conf`` for more details::
2005
2006 CVE_CHECK_STATUSMAP[cpe-incorrect] = "Ignored"
2007
2008 :term:`CVE_CHECK_VEX_JUSTIFICATION`
2009 Mapping variable for :term:`CVE_STATUS` reasons
2010 (for example ``not-applicable-platform``) to :ref:`ref-classes-vex`
2011 justifications. Should be set as follows::
2012
2013 CVE_CHECK_VEX_JUSTIFICATION[not-applicable-config] = "vulnerableCodeNotPresent"
2014
2001 :term:`CVE_DB_INCR_UPDATE_AGE_THRES` 2015 :term:`CVE_DB_INCR_UPDATE_AGE_THRES`
2002 Specifies the maximum age of the CVE database in seconds for an 2016 Specifies the maximum age of the CVE database in seconds for an
2003 incremental update (instead of a full-download). Use "0" to force a 2017 incremental update (instead of a full-download). Use "0" to force a
@@ -2053,20 +2067,6 @@ system and gives an overview of their function and contents.
2053 CVE_STATUS_PATCHED = "CVE-1234-0003 CVE-1234-0004" 2067 CVE_STATUS_PATCHED = "CVE-1234-0003 CVE-1234-0004"
2054 CVE_STATUS_PATCHED[status] = "fixed-version: Fixed externally" 2068 CVE_STATUS_PATCHED[status] = "fixed-version: Fixed externally"
2055 2069
2056 :term:`CVE_CHECK_STATUSMAP`
2057 Mapping variable for all possible reasons of :term:`CVE_STATUS`:
2058 ``Patched``, ``Unpatched`` and ``Ignored``.
2059 See :ref:`ref-classes-cve-check` or ``meta/conf/cve-check-map.conf`` for more details::
2060
2061 CVE_CHECK_STATUSMAP[cpe-incorrect] = "Ignored"
2062
2063 :term:`CVE_CHECK_VEX_JUSTIFICATION`
2064 Mapping variable for :term:`CVE_STATUS` reasons
2065 (for example ``not-applicable-platform``) to :ref:`ref-classes-vex`
2066 justifications. Should be set as follows::
2067
2068 CVE_CHECK_VEX_JUSTIFICATION[not-applicable-config] = "vulnerableCodeNotPresent"
2069
2070 :term:`CVE_VERSION` 2070 :term:`CVE_VERSION`
2071 In a recipe, defines the version used to match the recipe version 2071 In a recipe, defines the version used to match the recipe version
2072 against the version in the `NIST CVE database <https://nvd.nist.gov/>`__ 2072 against the version in the `NIST CVE database <https://nvd.nist.gov/>`__
@@ -2816,6 +2816,13 @@ system and gives an overview of their function and contents.
2816 The dependency relationships are intended to force the package 2816 The dependency relationships are intended to force the package
2817 manager to upgrade these types of packages in lock-step. 2817 manager to upgrade these types of packages in lock-step.
2818 2818
2819 :term:`EXTERNAL_KERNEL_DEVICETREE`
2820 When inheriting :ref:`ref-classes-kernel-fit-image` and a
2821 :term:`PREFERRED_PROVIDER` for ``virtual/dtb`` set to ``devicetree``, the
2822 variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a
2823 directory containing one or more compiled device tree or device tree
2824 overlays to use.
2825
2819 :term:`EXTERNAL_KERNEL_TOOLS` 2826 :term:`EXTERNAL_KERNEL_TOOLS`
2820 When set, the :term:`EXTERNAL_KERNEL_TOOLS` variable indicates that these 2827 When set, the :term:`EXTERNAL_KERNEL_TOOLS` variable indicates that these
2821 tools are not in the source tree. 2828 tools are not in the source tree.
@@ -2826,23 +2833,6 @@ system and gives an overview of their function and contents.
2826 external tools. See the :ref:`ref-classes-kernel-yocto` class in 2833 external tools. See the :ref:`ref-classes-kernel-yocto` class in
2827 ``meta/classes-recipe`` to see how the variable is used. 2834 ``meta/classes-recipe`` to see how the variable is used.
2828 2835
2829 :term:`EXTERNAL_KERNEL_DEVICETREE`
2830 When inheriting :ref:`ref-classes-kernel-fit-image` and a
2831 :term:`PREFERRED_PROVIDER` for ``virtual/dtb`` set to ``devicetree``, the
2832 variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a
2833 directory containing one or more compiled device tree or device tree
2834 overlays to use.
2835
2836 :term:`KERNEL_LOCALVERSION`
2837 This variable allows to append a string to the version
2838 of the kernel image. This corresponds to the ``CONFIG_LOCALVERSION``
2839 kernel configuration parameter.
2840
2841 Using this variable is only useful when you are using a kernel recipe
2842 inheriting the :ref:`ref-classes-kernel` class, and which doesn't
2843 already set a local version. Therefore, setting this variable has no
2844 impact on ``linux-yocto`` kernels.
2845
2846 :term:`EXTERNAL_TOOLCHAIN` 2836 :term:`EXTERNAL_TOOLCHAIN`
2847 When you intend to use an 2837 When you intend to use an
2848 :ref:`external toolchain <dev-manual/external-toolchain:optionally using an external toolchain>`, 2838 :ref:`external toolchain <dev-manual/external-toolchain:optionally using an external toolchain>`,
@@ -2969,11 +2959,6 @@ system and gives an overview of their function and contents.
2969 :term:`PARALLEL_MAKEINST` also make use of 2959 :term:`PARALLEL_MAKEINST` also make use of
2970 :term:`EXTRA_OEMAKE` to pass the required flags. 2960 :term:`EXTRA_OEMAKE` to pass the required flags.
2971 2961
2972 :term:`EXTRA_OESCONS`
2973 When inheriting the :ref:`ref-classes-scons` class, this
2974 variable specifies additional configuration options you want to pass
2975 to the ``scons`` command line.
2976
2977 :term:`EXTRA_OEMESON` 2962 :term:`EXTRA_OEMESON`
2978 Additional `Meson <https://mesonbuild.com/>`__ options. See the 2963 Additional `Meson <https://mesonbuild.com/>`__ options. See the
2979 :ref:`ref-classes-meson` class for additional information. 2964 :ref:`ref-classes-meson` class for additional information.
@@ -2988,6 +2973,11 @@ system and gives an overview of their function and contents.
2988 Note that any custom value for the Meson ``--buildtype`` option 2973 Note that any custom value for the Meson ``--buildtype`` option
2989 should be set through the :term:`MESON_BUILDTYPE` variable. 2974 should be set through the :term:`MESON_BUILDTYPE` variable.
2990 2975
2976 :term:`EXTRA_OESCONS`
2977 When inheriting the :ref:`ref-classes-scons` class, this
2978 variable specifies additional configuration options you want to pass
2979 to the ``scons`` command line.
2980
2991 :term:`EXTRA_USERS_PARAMS` 2981 :term:`EXTRA_USERS_PARAMS`
2992 When inheriting the :ref:`ref-classes-extrausers` 2982 When inheriting the :ref:`ref-classes-extrausers`
2993 class, this variable provides image level user and group operations. 2983 class, this variable provides image level user and group operations.
@@ -3428,16 +3418,16 @@ system and gives an overview of their function and contents.
3428 The default value is set to "x509" by the 3418 The default value is set to "x509" by the
3429 :ref:`ref-classes-kernel-fit-image` class. 3419 :ref:`ref-classes-kernel-fit-image` class.
3430 3420
3431 :term:`FIT_SIGN_ALG`
3432 Specifies the signature algorithm used in creating the FIT Image.
3433 This variable is set by default to "rsa2048" by the
3434 :ref:`ref-classes-kernel-fit-image` class.
3435
3436 :term:`FIT_PAD_ALG` 3421 :term:`FIT_PAD_ALG`
3437 Specifies the padding algorithm used in creating the FIT Image. 3422 Specifies the padding algorithm used in creating the FIT Image.
3438 The default value is set to "pkcs-1.5" by the 3423 The default value is set to "pkcs-1.5" by the
3439 :ref:`ref-classes-kernel-fit-image` class. 3424 :ref:`ref-classes-kernel-fit-image` class.
3440 3425
3426 :term:`FIT_SIGN_ALG`
3427 Specifies the signature algorithm used in creating the FIT Image.
3428 This variable is set by default to "rsa2048" by the
3429 :ref:`ref-classes-kernel-fit-image` class.
3430
3441 :term:`FIT_SIGN_INDIVIDUAL` 3431 :term:`FIT_SIGN_INDIVIDUAL`
3442 If set to "1", the :ref:`ref-classes-kernel-fit-image` class signs each 3432 If set to "1", the :ref:`ref-classes-kernel-fit-image` class signs each
3443 image node individually, including the kernel, DTB, RAM disk, and any 3433 image node individually, including the kernel, DTB, RAM disk, and any
@@ -5243,6 +5233,16 @@ system and gives an overview of their function and contents.
5243 to image type specified in :term:`KERNEL_IMAGETYPE`. Usually set by the 5233 to image type specified in :term:`KERNEL_IMAGETYPE`. Usually set by the
5244 machine configuration files. 5234 machine configuration files.
5245 5235
5236 :term:`KERNEL_LOCALVERSION`
5237 This variable allows to append a string to the version
5238 of the kernel image. This corresponds to the ``CONFIG_LOCALVERSION``
5239 kernel configuration parameter.
5240
5241 Using this variable is only useful when you are using a kernel recipe
5242 inheriting the :ref:`ref-classes-kernel` class, and which doesn't
5243 already set a local version. Therefore, setting this variable has no
5244 impact on ``linux-yocto`` kernels.
5245
5246 :term:`KERNEL_MODULE_AUTOLOAD` 5246 :term:`KERNEL_MODULE_AUTOLOAD`
5247 Lists kernel modules that need to be auto-loaded during boot. 5247 Lists kernel modules that need to be auto-loaded during boot.
5248 5248
@@ -6225,16 +6225,6 @@ system and gives an overview of their function and contents.
6225 :term:`Source Directory` for details on how this class 6225 :term:`Source Directory` for details on how this class
6226 applies these additional sed command arguments. 6226 applies these additional sed command arguments.
6227 6227
6228 :term:`OECMAKE_GENERATOR`
6229 A variable for the :ref:`ref-classes-cmake` class, allowing to choose
6230 which back-end will be generated by CMake to build an application.
6231
6232 By default, this variable is set to ``Ninja``, which is faster than GNU
6233 make, but if building is broken with Ninja, a recipe can use this
6234 variable to use GNU make instead::
6235
6236 OECMAKE_GENERATOR = "Unix Makefiles"
6237
6238 :term:`OE_INIT_ENV_SCRIPT` 6228 :term:`OE_INIT_ENV_SCRIPT`
6239 The name of the build environment setup script for the purposes of 6229 The name of the build environment setup script for the purposes of
6240 setting up the environment within the extensible SDK. The default 6230 setting up the environment within the extensible SDK. The default
@@ -6265,15 +6255,15 @@ system and gives an overview of their function and contents.
6265 - konsole 6255 - konsole
6266 - none 6256 - none
6267 6257
6268 :term:`OEROOT` 6258 :term:`OECMAKE_GENERATOR`
6269 The directory from which the top-level build environment setup script 6259 A variable for the :ref:`ref-classes-cmake` class, allowing to choose
6270 is sourced. The Yocto Project provides a top-level build environment 6260 which back-end will be generated by CMake to build an application.
6271 setup script: :ref:`structure-core-script`. When you run this
6272 script, the :term:`OEROOT` variable resolves to the directory that
6273 contains the script.
6274 6261
6275 For additional information on how this variable is used, see the 6262 By default, this variable is set to ``Ninja``, which is faster than GNU
6276 initialization script. 6263 make, but if building is broken with Ninja, a recipe can use this
6264 variable to use GNU make instead::
6265
6266 OECMAKE_GENERATOR = "Unix Makefiles"
6277 6267
6278 :term:`OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS` 6268 :term:`OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS`
6279 Set build target(s) for build reproducibility testing but activate 6269 Set build target(s) for build reproducibility testing but activate
@@ -6287,14 +6277,24 @@ system and gives an overview of their function and contents.
6287 See :yocto_git:`reproducible.py </poky/tree/meta/lib/oeqa/selftest/cases/reproducible.py>` 6277 See :yocto_git:`reproducible.py </poky/tree/meta/lib/oeqa/selftest/cases/reproducible.py>`
6288 and :doc:`/test-manual/reproducible-builds`. 6278 and :doc:`/test-manual/reproducible-builds`.
6289 6279
6280 :term:`OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS`
6281 Set build targets which can be rebuilt using :ref:`shared state <overview-manual/concepts:shared state cache>`
6282 when running build reproducibility tests. See :doc:`/test-manual/reproducible-builds`.
6283
6290 :term:`OEQA_REPRODUCIBLE_TEST_TARGET` 6284 :term:`OEQA_REPRODUCIBLE_TEST_TARGET`
6291 Set build target for build reproducibility testing. By default 6285 Set build target for build reproducibility testing. By default
6292 all available recipes are compiled with "bitbake world", see also :term:`EXCLUDE_FROM_WORLD` 6286 all available recipes are compiled with "bitbake world", see also :term:`EXCLUDE_FROM_WORLD`
6293 and :doc:`/test-manual/reproducible-builds`. 6287 and :doc:`/test-manual/reproducible-builds`.
6294 6288
6295 :term:`OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS` 6289 :term:`OEROOT`
6296 Set build targets which can be rebuilt using :ref:`shared state <overview-manual/concepts:shared state cache>` 6290 The directory from which the top-level build environment setup script
6297 when running build reproducibility tests. See :doc:`/test-manual/reproducible-builds`. 6291 is sourced. The Yocto Project provides a top-level build environment
6292 setup script: :ref:`structure-core-script`. When you run this
6293 script, the :term:`OEROOT` variable resolves to the directory that
6294 contains the script.
6295
6296 For additional information on how this variable is used, see the
6297 initialization script.
6298 6298
6299 :term:`OLDEST_KERNEL` 6299 :term:`OLDEST_KERNEL`
6300 Declares the oldest version of the Linux kernel that the produced 6300 Declares the oldest version of the Linux kernel that the produced
@@ -8782,27 +8782,6 @@ system and gives an overview of their function and contents.
8782 } 8782 }
8783 ], 8783 ],
8784 8784
8785 :term:`SPDX_INCLUDE_SOURCES`
8786 This option allows to add a description of the source files used to build
8787 the host tools and the target packages, to the ``spdx.json`` files in
8788 ``tmp/deploy/spdx/MACHINE/recipes/`` under the :term:`Build Directory`.
8789 As a consequence, the ``spdx.json`` files under the ``by-namespace`` and
8790 ``packages`` subdirectories in ``tmp/deploy/spdx/MACHINE`` are also
8791 modified to include references to such source file descriptions.
8792
8793 Enable this option as follows::
8794
8795 SPDX_INCLUDE_SOURCES = "1"
8796
8797 According to our tests on release 4.1 "langdale", building
8798 ``core-image-minimal`` for the ``qemux86-64`` machine, enabling
8799 this option multiplied the total size of the ``tmp/deploy/spdx``
8800 directory by a factor of 3 (+291 MiB for this image),
8801 and the size of the ``IMAGE-MACHINE.spdx.tar.zst`` in
8802 ``tmp/deploy/images/MACHINE`` by a factor of 130 (+15 MiB for this
8803 image), compared to just using the :ref:`ref-classes-create-spdx` class
8804 with no option.
8805
8806 :term:`SPDX_INCLUDE_COMPILED_SOURCES` 8785 :term:`SPDX_INCLUDE_COMPILED_SOURCES`
8807 This option allows the same as :term:`SPDX_INCLUDE_SOURCES` but including 8786 This option allows the same as :term:`SPDX_INCLUDE_SOURCES` but including
8808 only the sources used to compile the host tools and the target packages. 8787 only the sources used to compile the host tools and the target packages.
@@ -8825,22 +8804,43 @@ system and gives an overview of their function and contents.
8825 :term:`SPDX_INCLUDE_SOURCES` reduces the size of the ``tmp/deploy/spdx`` 8804 :term:`SPDX_INCLUDE_SOURCES` reduces the size of the ``tmp/deploy/spdx``
8826 directory from 2GB to 1.6GB. 8805 directory from 2GB to 1.6GB.
8827 8806
8807 :term:`SPDX_INCLUDE_SOURCES`
8808 This option allows to add a description of the source files used to build
8809 the host tools and the target packages, to the ``spdx.json`` files in
8810 ``tmp/deploy/spdx/MACHINE/recipes/`` under the :term:`Build Directory`.
8811 As a consequence, the ``spdx.json`` files under the ``by-namespace`` and
8812 ``packages`` subdirectories in ``tmp/deploy/spdx/MACHINE`` are also
8813 modified to include references to such source file descriptions.
8814
8815 Enable this option as follows::
8816
8817 SPDX_INCLUDE_SOURCES = "1"
8818
8819 According to our tests on release 4.1 "langdale", building
8820 ``core-image-minimal`` for the ``qemux86-64`` machine, enabling
8821 this option multiplied the total size of the ``tmp/deploy/spdx``
8822 directory by a factor of 3 (+291 MiB for this image),
8823 and the size of the ``IMAGE-MACHINE.spdx.tar.zst`` in
8824 ``tmp/deploy/images/MACHINE`` by a factor of 130 (+15 MiB for this
8825 image), compared to just using the :ref:`ref-classes-create-spdx` class
8826 with no option.
8827
8828 :term:`SPDX_NAMESPACE_PREFIX` 8828 :term:`SPDX_NAMESPACE_PREFIX`
8829 This option could be used in order to change the prefix of ``spdxDocument`` 8829 This option could be used in order to change the prefix of ``spdxDocument``
8830 and the prefix of ``documentNamespace``. It is set by default to 8830 and the prefix of ``documentNamespace``. It is set by default to
8831 ``http://spdx.org/spdxdoc``. 8831 ``http://spdx.org/spdxdoc``.
8832 8832
8833 :term:`SPDX_PACKAGE_VERSION`
8834 This variable controls the package version as seen in the SPDX 3.0 JSON
8835 output (``software_packageVersion``). The default value for this variable
8836 is :term:`PV`.
8837
8838 :term:`SPDX_PACKAGE_URL` 8833 :term:`SPDX_PACKAGE_URL`
8839 Provides a place for the SPDX data creator to record the package URL 8834 Provides a place for the SPDX data creator to record the package URL
8840 string (``software_packageUrl``, in accordance with the Package URL 8835 string (``software_packageUrl``, in accordance with the Package URL
8841 specification) for a software Package. The default value of this variable 8836 specification) for a software Package. The default value of this variable
8842 is an empty string. 8837 is an empty string.
8843 8838
8839 :term:`SPDX_PACKAGE_VERSION`
8840 This variable controls the package version as seen in the SPDX 3.0 JSON
8841 output (``software_packageVersion``). The default value for this variable
8842 is :term:`PV`.
8843
8844 :term:`SPDX_PRETTY` 8844 :term:`SPDX_PRETTY`
8845 This option makes the SPDX output more human-readable, using 8845 This option makes the SPDX output more human-readable, using
8846 identation and newlines, instead of the default output in a 8846 identation and newlines, instead of the default output in a
@@ -8962,9 +8962,6 @@ system and gives an overview of their function and contents.
8962 ":ref:`dev-manual/layers:appending other layers metadata with your layer`" 8962 ":ref:`dev-manual/layers:appending other layers metadata with your layer`"
8963 section. 8963 section.
8964 8964
8965 :term:`SRCREV_FORMAT`
8966 See :term:`bitbake:SRCREV_FORMAT` in the BitBake manual.
8967
8968 :term:`SRC_URI` 8965 :term:`SRC_URI`
8969 8966
8970 See the BitBake manual for the initial description for this variable: 8967 See the BitBake manual for the initial description for this variable:
@@ -9058,6 +9055,9 @@ system and gives an overview of their function and contents.
9058 ":ref:`dev-manual/packages:automatically incrementing a package version number`" 9055 ":ref:`dev-manual/packages:automatically incrementing a package version number`"
9059 section, which is in the Yocto Project Development Tasks Manual. 9056 section, which is in the Yocto Project Development Tasks Manual.
9060 9057
9058 :term:`SRCREV_FORMAT`
9059 See :term:`bitbake:SRCREV_FORMAT` in the BitBake manual.
9060
9061 :term:`SRCTREECOVEREDTASKS` 9061 :term:`SRCTREECOVEREDTASKS`
9062 A list of tasks that are typically not relevant (and therefore skipped) 9062 A list of tasks that are typically not relevant (and therefore skipped)
9063 when building using the :ref:`ref-classes-externalsrc` 9063 when building using the :ref:`ref-classes-externalsrc`
@@ -9847,6 +9847,12 @@ system and gives an overview of their function and contents.
9847 :term:`TARGET_VENDOR` 9847 :term:`TARGET_VENDOR`
9848 Specifies the name of the target vendor. 9848 Specifies the name of the target vendor.
9849 9849
9850 :term:`TC_CXX_RUNTIME`
9851 Specifies the C/C++ STL and runtime variant to use during
9852 the build process. Default value is 'gnu'
9853
9854 You can select "gnu", "llvm", or "android".
9855
9850 :term:`TCLIBC` 9856 :term:`TCLIBC`
9851 Specifies the GNU standard C library (``libc``) variant to use during 9857 Specifies the GNU standard C library (``libc``) variant to use during
9852 the build process. 9858 the build process.
@@ -9896,12 +9902,6 @@ system and gives an overview of their function and contents.
9896 up any pre-built objects in the toolchain such as ``libgcc``, 9902 up any pre-built objects in the toolchain such as ``libgcc``,
9897 ``libstdcc++``, any locales, and ``libc``. 9903 ``libstdcc++``, any locales, and ``libc``.
9898 9904
9899 :term:`TC_CXX_RUNTIME`
9900 Specifies the C/C++ STL and runtime variant to use during
9901 the build process. Default value is 'gnu'
9902
9903 You can select "gnu", "llvm", or "android".
9904
9905 :term:`TEMPLATECONF` 9905 :term:`TEMPLATECONF`
9906 Specifies the directory used by the build system to find templates 9906 Specifies the directory used by the build system to find templates
9907 from which to build the ``bblayers.conf`` and ``local.conf`` files. 9907 from which to build the ``bblayers.conf`` and ``local.conf`` files.
@@ -10201,6 +10201,18 @@ system and gives an overview of their function and contents.
10201 portion of an eSDK. This is similar to :term:`TOOLCHAIN_HOST_TASK` 10201 portion of an eSDK. This is similar to :term:`TOOLCHAIN_HOST_TASK`
10202 applying to SDKs. 10202 applying to SDKs.
10203 10203
10204 :term:`TOOLCHAIN_NATIVE`
10205 The :term:`TOOLCHAIN_NATIVE` variable can be used to override the
10206 toolchain used by a :ref:`ref-classes-native` recipe.
10207
10208 The default value for this variable is the value of
10209 :term:`PREFERRED_TOOLCHAIN` (in :ref:`ref-classes-native` contexts). See
10210 the description of :term:`PREFERRED_TOOLCHAIN` to know the list of
10211 possible values for :term:`TOOLCHAIN_NATIVE`.
10212
10213 It is possible to override the value of this variable from a recipe if
10214 this recipe is known to support only a specific toolchain.
10215
10204 :term:`TOOLCHAIN_OPTIONS` 10216 :term:`TOOLCHAIN_OPTIONS`
10205 This variable holds extra options passed to the compiler and the linker 10217 This variable holds extra options passed to the compiler and the linker
10206 for non ``-native`` recipes as they have to point to their custom 10218 for non ``-native`` recipes as they have to point to their custom
@@ -10223,18 +10235,6 @@ system and gives an overview of their function and contents.
10223 :term:`SDK_VERSION` variables for additional 10235 :term:`SDK_VERSION` variables for additional
10224 information. 10236 information.
10225 10237
10226 :term:`TOOLCHAIN_NATIVE`
10227 The :term:`TOOLCHAIN_NATIVE` variable can be used to override the
10228 toolchain used by a :ref:`ref-classes-native` recipe.
10229
10230 The default value for this variable is the value of
10231 :term:`PREFERRED_TOOLCHAIN` (in :ref:`ref-classes-native` contexts). See
10232 the description of :term:`PREFERRED_TOOLCHAIN` to know the list of
10233 possible values for :term:`TOOLCHAIN_NATIVE`.
10234
10235 It is possible to override the value of this variable from a recipe if
10236 this recipe is known to support only a specific toolchain.
10237
10238 :term:`TOOLCHAIN_TARGET_TASK` 10238 :term:`TOOLCHAIN_TARGET_TASK`
10239 This variable lists packages the OpenEmbedded build system uses when 10239 This variable lists packages the OpenEmbedded build system uses when
10240 it creates the target part of an SDK (i.e. the part built for the 10240 it creates the target part of an SDK (i.e. the part built for the
@@ -10828,12 +10828,6 @@ system and gives an overview of their function and contents.
10828 :term:`UBOOT_VERSION` variable contains this information, but can be 10828 :term:`UBOOT_VERSION` variable contains this information, but can be
10829 overridden if desired. 10829 overridden if desired.
10830 10830
10831 :term:`UKIFY_CMD`
10832 When inheriting the :ref:`ref-classes-uki` class,
10833 `ukify <https://www.freedesktop.org/software/systemd/man/latest/ukify.html>`__ command to build
10834 `Unified Kernel Image (UKI) <https://uapi-group.org/specifications/specs/unified_kernel_image/>`__.
10835 Defaults to ``ukify build``.
10836
10837 :term:`UKI_CMDLINE` 10831 :term:`UKI_CMDLINE`
10838 When inheriting the :ref:`ref-classes-uki` class, the kernel command line 10832 When inheriting the :ref:`ref-classes-uki` class, the kernel command line
10839 to use when booting the `Unified Kernel Image (UKI) 10833 to use when booting the `Unified Kernel Image (UKI)
@@ -10865,6 +10859,12 @@ system and gives an overview of their function and contents.
10865 secureboot private key to sign the `Unified Kernel Image (UKI) 10859 secureboot private key to sign the `Unified Kernel Image (UKI)
10866 <https://uapi-group.org/specifications/specs/unified_kernel_image/>`__. 10860 <https://uapi-group.org/specifications/specs/unified_kernel_image/>`__.
10867 10861
10862 :term:`UKIFY_CMD`
10863 When inheriting the :ref:`ref-classes-uki` class,
10864 `ukify <https://www.freedesktop.org/software/systemd/man/latest/ukify.html>`__ command to build
10865 `Unified Kernel Image (UKI) <https://uapi-group.org/specifications/specs/unified_kernel_image/>`__.
10866 Defaults to ``ukify build``.
10867
10868 :term:`UNKNOWN_CONFIGURE_OPT_IGNORE` 10868 :term:`UNKNOWN_CONFIGURE_OPT_IGNORE`
10869 Specifies a list of options that, if reported by the configure script 10869 Specifies a list of options that, if reported by the configure script
10870 as being invalid, should not generate a warning during the 10870 as being invalid, should not generate a warning during the
@@ -11277,6 +11277,12 @@ system and gives an overview of their function and contents.
11277 The default value of :term:`XSERVER`, if not specified in the machine 11277 The default value of :term:`XSERVER`, if not specified in the machine
11278 configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev". 11278 configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev".
11279 11279
11280 :term:`XZ_MEMLIMIT`
11281 Specifies the maximum memory the xz compression should use as a percentage
11282 of system memory. If unconstrained the xz compressor can use large amounts of
11283 memory and become problematic with parallelism elsewhere in the build.
11284 "50%" has been found to be a good value.
11285
11280 :term:`XZ_THREADS` 11286 :term:`XZ_THREADS`
11281 Specifies the number of parallel threads that should be used when 11287 Specifies the number of parallel threads that should be used when
11282 using xz compression. 11288 using xz compression.
@@ -11290,12 +11296,6 @@ system and gives an overview of their function and contents.
11290 On systems where many tasks run in parallel, setting a limit to this 11296 On systems where many tasks run in parallel, setting a limit to this
11291 can be helpful in controlling system resource usage. 11297 can be helpful in controlling system resource usage.
11292 11298
11293 :term:`XZ_MEMLIMIT`
11294 Specifies the maximum memory the xz compression should use as a percentage
11295 of system memory. If unconstrained the xz compressor can use large amounts of
11296 memory and become problematic with parallelism elsewhere in the build.
11297 "50%" has been found to be a good value.
11298
11299 :term:`ZSTD_COMPRESSION_LEVEL` 11299 :term:`ZSTD_COMPRESSION_LEVEL`
11300 Specifies the compression level to be used with ZStandard compression 11300 Specifies the compression level to be used with ZStandard compression
11301 (from ``1`` to ``19``, set to ``3`` by default, following upstream choice). 11301 (from ``1`` to ``19``, set to ``3`` by default, following upstream choice).