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.rst128
1 files changed, 83 insertions, 45 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 5c18b852d1..c56418e2a2 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -265,7 +265,7 @@ system and gives an overview of their function and contents.
265 build process. By default, this directory is the same as the 265 build process. By default, this directory is the same as the
266 :term:`S` directory, which is defined as:: 266 :term:`S` directory, which is defined as::
267 267
268 S = "${WORKDIR}/${BP}" 268 S = "${UNPACKDIR}/${BP}"
269 269
270 You can separate the (:term:`S`) directory and the directory pointed to 270 You can separate the (:term:`S`) directory and the directory pointed to
271 by the :term:`B` variable. Most Autotools-based recipes support 271 by the :term:`B` variable. Most Autotools-based recipes support
@@ -560,6 +560,13 @@ system and gives an overview of their function and contents.
560 :term:`BB_GENERATE_SHALLOW_TARBALLS` 560 :term:`BB_GENERATE_SHALLOW_TARBALLS`
561 See :term:`bitbake:BB_GENERATE_SHALLOW_TARBALLS` in the BitBake manual. 561 See :term:`bitbake:BB_GENERATE_SHALLOW_TARBALLS` in the BitBake manual.
562 562
563 :term:`BB_GIT_DEFAULT_DESTSUFFIX`
564 See :term:`bitbake:BB_GIT_DEFAULT_DESTSUFFIX` in the BitBake manual.
565
566 In :term:`OpenEmbedded-Core (OE-Core)`, this variable is set to
567 :term:`BP` by default in :oe_git:`bitbake.conf
568 </openembedded-core/tree/meta/conf/bitbake.conf>`.
569
563 :term:`BB_GIT_SHALLOW` 570 :term:`BB_GIT_SHALLOW`
564 See :term:`bitbake:BB_GIT_SHALLOW` in the BitBake manual. 571 See :term:`bitbake:BB_GIT_SHALLOW` in the BitBake manual.
565 572
@@ -2576,7 +2583,7 @@ system and gives an overview of their function and contents.
2576 You can safely share this directory between multiple builds on the 2583 You can safely share this directory between multiple builds on the
2577 same development machine. For additional information on how the build 2584 same development machine. For additional information on how the build
2578 process gets source files when working behind a firewall or proxy 2585 process gets source files when working behind a firewall or proxy
2579 server, see this specific question in the ":doc:`faq`" 2586 server, see this specific question in the ":doc:`/ref-manual/faq`"
2580 chapter. You can also refer to the 2587 chapter. You can also refer to the
2581 ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" 2588 ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`"
2582 Wiki page. 2589 Wiki page.
@@ -2790,7 +2797,7 @@ system and gives an overview of their function and contents.
2790 ``meta/classes-recipe`` to see how the variable is used. 2797 ``meta/classes-recipe`` to see how the variable is used.
2791 2798
2792 :term:`EXTERNAL_KERNEL_DEVICETREE` 2799 :term:`EXTERNAL_KERNEL_DEVICETREE`
2793 When inheriting :ref:`ref-classes-kernel-fitimage` and a 2800 When inheriting :ref:`ref-classes-kernel-fit-image` and a
2794 :term:`PREFERRED_PROVIDER` for ``virtual/dtb`` set to ``devicetree``, the 2801 :term:`PREFERRED_PROVIDER` for ``virtual/dtb`` set to ``devicetree``, the
2795 variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a 2802 variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a
2796 directory containing one or more compiled device tree or device tree 2803 directory containing one or more compiled device tree or device tree
@@ -3318,7 +3325,7 @@ system and gives an overview of their function and contents.
3318 Specifies the value of the ``#address-cells`` value for the 3325 Specifies the value of the ``#address-cells`` value for the
3319 description of the FIT image. 3326 description of the FIT image.
3320 3327
3321 The default value is set to "1" by the :ref:`ref-classes-kernel-fitimage` 3328 The default value is set to "1" by the :ref:`ref-classes-kernel-fit-image`
3322 class, which corresponds to 32 bit addresses. 3329 class, which corresponds to 32 bit addresses.
3323 3330
3324 For platforms that need to set 64 bit addresses, for example in 3331 For platforms that need to set 64 bit addresses, for example in
@@ -3337,11 +3344,11 @@ system and gives an overview of their function and contents.
3337 Specifies the default device tree binary (dtb) file for a FIT image 3344 Specifies the default device tree binary (dtb) file for a FIT image
3338 when multiple ones are provided. 3345 when multiple ones are provided.
3339 3346
3340 This variable is used in the :ref:`ref-classes-kernel-fitimage` class. 3347 This variable is used in the :ref:`ref-classes-kernel-fit-image` class.
3341 3348
3342 :term:`FIT_DESC` 3349 :term:`FIT_DESC`
3343 Specifies the description string encoded into a FIT image. The 3350 Specifies the description string encoded into a FIT image. The
3344 default value is set by the :ref:`ref-classes-kernel-fitimage` class as 3351 default value is set by the :ref:`ref-classes-kernel-fit-image` class as
3345 follows:: 3352 follows::
3346 3353
3347 FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}" 3354 FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}"
@@ -3350,12 +3357,12 @@ system and gives an overview of their function and contents.
3350 Decides whether to generate the keys for signing the FIT image if 3357 Decides whether to generate the keys for signing the FIT image if
3351 they don't already exist. The keys are created in 3358 they don't already exist. The keys are created in
3352 :term:`UBOOT_SIGN_KEYDIR`. The default value is set to "0" 3359 :term:`UBOOT_SIGN_KEYDIR`. The default value is set to "0"
3353 by the :ref:`ref-classes-kernel-fitimage` class. 3360 by the :ref:`ref-classes-kernel-fit-image` class.
3354 3361
3355 :term:`FIT_HASH_ALG` 3362 :term:`FIT_HASH_ALG`
3356 Specifies the hash algorithm used in creating the FIT Image. 3363 Specifies the hash algorithm used in creating the FIT Image.
3357 This variable is set by default to "sha256" by the 3364 This variable is set by default to "sha256" by the
3358 :ref:`ref-classes-kernel-fitimage` class. 3365 :ref:`ref-classes-kernel-fit-image` class.
3359 3366
3360 :term:`FIT_KERNEL_COMP_ALG` 3367 :term:`FIT_KERNEL_COMP_ALG`
3361 The compression algorithm to use for the kernel image inside the FIT Image. 3368 The compression algorithm to use for the kernel image inside the FIT Image.
@@ -3374,31 +3381,31 @@ system and gives an overview of their function and contents.
3374 :term:`FIT_KEY_GENRSA_ARGS` 3381 :term:`FIT_KEY_GENRSA_ARGS`
3375 Arguments to ``openssl genrsa`` for generating a RSA private key for 3382 Arguments to ``openssl genrsa`` for generating a RSA private key for
3376 signing the FIT image. The default value is set to "-F4" by the 3383 signing the FIT image. The default value is set to "-F4" by the
3377 :ref:`ref-classes-kernel-fitimage` class. 3384 :ref:`ref-classes-kernel-fit-image` class.
3378 3385
3379 :term:`FIT_KEY_REQ_ARGS` 3386 :term:`FIT_KEY_REQ_ARGS`
3380 Arguments to ``openssl req`` for generating a certificate for signing 3387 Arguments to ``openssl req`` for generating a certificate for signing
3381 the FIT image. The default value is "-batch -new" by the 3388 the FIT image. The default value is "-batch -new" by the
3382 :ref:`ref-classes-kernel-fitimage` class, "batch" for 3389 :ref:`ref-classes-kernel-fit-image` class, "batch" for
3383 non interactive mode and "new" for generating new keys. 3390 non interactive mode and "new" for generating new keys.
3384 3391
3385 :term:`FIT_KEY_SIGN_PKCS` 3392 :term:`FIT_KEY_SIGN_PKCS`
3386 Format for the public key certificate used for signing the FIT image. 3393 Format for the public key certificate used for signing the FIT image.
3387 The default value is set to "x509" by the 3394 The default value is set to "x509" by the
3388 :ref:`ref-classes-kernel-fitimage` class. 3395 :ref:`ref-classes-kernel-fit-image` class.
3389 3396
3390 :term:`FIT_SIGN_ALG` 3397 :term:`FIT_SIGN_ALG`
3391 Specifies the signature algorithm used in creating the FIT Image. 3398 Specifies the signature algorithm used in creating the FIT Image.
3392 This variable is set by default to "rsa2048" by the 3399 This variable is set by default to "rsa2048" by the
3393 :ref:`ref-classes-kernel-fitimage` class. 3400 :ref:`ref-classes-kernel-fit-image` class.
3394 3401
3395 :term:`FIT_PAD_ALG` 3402 :term:`FIT_PAD_ALG`
3396 Specifies the padding algorithm used in creating the FIT Image. 3403 Specifies the padding algorithm used in creating the FIT Image.
3397 The default value is set to "pkcs-1.5" by the 3404 The default value is set to "pkcs-1.5" by the
3398 :ref:`ref-classes-kernel-fitimage` class. 3405 :ref:`ref-classes-kernel-fit-image` class.
3399 3406
3400 :term:`FIT_SIGN_INDIVIDUAL` 3407 :term:`FIT_SIGN_INDIVIDUAL`
3401 If set to "1", the :ref:`ref-classes-kernel-fitimage` class signs each 3408 If set to "1", the :ref:`ref-classes-kernel-fit-image` class signs each
3402 image node individually, including the kernel, DTB, RAM disk, and any 3409 image node individually, including the kernel, DTB, RAM disk, and any
3403 other image types present in the FIT image, in addition to signing the 3410 other image types present in the FIT image, in addition to signing the
3404 configuration nodes. 3411 configuration nodes.
@@ -3431,13 +3438,13 @@ system and gives an overview of their function and contents.
3431 :term:`FIT_SIGN_NUMBITS` 3438 :term:`FIT_SIGN_NUMBITS`
3432 Size of the private key used in the FIT image, in number of bits. 3439 Size of the private key used in the FIT image, in number of bits.
3433 The default value for this variable is set to "2048" 3440 The default value for this variable is set to "2048"
3434 by the :ref:`ref-classes-kernel-fitimage` class. 3441 by the :ref:`ref-classes-kernel-fit-image` class.
3435 3442
3436 :term:`FIT_UBOOT_ENV` 3443 :term:`FIT_UBOOT_ENV`
3437 This variable allows to add a U-Boot script as a text file to the 3444 This variable allows to add a U-Boot script as a text file to the
3438 FIT image. Such a script can be sourced from the U-Boot shell. 3445 FIT image. Such a script can be sourced from the U-Boot shell.
3439 3446
3440 When inheriting the :ref:`ref-classes-kernel-fitimage` class a 3447 When inheriting the :ref:`ref-classes-kernel-fit-image` class a
3441 script file should be included in the :term:`SRC_URI` of the Linux 3448 script file should be included in the :term:`SRC_URI` of the Linux
3442 kernel recipe. 3449 kernel recipe.
3443 3450
@@ -5075,9 +5082,7 @@ system and gives an overview of their function and contents.
5075 :term:`KERNEL_CLASSES` 5082 :term:`KERNEL_CLASSES`
5076 A list of classes defining kernel image types that the 5083 A list of classes defining kernel image types that the
5077 :ref:`ref-classes-kernel` class should inherit. You typically 5084 :ref:`ref-classes-kernel` class should inherit. You typically
5078 append this variable to enable extended image types. An example is 5085 append this variable to enable extended image types.
5079 ":ref:`ref-classes-kernel-fitimage`", which enables
5080 FIT image support and resides in ``meta/classes-recipe/kernel-fitimage.bbclass``.
5081 You can register custom kernel image types with the 5086 You can register custom kernel image types with the
5082 :ref:`ref-classes-kernel` class using this variable. 5087 :ref:`ref-classes-kernel` class using this variable.
5083 5088
@@ -5352,6 +5357,27 @@ system and gives an overview of their function and contents.
5352 the :term:`KERNEL_PATH` variable. Both variables are common variables 5357 the :term:`KERNEL_PATH` variable. Both variables are common variables
5353 used by external Makefiles to point to the kernel source directory. 5358 used by external Makefiles to point to the kernel source directory.
5354 5359
5360 :term:`KERNEL_SPLIT_MODULES`
5361 When inheriting the :ref:`ref-classes-kernel-module-split` class, this
5362 variable controls whether kernel modules are split into separate packages
5363 or bundled into a single package.
5364
5365 For some use cases, a monolithic kernel module package
5366 :term:`KERNEL_PACKAGE_NAME` that contains all modules built from the
5367 kernel sources may be preferred to speed up the installation.
5368
5369 By default, this variable is set to ``1``, resulting in one package per
5370 module. Setting it to any other value will generate a single monolithic
5371 package containing all kernel modules.
5372
5373 .. note::
5374
5375 If :term:`KERNEL_SPLIT_MODULES` is set to 0, it is still possible to
5376 install all kernel modules at once by adding ``kernel-modules`` (assuming
5377 :term:`KERNEL_PACKAGE_NAME` is ``kernel-modules``) to :term:`IMAGE_INSTALL`.
5378 The way it works is that a placeholder "kernel-modules" package will be
5379 created and will depend on every other individual kernel module packages.
5380
5355 :term:`KERNEL_SRC` 5381 :term:`KERNEL_SRC`
5356 The location of the kernel sources. This variable is set to the value 5382 The location of the kernel sources. This variable is set to the value
5357 of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module` 5383 of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module`
@@ -8041,7 +8067,7 @@ system and gives an overview of their function and contents.
8041 :term:`S` 8067 :term:`S`
8042 The location in the :term:`Build Directory` where 8068 The location in the :term:`Build Directory` where
8043 unpacked recipe source code resides. By default, this directory is 8069 unpacked recipe source code resides. By default, this directory is
8044 ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, 8070 ``${``\ :term:`UNPACKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``,
8045 where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe 8071 where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe
8046 version. If the source tarball extracts the code to a directory named 8072 version. If the source tarball extracts the code to a directory named
8047 anything other than ``${BPN}-${PV}``, or if the source code is 8073 anything other than ``${BPN}-${PV}``, or if the source code is
@@ -8054,19 +8080,10 @@ system and gives an overview of their function and contents.
8054 ``poky/build``. In this case, the work directory the build system 8080 ``poky/build``. In this case, the work directory the build system
8055 uses to keep the unpacked recipe for ``db`` is the following:: 8081 uses to keep the unpacked recipe for ``db`` is the following::
8056 8082
8057 poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19 8083 poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/sources/db-5.1.19
8058 8084
8059 The unpacked source code resides in the ``db-5.1.19`` folder. 8085 The unpacked source code resides in the ``db-5.1.19`` folder.
8060 8086
8061 This next example assumes a Git repository. By default, Git
8062 repositories are cloned to ``${WORKDIR}/git`` during
8063 :ref:`ref-tasks-fetch`. Since this path is different
8064 from the default value of :term:`S`, you must set it specifically so the
8065 source can be located::
8066
8067 SRC_URI = "git://path/to/repo.git;branch=main"
8068 S = "${WORKDIR}/git"
8069
8070 :term:`SANITY_REQUIRED_UTILITIES` 8087 :term:`SANITY_REQUIRED_UTILITIES`
8071 Specifies a list of command-line utilities that should be checked for 8088 Specifies a list of command-line utilities that should be checked for
8072 during the initial sanity checking process when running BitBake. If 8089 during the initial sanity checking process when running BitBake. If
@@ -8441,7 +8458,6 @@ system and gives an overview of their function and contents.
8441 sources are fetched from a Git repository and ``setup.py`` is in a 8458 sources are fetched from a Git repository and ``setup.py`` is in a
8442 ``python/pythonmodule`` subdirectory, you would have this:: 8459 ``python/pythonmodule`` subdirectory, you would have this::
8443 8460
8444 S = "${WORKDIR}/git"
8445 SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule" 8461 SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule"
8446 8462
8447 :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS` 8463 :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS`
@@ -8764,6 +8780,28 @@ system and gives an overview of their function and contents.
8764 image), compared to just using the :ref:`ref-classes-create-spdx` class 8780 image), compared to just using the :ref:`ref-classes-create-spdx` class
8765 with no option. 8781 with no option.
8766 8782
8783 :term:`SPDX_INCLUDE_COMPILED_SOURCES`
8784 This option allows the same as :term:`SPDX_INCLUDE_SOURCES` but including
8785 only the sources used to compile the host tools and the target packages.
8786 While :term:`SPDX_INCLUDE_SOURCES` includes all files in the source
8787 directory as source file descriptions, :term:`SPDX_INCLUDE_COMPILED_SOURCES`
8788 includes only the sources that are used to produce the binaries delivered
8789 as packages. The source files that are not used during compilation are not
8790 included in the SBOM. It uses debugsource information generated during
8791 ``do_package`` to filter out source files.
8792
8793 This enables an external tool to use the SPDX information to disregard
8794 vulnerabilities that are not compiled in the packages.
8795
8796 Enable this option as follows::
8797
8798 SPDX_INCLUDE_COMPILED_SOURCES = "1"
8799
8800 According to our tests, building ``core-image-minimal`` for the
8801 ``qemux86-64`` machine, enabling this option compared with the
8802 :term:`SPDX_INCLUDE_SOURCES` reduces the size of the ``tmp/deploy/spdx``
8803 directory from 2GB to 1.6GB.
8804
8767 :term:`SPDX_NAMESPACE_PREFIX` 8805 :term:`SPDX_NAMESPACE_PREFIX`
8768 This option could be used in order to change the prefix of ``spdxDocument`` 8806 This option could be used in order to change the prefix of ``spdxDocument``
8769 and the prefix of ``documentNamespace``. It is set by default to 8807 and the prefix of ``documentNamespace``. It is set by default to
@@ -10321,13 +10359,13 @@ system and gives an overview of their function and contents.
10321 :term:`UBOOT_DTB_LOADADDRESS` 10359 :term:`UBOOT_DTB_LOADADDRESS`
10322 Specifies the load address for the dtb image used by U-Boot. During FIT 10360 Specifies the load address for the dtb image used by U-Boot. During FIT
10323 image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in 10361 image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in
10324 :ref:`ref-classes-kernel-fitimage` class to specify the load address to be 10362 :ref:`ref-classes-kernel-fit-image` class to specify the load address to be
10325 used in creating the dtb sections of Image Tree Source for the FIT image. 10363 used in creating the dtb sections of Image Tree Source for the FIT image.
10326 10364
10327 :term:`UBOOT_DTBO_LOADADDRESS` 10365 :term:`UBOOT_DTBO_LOADADDRESS`
10328 Specifies the load address for the dtbo image used by U-Boot. During FIT 10366 Specifies the load address for the dtbo image used by U-Boot. During FIT
10329 image creation, the :term:`UBOOT_DTBO_LOADADDRESS` variable is used in 10367 image creation, the :term:`UBOOT_DTBO_LOADADDRESS` variable is used in
10330 :ref:`ref-classes-kernel-fitimage` class to specify the load address to be 10368 :ref:`ref-classes-kernel-fit-image` class to specify the load address to be
10331 used in creating the dtbo sections of Image Tree Source for the FIT image. 10369 used in creating the dtbo sections of Image Tree Source for the FIT image.
10332 10370
10333 :term:`UBOOT_ENTRYPOINT` 10371 :term:`UBOOT_ENTRYPOINT`
@@ -10339,7 +10377,7 @@ system and gives an overview of their function and contents.
10339 - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. 10377 - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation.
10340 - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. 10378 - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation.
10341 10379
10342 This variable is used by the :ref:`ref-classes-kernel-fitimage`, 10380 This variable is used by the :ref:`ref-classes-kernel-fit-image`,
10343 :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, 10381 :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`,
10344 :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` 10382 :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign`
10345 classes. 10383 classes.
@@ -10616,7 +10654,7 @@ system and gives an overview of their function and contents.
10616 - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. 10654 - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation.
10617 - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. 10655 - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation.
10618 10656
10619 This variable is used by the :ref:`ref-classes-kernel-fitimage`, 10657 This variable is used by the :ref:`ref-classes-kernel-fit-image`,
10620 :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, 10658 :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`,
10621 :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` 10659 :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign`
10622 classes. 10660 classes.
@@ -10644,15 +10682,15 @@ system and gives an overview of their function and contents.
10644 10682
10645 :term:`UBOOT_MKIMAGE` 10683 :term:`UBOOT_MKIMAGE`
10646 Specifies the name of the mkimage command as used by the 10684 Specifies the name of the mkimage command as used by the
10647 :ref:`ref-classes-kernel-fitimage` class to assemble 10685 :ref:`ref-classes-kernel-fit-image` class to assemble
10648 the FIT image. This can be used to substitute an alternative command, wrapper 10686 the FIT image. This can be used to substitute an alternative command, wrapper
10649 script or function if desired. The default is "uboot-mkimage". 10687 script or function if desired. The default is "uboot-mkimage".
10650 10688
10651 :term:`UBOOT_MKIMAGE_DTCOPTS` 10689 :term:`UBOOT_MKIMAGE_DTCOPTS`
10652 Options for the device tree compiler passed to ``mkimage -D`` feature 10690 Options for the device tree compiler passed to ``mkimage -D`` feature
10653 while creating a FIT image with the :ref:`ref-classes-kernel-fitimage` 10691 while creating a FIT image with the :ref:`ref-classes-kernel-fit-image`
10654 class. If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then the 10692 class. If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then the
10655 :ref:`ref-classes-kernel-fitimage` class will not pass the ``-D`` option 10693 :ref:`ref-classes-kernel-fit-image` class will not pass the ``-D`` option
10656 to ``mkimage``. 10694 to ``mkimage``.
10657 10695
10658 This variable is also used by the :ref:`ref-classes-uboot-sign` class. 10696 This variable is also used by the :ref:`ref-classes-uboot-sign` class.
@@ -10663,42 +10701,42 @@ system and gives an overview of their function and contents.
10663 10701
10664 :term:`UBOOT_MKIMAGE_SIGN` 10702 :term:`UBOOT_MKIMAGE_SIGN`
10665 Specifies the name of the mkimage command as used by the 10703 Specifies the name of the mkimage command as used by the
10666 :ref:`ref-classes-kernel-fitimage` class to sign 10704 :ref:`ref-classes-kernel-fit-image` class to sign
10667 the FIT image after it has been assembled (if enabled). This can be used 10705 the FIT image after it has been assembled (if enabled). This can be used
10668 to substitute an alternative command, wrapper script or function if 10706 to substitute an alternative command, wrapper script or function if
10669 desired. The default is "${:term:`UBOOT_MKIMAGE`}". 10707 desired. The default is "${:term:`UBOOT_MKIMAGE`}".
10670 10708
10671 :term:`UBOOT_MKIMAGE_SIGN_ARGS` 10709 :term:`UBOOT_MKIMAGE_SIGN_ARGS`
10672 Optionally specifies additional arguments for the 10710 Optionally specifies additional arguments for the
10673 :ref:`ref-classes-kernel-fitimage` class to pass to the 10711 :ref:`ref-classes-kernel-fit-image` class to pass to the
10674 mkimage command when signing the FIT image. 10712 mkimage command when signing the FIT image.
10675 10713
10676 :term:`UBOOT_RD_ENTRYPOINT` 10714 :term:`UBOOT_RD_ENTRYPOINT`
10677 Specifies the entrypoint for the RAM disk image. During FIT image 10715 Specifies the entrypoint for the RAM disk image. During FIT image
10678 creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in 10716 creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in
10679 :ref:`ref-classes-kernel-fitimage` class to specify the entrypoint to be 10717 :ref:`ref-classes-kernel-fit-image` class to specify the entrypoint to be
10680 used in creating the Image Tree Source for the FIT image. 10718 used in creating the Image Tree Source for the FIT image.
10681 10719
10682 :term:`UBOOT_RD_LOADADDRESS` 10720 :term:`UBOOT_RD_LOADADDRESS`
10683 Specifies the load address for the RAM disk image. During FIT image 10721 Specifies the load address for the RAM disk image. During FIT image
10684 creation, the :term:`UBOOT_RD_LOADADDRESS` variable is used in 10722 creation, the :term:`UBOOT_RD_LOADADDRESS` variable is used in
10685 :ref:`ref-classes-kernel-fitimage` class to specify the load address to 10723 :ref:`ref-classes-kernel-fit-image` class to specify the load address to
10686 be used in creating the Image Tree Source for the FIT image. 10724 be used in creating the Image Tree Source for the FIT image.
10687 10725
10688 :term:`UBOOT_SIGN_ENABLE` 10726 :term:`UBOOT_SIGN_ENABLE`
10689 Enable signing of FIT image. The default value is "0". 10727 Enable signing of FIT image. The default value is "0".
10690 10728
10691 This variable is used by the :ref:`ref-classes-kernel-fitimage`, 10729 This variable is used by the :ref:`ref-classes-kernel-fit-image`,
10692 :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` 10730 :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign`
10693 classes. 10731 classes.
10694 10732
10695 :term:`UBOOT_SIGN_KEYDIR` 10733 :term:`UBOOT_SIGN_KEYDIR`
10696 Location of the directory containing the RSA key and certificate used for 10734 Location of the directory containing the RSA key and certificate used for
10697 signing FIT image, used by the :ref:`ref-classes-kernel-fitimage` and 10735 signing FIT image, used by the :ref:`ref-classes-kernel-fit-image` and
10698 :ref:`ref-classes-uboot-sign` classes. 10736 :ref:`ref-classes-uboot-sign` classes.
10699 10737
10700 :term:`UBOOT_SIGN_KEYNAME` 10738 :term:`UBOOT_SIGN_KEYNAME`
10701 The name of keys used by the :ref:`ref-classes-kernel-fitimage` class 10739 The name of keys used by the :ref:`ref-classes-kernel-fit-image` class
10702 for signing U-Boot FIT image stored in the :term:`UBOOT_SIGN_KEYDIR` 10740 for signing U-Boot FIT image stored in the :term:`UBOOT_SIGN_KEYDIR`
10703 directory. If we have for example a ``dev.key`` key and a ``dev.crt`` 10741 directory. If we have for example a ``dev.key`` key and a ``dev.crt``
10704 certificate stored in the :term:`UBOOT_SIGN_KEYDIR` directory, you will 10742 certificate stored in the :term:`UBOOT_SIGN_KEYDIR` directory, you will