summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-03-15 14:35:57 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-03-16 14:25:02 +0000
commitd5663dd9cdaa6c8361e2b9f070411a3dd97d59fd (patch)
treeaaf7cc266f3a579e58575633d68eff74029c4ef2 /documentation
parentadbd2348c438bfe4d83afb7dc1bb6fc346eb8907 (diff)
downloadpoky-d5663dd9cdaa6c8361e2b9f070411a3dd97d59fd.tar.gz
ref-manual: reorder variable definitions
By alphabetical order, to get the same order as in the HTML output, sorted thanks to the ":sorted:" directive. That was needed after the recent variable renaming for inclusive language, but other variables were already out of order anyway. (From yocto-docs rev: 371c30d2f95fa32239c82d4ad8a6329ab191acca) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/variables.rst386
1 files changed, 193 insertions, 193 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 90842010c9..634f19a673 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -207,11 +207,6 @@ system and gives an overview of their function and contents.
207 The default value is "${PACKAGES}", which causes the debian class to 207 The default value is "${PACKAGES}", which causes the debian class to
208 act on all packages that are explicitly generated by the recipe. 208 act on all packages that are explicitly generated by the recipe.
209 209
210 :term:`AUTO_SYSLINUXMENU`
211 Enables creating an automatic menu for the syslinux bootloader. You
212 must set this variable in your recipe. The
213 :ref:`syslinux <ref-classes-syslinux>` class checks this variable.
214
215 :term:`AUTOREV` 210 :term:`AUTOREV`
216 When :term:`SRCREV` is set to the value of this variable, it specifies to 211 When :term:`SRCREV` is set to the value of this variable, it specifies to
217 use the latest source revision in the repository. Here is an example:: 212 use the latest source revision in the repository. Here is an example::
@@ -231,6 +226,11 @@ system and gives an overview of their function and contents.
231 ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" 226 ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`"
232 section in the Yocto Project Development Tasks Manual. 227 section in the Yocto Project Development Tasks Manual.
233 228
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:`syslinux <ref-classes-syslinux>` class checks this variable.
233
234 :term:`AVAILABLE_LICENSES` 234 :term:`AVAILABLE_LICENSES`
235 List of licenses found in the directories specified by 235 List of licenses found in the directories specified by
236 :term:`COMMON_LICENSE_DIR` and 236 :term:`COMMON_LICENSE_DIR` and
@@ -1307,6 +1307,40 @@ system and gives an overview of their function and contents.
1307 the recipe will be skipped, and if the build system attempts to build 1307 the recipe will be skipped, and if the build system attempts to build
1308 the recipe then an error will be triggered. 1308 the recipe then an error will be triggered.
1309 1309
1310 :term:`COPY_LIC_DIRS`
1311 If set to "1" along with the
1312 :term:`COPY_LIC_MANIFEST` variable, the
1313 OpenEmbedded build system copies into the image the license files,
1314 which are located in ``/usr/share/common-licenses``, for each
1315 package. The license files are placed in directories within the image
1316 itself during build time.
1317
1318 .. note::
1319
1320 The :term:`COPY_LIC_DIRS` does not offer a path for adding licenses for
1321 newly installed packages to an image, which might be most suitable for
1322 read-only filesystems that cannot be upgraded. See the
1323 :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
1324 You can also reference the ":ref:`dev-manual/common-tasks:providing license text`"
1325 section in the Yocto Project Development Tasks Manual for
1326 information on providing license text.
1327
1328 :term:`COPY_LIC_MANIFEST`
1329 If set to "1", the OpenEmbedded build system copies the license
1330 manifest for the image to
1331 ``/usr/share/common-licenses/license.manifest`` within the image
1332 itself during build time.
1333
1334 .. note::
1335
1336 The :term:`COPY_LIC_MANIFEST` does not offer a path for adding licenses for
1337 newly installed packages to an image, which might be most suitable for
1338 read-only filesystems that cannot be upgraded. See the
1339 :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
1340 You can also reference the ":ref:`dev-manual/common-tasks:providing license text`"
1341 section in the Yocto Project Development Tasks Manual for
1342 information on providing license text.
1343
1310 :term:`COPYLEFT_LICENSE_EXCLUDE` 1344 :term:`COPYLEFT_LICENSE_EXCLUDE`
1311 A space-separated list of licenses to exclude from the source 1345 A space-separated list of licenses to exclude from the source
1312 archived by the :ref:`archiver <ref-classes-archiver>` class. In 1346 archived by the :ref:`archiver <ref-classes-archiver>` class. In
@@ -1375,40 +1409,6 @@ system and gives an overview of their function and contents.
1375 is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>` 1409 is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>`
1376 class, which is inherited by the :ref:`archiver <ref-classes-archiver>` class. 1410 class, which is inherited by the :ref:`archiver <ref-classes-archiver>` class.
1377 1411
1378 :term:`COPY_LIC_DIRS`
1379 If set to "1" along with the
1380 :term:`COPY_LIC_MANIFEST` variable, the
1381 OpenEmbedded build system copies into the image the license files,
1382 which are located in ``/usr/share/common-licenses``, for each
1383 package. The license files are placed in directories within the image
1384 itself during build time.
1385
1386 .. note::
1387
1388 The :term:`COPY_LIC_DIRS` does not offer a path for adding licenses for
1389 newly installed packages to an image, which might be most suitable for
1390 read-only filesystems that cannot be upgraded. See the
1391 :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
1392 You can also reference the ":ref:`dev-manual/common-tasks:providing license text`"
1393 section in the Yocto Project Development Tasks Manual for
1394 information on providing license text.
1395
1396 :term:`COPY_LIC_MANIFEST`
1397 If set to "1", the OpenEmbedded build system copies the license
1398 manifest for the image to
1399 ``/usr/share/common-licenses/license.manifest`` within the image
1400 itself during build time.
1401
1402 .. note::
1403
1404 The :term:`COPY_LIC_MANIFEST` does not offer a path for adding licenses for
1405 newly installed packages to an image, which might be most suitable for
1406 read-only filesystems that cannot be upgraded. See the
1407 :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
1408 You can also reference the ":ref:`dev-manual/common-tasks:providing license text`"
1409 section in the Yocto Project Development Tasks Manual for
1410 information on providing license text.
1411
1412 :term:`CORE_IMAGE_EXTRA_INSTALL` 1412 :term:`CORE_IMAGE_EXTRA_INSTALL`
1413 Specifies the list of packages to be added to the image. You should 1413 Specifies the list of packages to be added to the image. You should
1414 only set this variable in the ``local.conf`` configuration file found 1414 only set this variable in the ``local.conf`` configuration file found
@@ -1473,10 +1473,6 @@ system and gives an overview of their function and contents.
1473 variable only in certain contexts (e.g. when building for kernel 1473 variable only in certain contexts (e.g. when building for kernel
1474 and kernel module recipes). 1474 and kernel module recipes).
1475 1475
1476 :term:`CVE_CHECK_SKIP_RECIPE`
1477 The list of package names (:term:`PN`) for which
1478 CVEs (Common Vulnerabilities and Exposures) are ignored.
1479
1480 :term:`CVE_CHECK_IGNORE` 1476 :term:`CVE_CHECK_IGNORE`
1481 The list of CVE IDs which are ignored. Here is 1477 The list of CVE IDs which are ignored. Here is
1482 an example from the :oe_layerindex:`Python3 recipe</layerindex/recipe/23823>`:: 1478 an example from the :oe_layerindex:`Python3 recipe</layerindex/recipe/23823>`::
@@ -1484,6 +1480,10 @@ system and gives an overview of their function and contents.
1484 # This is windows only issue. 1480 # This is windows only issue.
1485 CVE_CHECK_IGNORE += "CVE-2020-15523" 1481 CVE_CHECK_IGNORE += "CVE-2020-15523"
1486 1482
1483 :term:`CVE_CHECK_SKIP_RECIPE`
1484 The list of package names (:term:`PN`) for which
1485 CVEs (Common Vulnerabilities and Exposures) are ignored.
1486
1487 :term:`CVE_PRODUCT` 1487 :term:`CVE_PRODUCT`
1488 In a recipe, defines the name used to match the recipe name 1488 In a recipe, defines the name used to match the recipe name
1489 against the name in the upstream `NIST CVE database <https://nvd.nist.gov/>`__. 1489 against the name in the upstream `NIST CVE database <https://nvd.nist.gov/>`__.
@@ -1569,21 +1569,6 @@ system and gives an overview of their function and contents.
1569 compiling a system for debugging. This variable defaults to "-O 1569 compiling a system for debugging. This variable defaults to "-O
1570 -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe". 1570 -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe".
1571 1571
1572 :term:`DEFAULT_PREFERENCE`
1573 Specifies a weak bias for recipe selection priority.
1574
1575 The most common usage of this is variable is to set it to "-1" within
1576 a recipe for a development version of a piece of software. Using the
1577 variable in this way causes the stable version of the recipe to build
1578 by default in the absence of :term:`PREFERRED_VERSION` being used to
1579 build the development version.
1580
1581 .. note::
1582
1583 The bias provided by :term:`DEFAULT_PREFERENCE` is weak and is overridden
1584 by :term:`BBFILE_PRIORITY` if that variable is different between two
1585 layers that contain different versions of the same recipe.
1586
1587 :term:`DEBUG_PREFIX_MAP` 1572 :term:`DEBUG_PREFIX_MAP`
1588 Allows to set C compiler options, such as ``-fdebug-prefix-map``, 1573 Allows to set C compiler options, such as ``-fdebug-prefix-map``,
1589 ``-fmacro-prefix-map``, and ``-ffile-prefix-map``, which allow to 1574 ``-fmacro-prefix-map``, and ``-ffile-prefix-map``, which allow to
@@ -1601,6 +1586,21 @@ system and gives an overview of their function and contents.
1601 This variable is set in the ``meta/conf/bitbake.conf`` file. It is 1586 This variable is set in the ``meta/conf/bitbake.conf`` file. It is
1602 not intended to be user-configurable. 1587 not intended to be user-configurable.
1603 1588
1589 :term:`DEFAULT_PREFERENCE`
1590 Specifies a weak bias for recipe selection priority.
1591
1592 The most common usage of this is variable is to set it to "-1" within
1593 a recipe for a development version of a piece of software. Using the
1594 variable in this way causes the stable version of the recipe to build
1595 by default in the absence of :term:`PREFERRED_VERSION` being used to
1596 build the development version.
1597
1598 .. note::
1599
1600 The bias provided by :term:`DEFAULT_PREFERENCE` is weak and is overridden
1601 by :term:`BBFILE_PRIORITY` if that variable is different between two
1602 layers that contain different versions of the same recipe.
1603
1604 :term:`DEFAULTTUNE` 1604 :term:`DEFAULTTUNE`
1605 The default CPU and Application Binary Interface (ABI) tunings (i.e. 1605 The default CPU and Application Binary Interface (ABI) tunings (i.e.
1606 the "tune") used by the OpenEmbedded build system. The 1606 the "tune") used by the OpenEmbedded build system. The
@@ -2068,6 +2068,68 @@ system and gives an overview of their function and contents.
2068 can control with this variable, see the 2068 can control with this variable, see the
2069 ":ref:`ref-classes-insane`" section. 2069 ":ref:`ref-classes-insane`" section.
2070 2070
2071 :term:`ESDK_CLASS_INHERIT_DISABLE`
2072 A list of classes to remove from the :term:`INHERIT`
2073 value globally within the extensible SDK configuration. The
2074 :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the
2075 default value::
2076
2077 ESDK_CLASS_INHERIT_DISABLE ?= "buildhistory icecc"
2078
2079 Some classes are not generally applicable within the extensible SDK
2080 context. You can use this variable to disable those classes.
2081
2082 For additional information on how to customize the extensible SDK's
2083 configuration, see the
2084 ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
2085 section in the Yocto Project Application Development and the
2086 Extensible Software Development Kit (eSDK) manual.
2087
2088 :term:`ESDK_LOCALCONF_ALLOW`
2089 A list of variables allowed through from the OpenEmbedded build
2090 system configuration into the extensible SDK configuration. By
2091 default, the list of variables is empty and is set in the
2092 :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class.
2093
2094 This list overrides the variables specified using the
2095 :term:`ESDK_LOCALCONF_REMOVE` variable as well as
2096 other variables automatically added due to the "/" character
2097 being found at the start of the
2098 value, which is usually indicative of being a path and thus might not
2099 be valid on the system where the SDK is installed.
2100
2101 For additional information on how to customize the extensible SDK's
2102 configuration, see the
2103 ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
2104 section in the Yocto Project Application Development and the
2105 Extensible Software Development Kit (eSDK) manual.
2106
2107 :term:`ESDK_LOCALCONF_REMOVE`
2108 A list of variables not allowed through from the OpenEmbedded build
2109 system configuration into the extensible SDK configuration. Usually,
2110 these are variables that are specific to the machine on which the
2111 build system is running and thus would be potentially problematic
2112 within the extensible SDK.
2113
2114 By default, :term:`ESDK_LOCALCONF_REMOVE` is set in the
2115 :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class and
2116 excludes the following variables:
2117
2118 - :term:`CONF_VERSION`
2119 - :term:`BB_NUMBER_THREADS`
2120 - :term:`BB_NUMBER_PARSE_THREADS`
2121 - :term:`PARALLEL_MAKE`
2122 - :term:`PRSERV_HOST`
2123 - :term:`SSTATE_MIRRORS` :term:`DL_DIR`
2124 - :term:`SSTATE_DIR` :term:`TMPDIR`
2125 - :term:`BB_SERVER_TIMEOUT`
2126
2127 For additional information on how to customize the extensible SDK's
2128 configuration, see the
2129 ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
2130 section in the Yocto Project Application Development and the
2131 Extensible Software Development Kit (eSDK) manual.
2132
2071 :term:`EXCLUDE_FROM_SHLIBS` 2133 :term:`EXCLUDE_FROM_SHLIBS`
2072 Triggers the OpenEmbedded build system's shared libraries resolver to 2134 Triggers the OpenEmbedded build system's shared libraries resolver to
2073 exclude an entire package when scanning for shared libraries. 2135 exclude an entire package when scanning for shared libraries.
@@ -2235,16 +2297,6 @@ system and gives an overview of their function and contents.
2235 To add packages to the root filesystem, see the various 2297 To add packages to the root filesystem, see the various
2236 :term:`RDEPENDS` and :term:`RRECOMMENDS` variables. 2298 :term:`RDEPENDS` and :term:`RRECOMMENDS` variables.
2237 2299
2238 :term:`EXTRANATIVEPATH`
2239 A list of subdirectories of
2240 ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}``
2241 added to the beginning of the environment variable ``PATH``. As an
2242 example, the following prepends
2243 "${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" to
2244 ``PATH``::
2245
2246 EXTRANATIVEPATH = "foo bar"
2247
2248 :term:`EXTRA_OECMAKE` 2300 :term:`EXTRA_OECMAKE`
2249 Additional `CMake <https://cmake.org/overview/>`__ options. See the 2301 Additional `CMake <https://cmake.org/overview/>`__ options. See the
2250 :ref:`cmake <ref-classes-cmake>` class for additional information. 2302 :ref:`cmake <ref-classes-cmake>` class for additional information.
@@ -2301,6 +2353,16 @@ system and gives an overview of their function and contents.
2301 At present, ``passwd-expire`` may only work for remote logins when 2353 At present, ``passwd-expire`` may only work for remote logins when
2302 using OpenSSH and not dropbear as an SSH server. 2354 using OpenSSH and not dropbear as an SSH server.
2303 2355
2356 :term:`EXTRANATIVEPATH`
2357 A list of subdirectories of
2358 ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}``
2359 added to the beginning of the environment variable ``PATH``. As an
2360 example, the following prepends
2361 "${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" to
2362 ``PATH``::
2363
2364 EXTRANATIVEPATH = "foo bar"
2365
2304 :term:`FEATURE_PACKAGES` 2366 :term:`FEATURE_PACKAGES`
2305 Defines one or more packages to include in an image when a specific 2367 Defines one or more packages to include in an image when a specific
2306 item is included in :term:`IMAGE_FEATURES`. 2368 item is included in :term:`IMAGE_FEATURES`.
@@ -2594,10 +2656,6 @@ system and gives an overview of their function and contents.
2594 Specifies the signature algorithm used in creating the FIT Image. 2656 Specifies the signature algorithm used in creating the FIT Image.
2595 For e.g. rsa2048. 2657 For e.g. rsa2048.
2596 2658
2597 :term:`FIT_SIGN_NUMBITS`
2598 Size of private key in number of bits used in fitImage. The default
2599 value is "2048".
2600
2601 :term:`FIT_SIGN_INDIVIDUAL` 2659 :term:`FIT_SIGN_INDIVIDUAL`
2602 If set to "1", then the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` 2660 If set to "1", then the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>`
2603 class will sign the kernel, dtb and ramdisk images individually in addition 2661 class will sign the kernel, dtb and ramdisk images individually in addition
@@ -2605,6 +2663,10 @@ system and gives an overview of their function and contents.
2605 intending to verify signatures in another context than booting via 2663 intending to verify signatures in another context than booting via
2606 U-Boot. 2664 U-Boot.
2607 2665
2666 :term:`FIT_SIGN_NUMBITS`
2667 Size of private key in number of bits used in fitImage. The default
2668 value is "2048".
2669
2608 :term:`FONT_EXTRA_RDEPENDS` 2670 :term:`FONT_EXTRA_RDEPENDS`
2609 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, 2671 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class,
2610 this variable specifies the runtime dependencies for font packages. 2672 this variable specifies the runtime dependencies for font packages.
@@ -2801,6 +2863,10 @@ system and gives an overview of their function and contents.
2801 - Given a recipe being built for a little-endian MIPS target running 2863 - Given a recipe being built for a little-endian MIPS target running
2802 Linux, the value might be "mipsel-linux". 2864 Linux, the value might be "mipsel-linux".
2803 2865
2866 :term:`HOST_VENDOR`
2867 Specifies the name of the vendor. :term:`HOST_VENDOR` is normally the
2868 same as :term:`TARGET_VENDOR`.
2869
2804 :term:`HOSTTOOLS` 2870 :term:`HOSTTOOLS`
2805 A space-separated list (filter) of tools on the build host that 2871 A space-separated list (filter) of tools on the build host that
2806 should be allowed to be called from within build tasks. Using this 2872 should be allowed to be called from within build tasks. Using this
@@ -2821,9 +2887,15 @@ system and gives an overview of their function and contents.
2821 :term:`HOSTTOOLS_NONFATAL` is not found on the build host. Thus, you can 2887 :term:`HOSTTOOLS_NONFATAL` is not found on the build host. Thus, you can
2822 use :term:`HOSTTOOLS_NONFATAL` to filter optional host tools. 2888 use :term:`HOSTTOOLS_NONFATAL` to filter optional host tools.
2823 2889
2824 :term:`HOST_VENDOR` 2890 :term:`ICECC_CLASS_DISABLE`
2825 Specifies the name of the vendor. :term:`HOST_VENDOR` is normally the 2891 Identifies user classes that you do not want the Icecream distributed
2826 same as :term:`TARGET_VENDOR`. 2892 compile support to consider. This variable is used by the
2893 :ref:`icecc <ref-classes-icecc>` class. You set this variable in
2894 your ``local.conf`` file.
2895
2896 When you list classes using this variable, the recipes inheriting
2897 those classes will not benefit from distributed compilation across
2898 remote hosts. Instead they will be built locally.
2827 2899
2828 :term:`ICECC_DISABLED` 2900 :term:`ICECC_DISABLED`
2829 Disables or enables the ``icecc`` (Icecream) function. For more 2901 Disables or enables the ``icecc`` (Icecream) function. For more
@@ -2880,16 +2952,6 @@ system and gives an overview of their function and contents.
2880 this variable, the :ref:`icecc <ref-classes-icecc>` class attempts 2952 this variable, the :ref:`icecc <ref-classes-icecc>` class attempts
2881 to define it by locating ``icecc`` using ``which``. 2953 to define it by locating ``icecc`` using ``which``.
2882 2954
2883 :term:`ICECC_CLASS_DISABLE`
2884 Identifies user classes that you do not want the Icecream distributed
2885 compile support to consider. This variable is used by the
2886 :ref:`icecc <ref-classes-icecc>` class. You set this variable in
2887 your ``local.conf`` file.
2888
2889 When you list classes using this variable, the recipes inheriting
2890 those classes will not benefit from distributed compilation across
2891 remote hosts. Instead they will be built locally.
2892
2893 :term:`ICECC_RECIPE_DISABLE` 2955 :term:`ICECC_RECIPE_DISABLE`
2894 Identifies user recipes that you do not want the Icecream distributed 2956 Identifies user recipes that you do not want the Icecream distributed
2895 compile support to consider. This variable is used by the 2957 compile support to consider. This variable is used by the
@@ -2912,40 +2974,6 @@ system and gives an overview of their function and contents.
2912 The base name of image output files. This variable defaults to the 2974 The base name of image output files. This variable defaults to the
2913 recipe name (``${``\ :term:`PN`\ ``}``). 2975 recipe name (``${``\ :term:`PN`\ ``}``).
2914 2976
2915 :term:`IMAGE_EFI_BOOT_FILES`
2916 A space-separated list of files installed into the boot partition
2917 when preparing an image using the Wic tool with the
2918 ``bootimg-efi`` source plugin. By default,
2919 the files are
2920 installed under the same name as the source files. To change the
2921 installed name, separate it from the original name with a semi-colon
2922 (;). Source files need to be located in
2923 :term:`DEPLOY_DIR_IMAGE`. Here are two
2924 examples::
2925
2926 IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE};bz2"
2927 IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE} microcode.cpio"
2928
2929 Alternatively, source files can be picked up using a glob pattern. In
2930 this case, the destination file must have the same name as the base
2931 name of the source file path. To install files into a directory
2932 within the target location, pass its name after a semi-colon (;).
2933 Here are two examples::
2934
2935 IMAGE_EFI_BOOT_FILES = "boot/loader/*"
2936 IMAGE_EFI_BOOT_FILES = "boot/loader/*;boot/"
2937
2938 The first example
2939 installs all files from ``${DEPLOY_DIR_IMAGE}/boot/loader/``
2940 into the root of the target partition. The second example installs
2941 the same files into a ``boot`` directory within the target partition.
2942
2943 You can find information on how to use the Wic tool in the
2944 ":ref:`dev-manual/common-tasks:creating partitioned images using wic`"
2945 section of the Yocto Project Development Tasks Manual. Reference
2946 material for Wic is located in the
2947 ":doc:`/ref-manual/kickstart`" chapter.
2948
2949 :term:`IMAGE_BOOT_FILES` 2977 :term:`IMAGE_BOOT_FILES`
2950 A space-separated list of files installed into the boot partition 2978 A space-separated list of files installed into the boot partition
2951 when preparing an image using the Wic tool with the 2979 when preparing an image using the Wic tool with the
@@ -3018,6 +3046,40 @@ system and gives an overview of their function and contents.
3018 device table files, see ``meta/files/device_table-minimal.txt`` as an 3046 device table files, see ``meta/files/device_table-minimal.txt`` as an
3019 example. 3047 example.
3020 3048
3049 :term:`IMAGE_EFI_BOOT_FILES`
3050 A space-separated list of files installed into the boot partition
3051 when preparing an image using the Wic tool with the
3052 ``bootimg-efi`` source plugin. By default,
3053 the files are
3054 installed under the same name as the source files. To change the
3055 installed name, separate it from the original name with a semi-colon
3056 (;). Source files need to be located in
3057 :term:`DEPLOY_DIR_IMAGE`. Here are two
3058 examples::
3059
3060 IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE};bz2"
3061 IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE} microcode.cpio"
3062
3063 Alternatively, source files can be picked up using a glob pattern. In
3064 this case, the destination file must have the same name as the base
3065 name of the source file path. To install files into a directory
3066 within the target location, pass its name after a semi-colon (;).
3067 Here are two examples::
3068
3069 IMAGE_EFI_BOOT_FILES = "boot/loader/*"
3070 IMAGE_EFI_BOOT_FILES = "boot/loader/*;boot/"
3071
3072 The first example
3073 installs all files from ``${DEPLOY_DIR_IMAGE}/boot/loader/``
3074 into the root of the target partition. The second example installs
3075 the same files into a ``boot`` directory within the target partition.
3076
3077 You can find information on how to use the Wic tool in the
3078 ":ref:`dev-manual/common-tasks:creating partitioned images using wic`"
3079 section of the Yocto Project Development Tasks Manual. Reference
3080 material for Wic is located in the
3081 ":doc:`/ref-manual/kickstart`" chapter.
3082
3021 :term:`IMAGE_FEATURES` 3083 :term:`IMAGE_FEATURES`
3022 The primary list of features to include in an image. Typically, you 3084 The primary list of features to include in an image. Typically, you
3023 configure this variable in an image recipe. Although you can use this 3085 configure this variable in an image recipe. Although you can use this
@@ -5138,18 +5200,6 @@ system and gives an overview of their function and contents.
5138 ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section 5200 ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section
5139 in the Yocto Project Development Tasks Manual. 5201 in the Yocto Project Development Tasks Manual.
5140 5202
5141 :term:`PACKAGE_EXCLUDE_COMPLEMENTARY`
5142 Prevents specific packages from being installed when you are
5143 installing complementary packages.
5144
5145 You might find that you want to prevent installing certain packages
5146 when you are installing complementary packages. For example, if you
5147 are using :term:`IMAGE_FEATURES` to install
5148 ``dev-pkgs``, you might not want to install all packages from a
5149 particular multilib. If you find yourself in this situation, you can
5150 use the :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` variable to specify regular
5151 expressions to match the packages you want to exclude.
5152
5153 :term:`PACKAGE_EXCLUDE` 5203 :term:`PACKAGE_EXCLUDE`
5154 Lists packages that should not be installed into an image. For 5204 Lists packages that should not be installed into an image. For
5155 example:: 5205 example::
@@ -5177,6 +5227,18 @@ system and gives an overview of their function and contents.
5177 :term:`BAD_RECOMMENDATIONS` variables for 5227 :term:`BAD_RECOMMENDATIONS` variables for
5178 related information. 5228 related information.
5179 5229
5230 :term:`PACKAGE_EXCLUDE_COMPLEMENTARY`
5231 Prevents specific packages from being installed when you are
5232 installing complementary packages.
5233
5234 You might find that you want to prevent installing certain packages
5235 when you are installing complementary packages. For example, if you
5236 are using :term:`IMAGE_FEATURES` to install
5237 ``dev-pkgs``, you might not want to install all packages from a
5238 particular multilib. If you find yourself in this situation, you can
5239 use the :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` variable to specify regular
5240 expressions to match the packages you want to exclude.
5241
5180 :term:`PACKAGE_EXTRA_ARCHS` 5242 :term:`PACKAGE_EXTRA_ARCHS`
5181 Specifies the list of architectures compatible with the device CPU. 5243 Specifies the list of architectures compatible with the device CPU.
5182 This variable is useful when you build for several different devices 5244 This variable is useful when you build for several different devices
@@ -6535,68 +6597,6 @@ system and gives an overview of their function and contents.
6535 :term:`SDK_EXT_TYPE` is set to "minimal", and defaults to "1" if 6597 :term:`SDK_EXT_TYPE` is set to "minimal", and defaults to "1" if
6536 :term:`SDK_EXT_TYPE` is set to "full". 6598 :term:`SDK_EXT_TYPE` is set to "full".
6537 6599
6538 :term:`ESDK_CLASS_INHERIT_DISABLE`
6539 A list of classes to remove from the :term:`INHERIT`
6540 value globally within the extensible SDK configuration. The
6541 :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the
6542 default value::
6543
6544 ESDK_CLASS_INHERIT_DISABLE ?= "buildhistory icecc"
6545
6546 Some classes are not generally applicable within the extensible SDK
6547 context. You can use this variable to disable those classes.
6548
6549 For additional information on how to customize the extensible SDK's
6550 configuration, see the
6551 ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
6552 section in the Yocto Project Application Development and the
6553 Extensible Software Development Kit (eSDK) manual.
6554
6555 :term:`ESDK_LOCALCONF_REMOVE`
6556 A list of variables not allowed through from the OpenEmbedded build
6557 system configuration into the extensible SDK configuration. Usually,
6558 these are variables that are specific to the machine on which the
6559 build system is running and thus would be potentially problematic
6560 within the extensible SDK.
6561
6562 By default, :term:`ESDK_LOCALCONF_REMOVE` is set in the
6563 :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class and
6564 excludes the following variables:
6565
6566 - :term:`CONF_VERSION`
6567 - :term:`BB_NUMBER_THREADS`
6568 - :term:`BB_NUMBER_PARSE_THREADS`
6569 - :term:`PARALLEL_MAKE`
6570 - :term:`PRSERV_HOST`
6571 - :term:`SSTATE_MIRRORS` :term:`DL_DIR`
6572 - :term:`SSTATE_DIR` :term:`TMPDIR`
6573 - :term:`BB_SERVER_TIMEOUT`
6574
6575 For additional information on how to customize the extensible SDK's
6576 configuration, see the
6577 ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
6578 section in the Yocto Project Application Development and the
6579 Extensible Software Development Kit (eSDK) manual.
6580
6581 :term:`ESDK_LOCALCONF_ALLOW`
6582 A list of variables allowed through from the OpenEmbedded build
6583 system configuration into the extensible SDK configuration. By
6584 default, the list of variables is empty and is set in the
6585 :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class.
6586
6587 This list overrides the variables specified using the
6588 :term:`ESDK_LOCALCONF_REMOVE` variable as well as
6589 other variables automatically added due to the "/" character
6590 being found at the start of the
6591 value, which is usually indicative of being a path and thus might not
6592 be valid on the system where the SDK is installed.
6593
6594 For additional information on how to customize the extensible SDK's
6595 configuration, see the
6596 ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
6597 section in the Yocto Project Application Development and the
6598 Extensible Software Development Kit (eSDK) manual.
6599
6600 :term:`SDK_NAME` 6600 :term:`SDK_NAME`
6601 The base name for SDK output files. The name is derived from the 6601 The base name for SDK output files. The name is derived from the
6602 :term:`DISTRO`, :term:`TCLIBC`, 6602 :term:`DISTRO`, :term:`TCLIBC`,