summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/classes.rst245
-rw-r--r--documentation/ref-manual/resources.rst4
-rw-r--r--documentation/ref-manual/structure.rst2
-rw-r--r--documentation/ref-manual/system-requirements.rst2
-rw-r--r--documentation/ref-manual/tasks.rst3
-rw-r--r--documentation/ref-manual/variables.rst128
-rw-r--r--documentation/ref-manual/yocto-project-supported-features.rst28
7 files changed, 268 insertions, 144 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 54a98bf24f..f2f6e6e411 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1732,77 +1732,158 @@ Its behavior is mainly controlled by the following variables:
1732- :term:`KERNEL_DTC_FLAGS`: flags for ``dtc``, the Device Tree Compiler 1732- :term:`KERNEL_DTC_FLAGS`: flags for ``dtc``, the Device Tree Compiler
1733- :term:`KERNEL_PACKAGE_NAME`: base name of the kernel packages 1733- :term:`KERNEL_PACKAGE_NAME`: base name of the kernel packages
1734 1734
1735.. _ref-classes-kernel-fitimage: 1735.. _ref-classes-kernel-fit-image:
1736 1736
1737``kernel-fitimage`` 1737``kernel-fit-image``
1738=================== 1738====================
1739 1739
1740The :ref:`ref-classes-kernel-fitimage` class provides support to pack a kernel image, 1740The :ref:`ref-classes-kernel-fit-image` class provides support to pack a kernel image,
1741device trees, a U-boot script, an :term:`Initramfs` bundle and a RAM disk 1741device trees, a U-boot script, and an :term:`Initramfs` into a single FIT image.
1742into a single FIT image. In theory, a FIT image can support any number 1742In theory, a FIT image can support any number of kernels, U-boot scripts,
1743of kernels, U-boot scripts, :term:`Initramfs` bundles, RAM disks and device-trees. 1743:term:`Initramfs`, and device trees.
1744However, :ref:`ref-classes-kernel-fitimage` currently only supports 1744However, :ref:`ref-classes-kernel-fit-image` currently only supports
1745limited usecases: just one kernel image, an optional U-boot script, 1745limited usecases: just one kernel image, an optional U-boot script,
1746an optional :term:`Initramfs` bundle, an optional RAM disk, and any number of 1746an optional :term:`Initramfs`, and any number of device trees.
1747device trees. 1747
1748 1748The FIT image is created by a recipe which inherits the
1749To create a FIT image, it is required that :term:`KERNEL_CLASSES` 1749:ref:`ref-classes-kernel-fit-image` class.
1750is set to include ":ref:`ref-classes-kernel-fitimage`" and one of :term:`KERNEL_IMAGETYPE`, 1750One such example is the ``linux-yocto-fitimage`` recipe which creates a FIT
1751:term:`KERNEL_ALT_IMAGETYPE` or :term:`KERNEL_IMAGETYPES` to include "fitImage". 1751image for the Linux Yocto kernel.
1752 1752Additionally, it is required that :term:`KERNEL_CLASSES` is set to include
1753The options for the device tree compiler passed to ``mkimage -D`` 1753:ref:`ref-classes-kernel-fit-extra-artifacts`.
1754when creating the FIT image are specified using the 1754The :ref:`ref-classes-kernel-fit-extra-artifacts` class exposes the required kernel
1755:term:`UBOOT_MKIMAGE_DTCOPTS` variable. 1755artifacts to the :term:`DEPLOY_DIR_IMAGE` which are used by the
1756 1756:ref:`ref-classes-kernel-fit-image` class to create the FIT image.
1757Only a single kernel can be added to the FIT image created by 1757
1758:ref:`ref-classes-kernel-fitimage` and the kernel image in FIT is mandatory. The 1758The simplest example for building a FIT image is to add::
1759address where the kernel image is to be loaded by U-Boot is 1759
1760specified by :term:`UBOOT_LOADADDRESS` and the entrypoint by 1760 KERNEL_CLASSES += "kernel-fit-extra-artifacts"
1761:term:`UBOOT_ENTRYPOINT`. Setting :term:`FIT_ADDRESS_CELLS` to "2" 1761
1762is necessary if such addresses are 64 bit ones. 1762to the machine :term:`configuration file` and to execute::
1763 1763
1764Multiple device trees can be added to the FIT image created by 1764 bitbake linux-yocto-fitimage
1765:ref:`ref-classes-kernel-fitimage` and the device tree is optional. 1765
1766The address where the device tree is to be loaded by U-Boot is 1766This results in a ``fitImage`` file deployed to the :term:`DEPLOY_DIR_IMAGE`
1767specified by :term:`UBOOT_DTBO_LOADADDRESS` for device tree overlays 1767directory and a ``linux-yocto-fitimage`` package which can be installed.
1768and by :term:`UBOOT_DTB_LOADADDRESS` for device tree binaries. 1768
1769 1769The same approach works for all variants of the ``linux-yocto`` kernel.
1770Only a single RAM disk can be added to the FIT image created by 1770For example, if the ``linux-yocto-rt`` kernel should be used, add the following
1771:ref:`ref-classes-kernel-fitimage` and the RAM disk in FIT is optional. 1771lines to the machine configuration file::
1772The address where the RAM disk image is to be loaded by U-Boot 1772
1773is specified by :term:`UBOOT_RD_LOADADDRESS` and the entrypoint by 1773 KERNEL_CLASSES += "kernel-fit-extra-artifacts"
1774:term:`UBOOT_RD_ENTRYPOINT`. The ramdisk is added to the FIT image when 1774 PREFERRED_PROVIDER_virtual/kernel = "linux-yocto-rt"
1775:term:`INITRAMFS_IMAGE` is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE` 1775
1776is not set to 1. 1776The FIT image, this time including the RT kernel, is built again by calling::
1777 1777
1778Only a single :term:`Initramfs` bundle can be added to the FIT image created by 1778 bitbake linux-yocto-fitimage
1779:ref:`ref-classes-kernel-fitimage` and the :term:`Initramfs` bundle in FIT is optional. 1779
1780In case of :term:`Initramfs`, the kernel is configured to be bundled with the root filesystem 1780For other kernels provided by other layers, the same approach would work.
1781in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin). 1781However, it is usually more intuitive to add a custom FIT image recipe next to
1782When the kernel is copied to RAM and executed, it unpacks the :term:`Initramfs` root filesystem. 1782the custom kernel recipe.
1783The :term:`Initramfs` bundle can be enabled when :term:`INITRAMFS_IMAGE` 1783For example, if a layer provides a ``linux-vanilla`` recipe, a
1784is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1. 1784``linux-vanilla-fitimage`` recipe may be added as well.
1785The address where the :term:`Initramfs` bundle is to be loaded by U-boot is specified 1785The ``linux-vanilla-fitimage`` recipe can be created as a customized copy of
1786by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`. 1786the ``linux-yocto-fitimage`` recipe.
1787 1787
1788Only a single U-boot boot script can be added to the FIT image created by 1788Usually the kernel is built as a dependency of an image.
1789:ref:`ref-classes-kernel-fitimage` and the boot script is optional. 1789If the FIT image should be used as a replacement for the kernel image which
1790The boot script is specified in the ITS file as a text file containing 1790is installed in the root filesystem, then the following variables can be set
1791U-boot commands. When using a boot script the user should configure the 1791e.g. in the machine configuration file::
1792U-boot :ref:`ref-tasks-install` task to copy the script to sysroot. 1792
1793So the script can be included in the FIT image by the :ref:`ref-classes-kernel-fitimage` 1793 # Create and deploy the vmlinux artifact which gets included into the FIT image
1794class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to 1794 KERNEL_CLASSES += "kernel-fit-extra-artifacts"
1795load the boot script from the FIT image and execute it. 1795
1796 1796 # Do not install the kernel image package
1797The FIT image generated by the :ref:`ref-classes-kernel-fitimage` class is signed when the 1797 RRECOMMENDS:${KERNEL_PACKAGE_NAME}-base = ""
1798variables :term:`UBOOT_SIGN_ENABLE`, :term:`UBOOT_MKIMAGE_DTCOPTS`, 1798 # Install the FIT image package
1799:term:`UBOOT_SIGN_KEYDIR` and :term:`UBOOT_SIGN_KEYNAME` are set 1799 MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "linux-yocto-fitimage"
1800appropriately. The default values used for :term:`FIT_HASH_ALG` and 1800
1801:term:`FIT_SIGN_ALG` in :ref:`ref-classes-kernel-fitimage` are "sha256" and 1801 # Configure the image.bbclass to depend on the FIT image instead of only
1802"rsa2048" respectively. The keys for signing the FIT image can be generated using 1802 # the kernel to ensure the FIT image is built and deployed with the image
1803the :ref:`ref-classes-kernel-fitimage` class when both :term:`FIT_GENERATE_KEYS` and 1803 KERNEL_DEPLOY_DEPEND = "linux-yocto-fitimage:do_deploy"
1804:term:`UBOOT_SIGN_ENABLE` are set to "1". 1804
1805 1805The :ref:`ref-classes-kernel-fit-image` class processes several variables that
1806allow configuration:
1807
1808- The options for the device tree compiler passed to ``mkimage -D``
1809 when creating the FIT image are specified using the
1810 :term:`UBOOT_MKIMAGE_DTCOPTS` variable.
1811
1812- Only a single kernel can be added to the FIT image created by
1813 :ref:`ref-classes-kernel-fit-image` and it is a mandatory component of the
1814 FIT image.
1815 The address where the kernel image is to be loaded by U-Boot is
1816 specified by :term:`UBOOT_LOADADDRESS` and the entrypoint by
1817 :term:`UBOOT_ENTRYPOINT`. Setting :term:`FIT_ADDRESS_CELLS` to "2"
1818 is necessary if such addresses are 64 bit ones.
1819
1820- Multiple device trees can be added to the FIT image created by
1821 :ref:`ref-classes-kernel-fit-image` and the device tree is optional.
1822 The address where the device tree is to be loaded by U-Boot is
1823 specified by :term:`UBOOT_DTBO_LOADADDRESS` for device tree overlays
1824 and by :term:`UBOOT_DTB_LOADADDRESS` for device tree binaries.
1825
1826- Only a single :term:`Initramfs` can be added to the FIT image created by
1827 :ref:`ref-classes-kernel-fit-image`. The :term:`Initramfs` in FIT is optional.
1828 The address where the RAM disk image is to be loaded by U-Boot
1829 is specified by :term:`UBOOT_RD_LOADADDRESS` and the entrypoint by
1830 :term:`UBOOT_RD_ENTRYPOINT`. The :term:`Initramfs` is added to the FIT image
1831 when :term:`INITRAMFS_IMAGE` is specified.
1832
1833- It's recommended to add the :term:`Initramfs` and the kernel image as
1834 independent image nodes to the FIT image.
1835 Bundling a RAM disk image with the kernel image and including the bundle
1836 (:term:`INITRAMFS_IMAGE_BUNDLE` set to "1") in the FIT image is possible.
1837 However, this approach has the disadvantage that any change to the RAM
1838 disk image necessitates rebuilding the kernel image.
1839 This process requires the full kernel build directory, which is kind of
1840 incompatible with the :term:`SSTATE_DIR` and, consequently, with SDKs.
1841
1842- Only a single U-Boot boot script can be added to the FIT image created by
1843 :ref:`ref-classes-kernel-fit-image`. The boot script is optional.
1844 The boot script is specified in the ITS file as a text file containing
1845 U-Boot commands. When using a boot script the recipe which inherits the
1846 :ref:`ref-classes-kernel-fit-image` class should add the script to
1847 :term:`SRC_URI` and set the :term:`FIT_UBOOT_ENV` variable to the name of the
1848 file like the following::
1849
1850 FIT_UBOOT_ENV = "boot.txt"
1851 SRC_URI += "file://${FIT_UBOOT_ENV}"
1852
1853 At run-time, U-boot's boot command can be configured to load the boot script
1854 from the FIT image and source it.
1855
1856- The FIT image generated by the :ref:`ref-classes-kernel-fit-image` class is signed when the
1857 variables :term:`UBOOT_SIGN_ENABLE`, :term:`UBOOT_MKIMAGE_DTCOPTS`,
1858 :term:`UBOOT_SIGN_KEYDIR` and :term:`UBOOT_SIGN_KEYNAME` are set
1859 appropriately. The default values used for :term:`FIT_HASH_ALG` and
1860 :term:`FIT_SIGN_ALG` in :ref:`ref-classes-kernel-fit-image` are "sha256" and
1861 "rsa2048" respectively. The keys for signing the FIT image can be generated using
1862 the :ref:`ref-classes-kernel-fit-image` class when both :term:`FIT_GENERATE_KEYS` and
1863 :term:`UBOOT_SIGN_ENABLE` are set to "1".
1864
1865.. _ref-classes-kernel-fit-extra-artifacts:
1866
1867``kernel-fit-extra-artifacts``
1868==============================
1869
1870The :ref:`ref-classes-kernel-fit-extra-artifacts` class exposes the required
1871kernel artifacts to the :term:`DEPLOY_DIR_IMAGE` directory.
1872These artifacts are used by the :ref:`ref-classes-kernel-fit-image` class to
1873create a FIT image that can include the kernel, device trees, an optional
1874U-Boot script, and an optional Initramfs.
1875
1876This class is typically included by adding it to the :term:`KERNEL_CLASSES`
1877variable in your kernel recipe or machine configuration when building FIT images.
1878It ensures that all necessary files are available for packaging into the FIT image,
1879such as the kernel binary, device tree blobs (DTBs), and other related files.
1880
1881For example, to enable this class, set::
1882
1883 KERNEL_CLASSES += "kernel-fit-extra-artifacts"
1884
1885This is required when using the :ref:`ref-classes-kernel-fit-image` class to
1886generate FIT images for your kernel.
1806 1887
1807.. _ref-classes-kernel-grub: 1888.. _ref-classes-kernel-grub:
1808 1889
@@ -2050,7 +2131,8 @@ a couple different ways:
2050 Not using this naming convention can lead to subtle problems 2131 Not using this naming convention can lead to subtle problems
2051 caused by existing code that depends on that naming convention. 2132 caused by existing code that depends on that naming convention.
2052 2133
2053- Create or modify a target recipe that contains the following:: 2134- Or, create a :ref:`ref-classes-native` variant of any target recipe (e.g.
2135 ``myrecipe.bb``) by adding the following to the recipe::
2054 2136
2055 BBCLASSEXTEND = "native" 2137 BBCLASSEXTEND = "native"
2056 2138
@@ -2081,24 +2163,25 @@ couple different ways:
2081 inherit statement in the recipe after all other inherit statements so 2163 inherit statement in the recipe after all other inherit statements so
2082 that the :ref:`ref-classes-nativesdk` class is inherited last. 2164 that the :ref:`ref-classes-nativesdk` class is inherited last.
2083 2165
2084- Create a :ref:`ref-classes-nativesdk` variant of any recipe by adding the following:: 2166 .. note::
2085 2167
2086 BBCLASSEXTEND = "nativesdk" 2168 When creating a recipe, you must follow this naming convention::
2087 2169
2088 Inside the 2170 nativesdk-myrecipe.bb
2089 recipe, use ``:class-nativesdk`` and ``:class-target`` overrides to
2090 specify any functionality specific to the respective SDK machine or
2091 target case.
2092 2171
2093.. note::
2094 2172
2095 When creating a recipe, you must follow this naming convention:: 2173 Not doing so can lead to subtle problems because there is code that
2174 depends on the naming convention.
2096 2175
2097 nativesdk-myrecipe.bb 2176- Or, create a :ref:`ref-classes-nativesdk` variant of any target recipe (e.g.
2177 ``myrecipe.bb``) by adding the following to the recipe::
2098 2178
2179 BBCLASSEXTEND = "nativesdk"
2099 2180
2100 Not doing so can lead to subtle problems because there is code that 2181 Inside the
2101 depends on the naming convention. 2182 recipe, use ``:class-nativesdk`` and ``:class-target`` overrides to
2183 specify any functionality specific to the respective SDK machine or
2184 target case.
2102 2185
2103Although applied differently, the :ref:`ref-classes-nativesdk` class is used with both 2186Although applied differently, the :ref:`ref-classes-nativesdk` class is used with both
2104methods. The advantage of the second method is that you do not need to 2187methods. The advantage of the second method is that you do not need to
@@ -3436,7 +3519,7 @@ See U-Boot's documentation for details about `verified boot
3436and the `signature process 3519and the `signature process
3437<https://source.denx.de/u-boot/u-boot/-/blob/master/doc/uImage.FIT/signature.txt>`__. 3520<https://source.denx.de/u-boot/u-boot/-/blob/master/doc/uImage.FIT/signature.txt>`__.
3438 3521
3439See also the description of :ref:`ref-classes-kernel-fitimage` class, which this class 3522See also the description of :ref:`ref-classes-kernel-fit-image` class, which this class
3440imitates. 3523imitates.
3441 3524
3442.. _ref-classes-uki: 3525.. _ref-classes-uki:
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index 4eaaca942e..bcbc7ebaca 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -23,7 +23,7 @@ The Yocto Project gladly accepts contributions. You can submit changes
23to the project either by creating and sending pull requests, or by 23to the project either by creating and sending pull requests, or by
24submitting patches through email. For information on how to do both as 24submitting patches through email. For information on how to do both as
25well as information on how to identify the maintainer for each area of 25well as information on how to identify the maintainer for each area of
26code, see the :doc:`../contributor-guide/index`. 26code, see the :doc:`/contributor-guide/index`.
27 27
28.. _resources-bugtracker: 28.. _resources-bugtracker:
29 29
@@ -45,7 +45,7 @@ your expectations).
45For a general procedure and guidelines on how to use Bugzilla to submit a bug 45For a general procedure and guidelines on how to use Bugzilla to submit a bug
46against the Yocto Project, see the following: 46against the Yocto Project, see the following:
47 47
48- The ":doc:`../contributor-guide/report-defect`" 48- The ":doc:`/contributor-guide/report-defect`"
49 section in the Yocto Project and OpenEmbedded Contributor Guide. 49 section in the Yocto Project and OpenEmbedded Contributor Guide.
50 50
51- The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` 51- The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index 2190f5b90e..d6dbb29401 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -611,7 +611,7 @@ example, consider ``linux-yocto-kernel-3.0`` on the machine ``qemux86``
611built within the Yocto Project. For this package, a work directory of 611built within the Yocto Project. For this package, a work directory of
612``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred 612``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred
613to as the :term:`WORKDIR`, is created. Within this directory, the source is 613to as the :term:`WORKDIR`, is created. Within this directory, the source is
614unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. 614unpacked to ``sources/linux-qemux86-standard-build`` and then patched by Quilt.
615(See the ":ref:`dev-manual/quilt:using quilt in your workflow`" section in 615(See the ":ref:`dev-manual/quilt:using quilt in your workflow`" section in
616the Yocto Project Development Tasks Manual for more information.) Within 616the Yocto Project Development Tasks Manual for more information.) Within
617the ``linux-qemux86-standard-build`` directory, standard Quilt 617the ``linux-qemux86-standard-build`` directory, standard Quilt
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index b64a13320a..14b635013b 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -145,7 +145,7 @@ tested on former revisions of "&DISTRO_NAME;", but no longer are:
145 interested in hearing about your experience. For information on 145 interested in hearing about your experience. For information on
146 how to submit a bug, see the Yocto Project 146 how to submit a bug, see the Yocto Project
147 :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` 147 :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
148 and the ":doc:`../contributor-guide/report-defect`" 148 and the ":doc:`/contributor-guide/report-defect`"
149 section in the Yocto Project and OpenEmbedded Contributor Guide. 149 section in the Yocto Project and OpenEmbedded Contributor Guide.
150 150
151Required Packages for the Build Host 151Required Packages for the Build Host
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index d85d1151f0..e379c424d8 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -412,8 +412,7 @@ them. You can learn more by looking at the
412------------- 412-------------
413 413
414Unpacks the source code into a working directory pointed to by 414Unpacks the source code into a working directory pointed to by
415``${``\ :term:`UNPACKDIR`\ ``}``. A legacy way to specify 415``${``\ :term:`UNPACKDIR`\ ``}``.
416this directory is through the :term:`S` and :term:`WORKDIR` variables.
417For more information on how source files are unpacked, see the 416For more information on how source files are unpacked, see the
418":ref:`overview-manual/concepts:source fetching`" 417":ref:`overview-manual/concepts:source fetching`"
419section in the Yocto Project Overview and Concepts Manual. 418section in the Yocto Project Overview and Concepts Manual.
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
diff --git a/documentation/ref-manual/yocto-project-supported-features.rst b/documentation/ref-manual/yocto-project-supported-features.rst
index 345280d67d..283c79d4cc 100644
--- a/documentation/ref-manual/yocto-project-supported-features.rst
+++ b/documentation/ref-manual/yocto-project-supported-features.rst
@@ -92,10 +92,10 @@ Below is a list of primary tested features, their maintainer(s) and builder(s):
92 - meta-exein layer testing 92 - meta-exein layer testing
93 - TBD 93 - TBD
94 - meta-exein 94 - meta-exein
95 * - `meta-virtualization <https://git.yoctoproject.org/meta-virtualization/>`__ 95 * - `meta-webosose <https://github.com/webosose/meta-webosose>`__
96 - meta-virtualization layer testing 96 - meta-webosose layer testing
97 - TBD 97 - TBD
98 - meta-virt 98 - meta-webosose
99 * - :ref:`Multilib <dev-manual/libraries:Combining Multiple Versions of Library Files into One Image>` 99 * - :ref:`Multilib <dev-manual/libraries:Combining Multiple Versions of Library Files into One Image>`
100 - Multilib feature testing 100 - Multilib feature testing
101 - Collective effort 101 - Collective effort
@@ -114,7 +114,7 @@ Below is a list of primary tested features, their maintainer(s) and builder(s):
114 - pkgman-non-rpm (other builders use RPM by default) 114 - pkgman-non-rpm (other builders use RPM by default)
115 * - :ref:`Patchtest <contributor-guide/submit-changes:Validating Patches with Patchtest>` 115 * - :ref:`Patchtest <contributor-guide/submit-changes:Validating Patches with Patchtest>`
116 - Patchtest tool selftests 116 - Patchtest tool selftests
117 - TBD 117 - Collective effort
118 - patchtest-selftest 118 - patchtest-selftest
119 * - :wikipedia:`RISC-V (64-bit) <RISC-V>` 119 * - :wikipedia:`RISC-V (64-bit) <RISC-V>`
120 - RISC-V architecture testing (64-bit) 120 - RISC-V architecture testing (64-bit)
@@ -209,25 +209,25 @@ builder(s):
209 - Builder(s) 209 - Builder(s)
210 * - :wikipedia:`PowerPC (32-bit) <PowerPC>` 210 * - :wikipedia:`PowerPC (32-bit) <PowerPC>`
211 - PowerPC architecture testing (32-bit) 211 - PowerPC architecture testing (32-bit)
212 - TBD 212 - Peter Marko,
213 Adrian Freihofer
213 - qemuppc, 214 - qemuppc,
214 qemuppc-alt,
215 qemuppc-tc 215 qemuppc-tc
216 * - :oe_git:`meta-openembedded </meta-openembedded>` 216 * - :oe_git:`meta-openembedded </meta-openembedded>`
217 - meta-openembedded layer testing 217 - meta-openembedded layer testing
218 - TBD 218 - Collective effort / openembedded-devel mailing list <openebedded-devel@lists.openembedded.org>
219 - meta-oe 219 - meta-oe
220 * - `meta-mingw <https://git.yoctoproject.org/meta-mingw>`__ 220 * - `meta-mingw <https://git.yoctoproject.org/meta-mingw>`__
221 - mingw based SDKs testing 221 - mingw based SDKs testing
222 - TBD 222 - TBD
223 - meta-mingw 223 - meta-mingw
224 * - `meta-webosose <https://github.com/webosose/meta-webosose>`__ 224 * - `meta-virtualization <https://git.yoctoproject.org/meta-virtualization/>`__
225 - meta-webosose layer testing 225 - meta-virtualization layer testing
226 - TBD 226 - meta-virtualization mailing list <meta-virtualization@lists.yoctoproject.org>
227 - meta-webosose 227 - meta-virt
228 * - :wikipedia:`RISC-V (32-bit) <RISC-V>` 228 * - :wikipedia:`RISC-V (32-bit) <RISC-V>`
229 - RISC-V architecture testing (32-bit) 229 - RISC-V architecture testing (32-bit)
230 - Collective effort 230 - TBD
231 - qemuriscv32, 231 - qemuriscv32,
232 qemuriscv32, 232 qemuriscv32,
233 qemuriscv32-tc 233 qemuriscv32-tc
@@ -256,6 +256,10 @@ it is on a best effort only basis.
256 qemumips-alt, 256 qemumips-alt,
257 qemumips-tc, 257 qemumips-tc,
258 qemumips64-tc 258 qemumips64-tc
259 * - :wikipedia:`PowerPC (32-bit) <PowerPC>` Systemd
260 - PowerPC architecture testing (32-bit) with systemd
261 - No maintainers
262 - qemuppc-alt
259 * - :wikipedia:`PowerPC (64-bit) <PowerPC>` 263 * - :wikipedia:`PowerPC (64-bit) <PowerPC>`
260 - PowerPC architecture testing (64-bit) 264 - PowerPC architecture testing (64-bit)
261 - No maintainers 265 - No maintainers