diff options
Diffstat (limited to 'documentation')
26 files changed, 565 insertions, 191 deletions
diff --git a/documentation/README b/documentation/README index 02037e0f7e..56eac7ca19 100644 --- a/documentation/README +++ b/documentation/README | |||
@@ -314,6 +314,16 @@ See https://stackoverflow.com/questions/27420317/restructured-text-rst-http-link | |||
314 | Anchor (<#link>) links are forbidden as they are not checked by Sphinx during | 314 | Anchor (<#link>) links are forbidden as they are not checked by Sphinx during |
315 | the build and may be broken without knowing about it. | 315 | the build and may be broken without knowing about it. |
316 | 316 | ||
317 | It is also possible to refer to another document within yocto-docs with the | ||
318 | :doc: directive (c.f. | ||
319 | https://www.sphinx-doc.org/en/master/usage/referencing.html#role-doc), e.g.: | ||
320 | |||
321 | For more information, read :doc:`/bsp-guide/index`. | ||
322 | |||
323 | Note that only "absolute" paths (starting with a '/') are allowed. The root | ||
324 | directory of that path is documentation/, that is, :doc:`/bsp-guide/index` | ||
325 | points at documentation/bsp-guide/index.rst. | ||
326 | |||
317 | References | 327 | References |
318 | ========== | 328 | ========== |
319 | 329 | ||
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 35972f1726..09246b4ae4 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst | |||
@@ -674,21 +674,21 @@ to the kernel recipe by using a similarly named append file, which is | |||
674 | located in the BSP Layer for your target device (e.g. the | 674 | located in the BSP Layer for your target device (e.g. the |
675 | ``meta-bsp_root_name/recipes-kernel/linux`` directory). | 675 | ``meta-bsp_root_name/recipes-kernel/linux`` directory). |
676 | 676 | ||
677 | Suppose you are using the ``linux-yocto_4.4.bb`` recipe to build the | 677 | Suppose you are using the ``linux-yocto_6.12.bb`` recipe to build the |
678 | kernel. In other words, you have selected the kernel in your | 678 | kernel. In other words, you have selected the kernel in your |
679 | ``"bsp_root_name".conf`` file by adding | 679 | ``"bsp_root_name".conf`` file by adding |
680 | :term:`PREFERRED_PROVIDER` and :term:`PREFERRED_VERSION` | 680 | :term:`PREFERRED_PROVIDER` and :term:`PREFERRED_VERSION` |
681 | statements as follows:: | 681 | statements as follows:: |
682 | 682 | ||
683 | PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" | 683 | PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" |
684 | PREFERRED_VERSION_linux-yocto ?= "4.4%" | 684 | PREFERRED_VERSION_linux-yocto ?= "6.12%" |
685 | 685 | ||
686 | .. note:: | 686 | .. note:: |
687 | 687 | ||
688 | When the preferred provider is assumed by default, the :term:`PREFERRED_PROVIDER` | 688 | When the preferred provider is assumed by default, the :term:`PREFERRED_PROVIDER` |
689 | statement does not appear in the ``"bsp_root_name".conf`` file. | 689 | statement does not appear in the ``"bsp_root_name".conf`` file. |
690 | 690 | ||
691 | You would use the ``linux-yocto_4.4.bbappend`` file to append specific | 691 | You would use the ``linux-yocto_6.12.bbappend`` file to append specific |
692 | BSP settings to the kernel, thus configuring the kernel for your | 692 | BSP settings to the kernel, thus configuring the kernel for your |
693 | particular BSP. | 693 | particular BSP. |
694 | 694 | ||
@@ -698,14 +698,19 @@ in the Yocto Project Linux Kernel Development Manual. | |||
698 | 698 | ||
699 | An alternate scenario is when you create your own kernel recipe for the | 699 | An alternate scenario is when you create your own kernel recipe for the |
700 | BSP. A good example of this is the Raspberry Pi BSP. If you examine the | 700 | BSP. A good example of this is the Raspberry Pi BSP. If you examine the |
701 | ``recipes-kernel/linux`` directory you see the following:: | 701 | ``recipes-kernel/linux`` directory in that layer you see the following |
702 | Raspberry Pi-specific recipes and associated files:: | ||
702 | 703 | ||
704 | files/ | ||
705 | linux-raspberrypi_6.12.bb | ||
706 | linux-raspberrypi_6.1.bb | ||
707 | linux-raspberrypi_6.6.bb | ||
703 | linux-raspberrypi-dev.bb | 708 | linux-raspberrypi-dev.bb |
704 | linux-raspberrypi.inc | 709 | linux-raspberrypi.inc |
705 | linux-raspberrypi_4.14.bb | 710 | linux-raspberrypi-v7_6.12.bb |
706 | linux-raspberrypi_4.9.bb | 711 | linux-raspberrypi-v7_6.1.bb |
707 | 712 | linux-raspberrypi-v7_6.6.bb | |
708 | The directory contains three kernel recipes and a common include file. | 713 | linux-raspberrypi-v7.inc |
709 | 714 | ||
710 | Developing a Board Support Package (BSP) | 715 | Developing a Board Support Package (BSP) |
711 | ======================================== | 716 | ======================================== |
@@ -876,7 +881,7 @@ The requirements for a released BSP that conform to the Yocto Project are: | |||
876 | ``recipes-*`` subdirectories specific to the recipe's function, or | 881 | ``recipes-*`` subdirectories specific to the recipe's function, or |
877 | within a subdirectory containing a set of closely-related recipes. | 882 | within a subdirectory containing a set of closely-related recipes. |
878 | The recipes themselves should follow the general guidelines for | 883 | The recipes themselves should follow the general guidelines for |
879 | recipes found in the ":doc:`../contributor-guide/recipe-style-guide`" | 884 | recipes found in the ":doc:`/contributor-guide/recipe-style-guide`" |
880 | in the Yocto Project and OpenEmbedded Contributor Guide. | 885 | in the Yocto Project and OpenEmbedded Contributor Guide. |
881 | 886 | ||
882 | - *License File:* You must include a license file in the | 887 | - *License File:* You must include a license file in the |
@@ -910,7 +915,7 @@ The requirements for a released BSP that conform to the Yocto Project are: | |||
910 | - The name and contact information for the BSP layer maintainer. | 915 | - The name and contact information for the BSP layer maintainer. |
911 | This is the person to whom patches and questions should be sent. | 916 | This is the person to whom patches and questions should be sent. |
912 | For information on how to find the right person, see the | 917 | For information on how to find the right person, see the |
913 | :doc:`../contributor-guide/submit-changes` section in the Yocto Project and | 918 | :doc:`/contributor-guide/submit-changes` section in the Yocto Project and |
914 | OpenEmbedded Contributor Guide. | 919 | OpenEmbedded Contributor Guide. |
915 | 920 | ||
916 | - Instructions on how to build the BSP using the BSP layer. | 921 | - Instructions on how to build the BSP using the BSP layer. |
@@ -1177,7 +1182,7 @@ Use these steps to create a BSP layer: | |||
1177 | 1182 | ||
1178 | - *Create a Kernel Recipe:* Create a kernel recipe in | 1183 | - *Create a Kernel Recipe:* Create a kernel recipe in |
1179 | ``recipes-kernel/linux`` by either using a kernel append file or a | 1184 | ``recipes-kernel/linux`` by either using a kernel append file or a |
1180 | new custom kernel recipe file (e.g. ``linux-yocto_4.12.bb``). The BSP | 1185 | new custom kernel recipe file (e.g. ``linux-yocto_6.12.bb``). The BSP |
1181 | layers mentioned in the previous step also contain different kernel | 1186 | layers mentioned in the previous step also contain different kernel |
1182 | examples. See the ":ref:`kernel-dev/common:modifying an existing recipe`" | 1187 | examples. See the ":ref:`kernel-dev/common:modifying an existing recipe`" |
1183 | section in the Yocto Project Linux Kernel Development Manual for | 1188 | section in the Yocto Project Linux Kernel Development Manual for |
@@ -1242,7 +1247,7 @@ located in :yocto_git:`poky/meta-yocto-bsp/conf/machine/beaglebone-yocto.conf | |||
1242 | 1247 | ||
1243 | PREFERRED_PROVIDER_virtual/xserver ?= "xserver-xorg" | 1248 | PREFERRED_PROVIDER_virtual/xserver ?= "xserver-xorg" |
1244 | 1249 | ||
1245 | MACHINE_EXTRA_RRECOMMENDS = "kernel-modules kernel-devicetree" | 1250 | MACHINE_EXTRA_RRECOMMENDS = "kernel-modules" |
1246 | 1251 | ||
1247 | EXTRA_IMAGEDEPENDS += "virtual/bootloader" | 1252 | EXTRA_IMAGEDEPENDS += "virtual/bootloader" |
1248 | 1253 | ||
@@ -1258,23 +1263,21 @@ located in :yocto_git:`poky/meta-yocto-bsp/conf/machine/beaglebone-yocto.conf | |||
1258 | SERIAL_CONSOLES ?= "115200;ttyS0 115200;ttyO0 115200;ttyAMA0" | 1263 | SERIAL_CONSOLES ?= "115200;ttyS0 115200;ttyO0 115200;ttyAMA0" |
1259 | 1264 | ||
1260 | PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" | 1265 | PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" |
1261 | PREFERRED_VERSION_linux-yocto ?= "6.1%" | 1266 | PREFERRED_VERSION_linux-yocto ?= "6.12%" |
1262 | 1267 | ||
1263 | KERNEL_IMAGETYPE = "zImage" | 1268 | KERNEL_IMAGETYPE = "zImage" |
1264 | KERNEL_DEVICETREE = "am335x-bone.dtb am335x-boneblack.dtb am335x-bonegreen.dtb" | 1269 | DTB_FILES = "am335x-bone.dtb am335x-boneblack.dtb am335x-bonegreen.dtb" |
1265 | KERNEL_EXTRA_ARGS += "LOADADDR=${UBOOT_ENTRYPOINT}" | 1270 | KERNEL_DEVICETREE = '${@' '.join('ti/omap/%s' % d for d in '${DTB_FILES}'.split())}' |
1266 | 1271 | ||
1267 | PREFERRED_PROVIDER_virtual/bootloader ?= "u-boot" | 1272 | PREFERRED_PROVIDER_virtual/bootloader ?= "u-boot" |
1268 | 1273 | ||
1269 | SPL_BINARY = "MLO" | 1274 | SPL_BINARY = "MLO" |
1270 | UBOOT_SUFFIX = "img" | 1275 | UBOOT_SUFFIX = "img" |
1271 | UBOOT_MACHINE = "am335x_evm_defconfig" | 1276 | UBOOT_MACHINE = "am335x_evm_defconfig" |
1272 | UBOOT_ENTRYPOINT = "0x80008000" | ||
1273 | UBOOT_LOADADDRESS = "0x80008000" | ||
1274 | 1277 | ||
1275 | MACHINE_FEATURES = "usbgadget usbhost vfat alsa" | 1278 | MACHINE_FEATURES = "usbgadget usbhost vfat alsa" |
1276 | 1279 | ||
1277 | IMAGE_BOOT_FILES ?= "u-boot.${UBOOT_SUFFIX} ${SPL_BINARY} ${KERNEL_IMAGETYPE} ${KERNEL_DEVICETREE}" | 1280 | IMAGE_BOOT_FILES ?= "u-boot.${UBOOT_SUFFIX} ${SPL_BINARY} ${KERNEL_IMAGETYPE} ${DTB_FILES}" |
1278 | 1281 | ||
1279 | # support runqemu | 1282 | # support runqemu |
1280 | EXTRA_IMAGEDEPENDS += "qemu-native qemu-helper-native" | 1283 | EXTRA_IMAGEDEPENDS += "qemu-native qemu-helper-native" |
@@ -1328,12 +1331,12 @@ Project Reference Manual. | |||
1328 | needed in the root filesystem. In this case, the U-Boot recipe must | 1331 | needed in the root filesystem. In this case, the U-Boot recipe must |
1329 | be built for the image. | 1332 | be built for the image. |
1330 | 1333 | ||
1331 | At the end of the file, we also use this setings to implement | 1334 | At the end of the file, we also use this setting to implement |
1332 | ``runqemu`` support on the host machine. | 1335 | ``runqemu`` support on the host machine. |
1333 | 1336 | ||
1334 | - :term:`DEFAULTTUNE`: Machines | 1337 | - :term:`DEFAULTTUNE`: Machines |
1335 | use tunings to optimize machine, CPU, and application performance. | 1338 | use tunings to optimize machine, CPU, and application performance. |
1336 | These features, which are collectively known as "tuning features", | 1339 | These features --- collectively known as "tuning features" --- |
1337 | are set in the :term:`OpenEmbedded-Core (OE-Core)` layer. In this | 1340 | are set in the :term:`OpenEmbedded-Core (OE-Core)` layer. In this |
1338 | example, the default tuning file is :oe_git:`tune-cortexa8 | 1341 | example, the default tuning file is :oe_git:`tune-cortexa8 |
1339 | </openembedded-core/tree/meta/conf/machine/include/arm/armv7a/tune-cortexa8.inc>`. | 1342 | </openembedded-core/tree/meta/conf/machine/include/arm/armv7a/tune-cortexa8.inc>`. |
@@ -1363,8 +1366,7 @@ Project Reference Manual. | |||
1363 | to create the sysroot when building a Wic image. | 1366 | to create the sysroot when building a Wic image. |
1364 | 1367 | ||
1365 | - :term:`SERIAL_CONSOLES`: | 1368 | - :term:`SERIAL_CONSOLES`: |
1366 | Defines a serial console (TTY) to enable using getty. In this case, | 1369 | Defines one or more serial consoles (TTYs) to enable using getty. |
1367 | the baud rate is "115200" and the device name is "ttyO0". | ||
1368 | 1370 | ||
1369 | - :term:`PREFERRED_PROVIDER_virtual/kernel <PREFERRED_PROVIDER>`: | 1371 | - :term:`PREFERRED_PROVIDER_virtual/kernel <PREFERRED_PROVIDER>`: |
1370 | Specifies the recipe that provides "virtual/kernel" when more than | 1372 | Specifies the recipe that provides "virtual/kernel" when more than |
@@ -1374,7 +1376,7 @@ Project Reference Manual. | |||
1374 | 1376 | ||
1375 | - :term:`PREFERRED_VERSION_linux-yocto <PREFERRED_VERSION>`: | 1377 | - :term:`PREFERRED_VERSION_linux-yocto <PREFERRED_VERSION>`: |
1376 | Defines the version of the recipe used to build the kernel, which is | 1378 | Defines the version of the recipe used to build the kernel, which is |
1377 | "6.1" in this case. | 1379 | "6.12" in this case. |
1378 | 1380 | ||
1379 | - :term:`KERNEL_IMAGETYPE`: | 1381 | - :term:`KERNEL_IMAGETYPE`: |
1380 | The type of kernel to build for the device. In this case, the | 1382 | The type of kernel to build for the device. In this case, the |
@@ -1416,12 +1418,6 @@ Project Reference Manual. | |||
1416 | Specifies the value passed on the make command line when building | 1418 | Specifies the value passed on the make command line when building |
1417 | a U-Boot image. | 1419 | a U-Boot image. |
1418 | 1420 | ||
1419 | - :term:`UBOOT_ENTRYPOINT`: | ||
1420 | Specifies the entry point for the U-Boot image. | ||
1421 | |||
1422 | - :term:`UBOOT_LOADADDRESS`: | ||
1423 | Specifies the load address for the U-Boot image. | ||
1424 | |||
1425 | - :term:`MACHINE_FEATURES`: | 1421 | - :term:`MACHINE_FEATURES`: |
1426 | Specifies the list of hardware features the BeagleBone device is | 1422 | Specifies the list of hardware features the BeagleBone device is |
1427 | capable of supporting. In this case, the device supports "usbgadget | 1423 | capable of supporting. In this case, the device supports "usbgadget |
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index 6d5d69d7cf..adb78fa08d 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst | |||
@@ -76,7 +76,7 @@ Clone the Git repository for the component to modify | |||
76 | ---------------------------------------------------- | 76 | ---------------------------------------------------- |
77 | 77 | ||
78 | After identifying the component to modify as described in the | 78 | After identifying the component to modify as described in the |
79 | ":doc:`../contributor-guide/identify-component`" section, clone the | 79 | ":doc:`/contributor-guide/identify-component`" section, clone the |
80 | corresponding Git repository. Here is an example for OpenEmbedded-Core:: | 80 | corresponding Git repository. Here is an example for OpenEmbedded-Core:: |
81 | 81 | ||
82 | git clone https://git.openembedded.org/openembedded-core | 82 | git clone https://git.openembedded.org/openembedded-core |
@@ -872,7 +872,7 @@ in regards to the use of generative AI tools. See: | |||
872 | https://www.linuxfoundation.org/legal/generative-ai. | 872 | https://www.linuxfoundation.org/legal/generative-ai. |
873 | 873 | ||
874 | All of the existing guidelines in this document are expected to be followed, | 874 | All of the existing guidelines in this document are expected to be followed, |
875 | including in the :doc:`recipe-style-guide`, and contributing the changes with | 875 | including in the :doc:`/contributor-guide/recipe-style-guide`, and contributing the changes with |
876 | additional requirements to the items in section | 876 | additional requirements to the items in section |
877 | :ref:`contributor-guide/submit-changes:Implement and commit changes`. | 877 | :ref:`contributor-guide/submit-changes:Implement and commit changes`. |
878 | 878 | ||
diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst index 807c665f68..865d2e1b67 100644 --- a/documentation/dev-manual/building.rst +++ b/documentation/dev-manual/building.rst | |||
@@ -48,7 +48,7 @@ The following figure and list overviews the build process: | |||
48 | :width: 100% | 48 | :width: 100% |
49 | 49 | ||
50 | #. *Set up Your Host Development System to Support Development Using the | 50 | #. *Set up Your Host Development System to Support Development Using the |
51 | Yocto Project*: See the ":doc:`start`" section for options on how to get a | 51 | Yocto Project*: See the ":doc:`/dev-manual/start`" section for options on how to get a |
52 | build host ready to use the Yocto Project. | 52 | build host ready to use the Yocto Project. |
53 | 53 | ||
54 | #. *Initialize the Build Environment:* Initialize the build environment | 54 | #. *Initialize the Build Environment:* Initialize the build environment |
@@ -113,7 +113,7 @@ The following figure and list overviews the build process: | |||
113 | Building Images for Multiple Targets Using Multiple Configurations | 113 | Building Images for Multiple Targets Using Multiple Configurations |
114 | ================================================================== | 114 | ================================================================== |
115 | 115 | ||
116 | See the :doc:`multiconfig` section of the Yocto Project Development Tasks | 116 | See the :doc:`/dev-manual/multiconfig` section of the Yocto Project Development Tasks |
117 | Manual. | 117 | Manual. |
118 | 118 | ||
119 | Building an Initial RAM Filesystem (Initramfs) Image | 119 | Building an Initial RAM Filesystem (Initramfs) Image |
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst index 8552b26aea..6c45ccf652 100644 --- a/documentation/dev-manual/debugging.rst +++ b/documentation/dev-manual/debugging.rst | |||
@@ -890,7 +890,7 @@ The build should work without issue. | |||
890 | As with all solved problems, if they originated upstream, you need to | 890 | As with all solved problems, if they originated upstream, you need to |
891 | submit the fix for the recipe in OE-Core and upstream so that the | 891 | submit the fix for the recipe in OE-Core and upstream so that the |
892 | problem is taken care of at its source. See the | 892 | problem is taken care of at its source. See the |
893 | ":doc:`../contributor-guide/submit-changes`" section for more information. | 893 | ":doc:`/contributor-guide/submit-changes`" section for more information. |
894 | 894 | ||
895 | Debugging With the GNU Project Debugger (GDB) Remotely | 895 | Debugging With the GNU Project Debugger (GDB) Remotely |
896 | ====================================================== | 896 | ====================================================== |
@@ -1261,7 +1261,7 @@ Here are some other tips that you might find useful: | |||
1261 | :yocto_bugs:`Bugzilla <>`. For information on | 1261 | :yocto_bugs:`Bugzilla <>`. For information on |
1262 | how to submit a bug against the Yocto Project, see the Yocto Project | 1262 | how to submit a bug against the Yocto Project, see the Yocto Project |
1263 | Bugzilla :yocto_wiki:`wiki page </Bugzilla_Configuration_and_Bug_Tracking>` | 1263 | Bugzilla :yocto_wiki:`wiki page </Bugzilla_Configuration_and_Bug_Tracking>` |
1264 | and the ":doc:`../contributor-guide/report-defect`" section. | 1264 | and the ":doc:`/contributor-guide/report-defect`" section. |
1265 | 1265 | ||
1266 | .. note:: | 1266 | .. note:: |
1267 | 1267 | ||
diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst index 9792bd4c1f..c49881efe6 100644 --- a/documentation/dev-manual/new-recipe.rst +++ b/documentation/dev-manual/new-recipe.rst | |||
@@ -1401,7 +1401,7 @@ Following Recipe Style Guidelines | |||
1401 | ================================= | 1401 | ================================= |
1402 | 1402 | ||
1403 | When writing recipes, it is good to conform to existing style guidelines. | 1403 | When writing recipes, it is good to conform to existing style guidelines. |
1404 | See the ":doc:`../contributor-guide/recipe-style-guide`" in the Yocto Project | 1404 | See the ":doc:`/contributor-guide/recipe-style-guide`" in the Yocto Project |
1405 | and OpenEmbedded Contributor Guide for reference. | 1405 | and OpenEmbedded Contributor Guide for reference. |
1406 | 1406 | ||
1407 | It is common for existing recipes to deviate a bit from this style. | 1407 | It is common for existing recipes to deviate a bit from this style. |
diff --git a/documentation/dev-manual/sbom.rst b/documentation/dev-manual/sbom.rst index e6806ce929..ca0fc8b9d6 100644 --- a/documentation/dev-manual/sbom.rst +++ b/documentation/dev-manual/sbom.rst | |||
@@ -60,6 +60,9 @@ more information in the output :term:`SPDX` data: | |||
60 | - Add a description of the source files used to generate host tools and target | 60 | - Add a description of the source files used to generate host tools and target |
61 | packages (:term:`SPDX_INCLUDE_SOURCES`) | 61 | packages (:term:`SPDX_INCLUDE_SOURCES`) |
62 | 62 | ||
63 | - Add a description of the **compiled** source files used to generate host tools | ||
64 | and target packages (:term:`SPDX_INCLUDE_COMPILED_SOURCES`) | ||
65 | |||
63 | - Add archives of these source files themselves (:term:`SPDX_ARCHIVE_SOURCES`). | 66 | - Add archives of these source files themselves (:term:`SPDX_ARCHIVE_SOURCES`). |
64 | 67 | ||
65 | Though the toplevel :term:`SPDX` output is available in | 68 | Though the toplevel :term:`SPDX` output is available in |
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 73548132a3..d77da04276 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst | |||
@@ -234,7 +234,7 @@ particular working environment and set of practices. | |||
234 | - The Yocto Project community encourages you to send patches to the | 234 | - The Yocto Project community encourages you to send patches to the |
235 | project to fix bugs or add features. If you do submit patches, | 235 | project to fix bugs or add features. If you do submit patches, |
236 | follow the project commit guidelines for writing good commit | 236 | follow the project commit guidelines for writing good commit |
237 | messages. See the ":doc:`../contributor-guide/submit-changes`" | 237 | messages. See the ":doc:`/contributor-guide/submit-changes`" |
238 | section in the Yocto Project and OpenEmbedded Contributor Guide. | 238 | section in the Yocto Project and OpenEmbedded Contributor Guide. |
239 | 239 | ||
240 | - Send changes to the core sooner than later as others are likely | 240 | - Send changes to the core sooner than later as others are likely |
diff --git a/documentation/dev-manual/vulnerabilities.rst b/documentation/dev-manual/vulnerabilities.rst index d901ff975b..5331a63991 100644 --- a/documentation/dev-manual/vulnerabilities.rst +++ b/documentation/dev-manual/vulnerabilities.rst | |||
@@ -22,7 +22,7 @@ issues may be impacting Poky and OE-Core. It is up to the maintainers, users, | |||
22 | contributors and anyone interested in the issues to investigate and possibly fix them by | 22 | contributors and anyone interested in the issues to investigate and possibly fix them by |
23 | updating software components to newer versions or by applying patches to address them. | 23 | updating software components to newer versions or by applying patches to address them. |
24 | It is recommended to work with Poky and OE-Core upstream maintainers and submit | 24 | It is recommended to work with Poky and OE-Core upstream maintainers and submit |
25 | patches to fix them, see ":doc:`../contributor-guide/submit-changes`" for details. | 25 | patches to fix them, see ":doc:`/contributor-guide/submit-changes`" for details. |
26 | 26 | ||
27 | Vulnerability check at build time | 27 | Vulnerability check at build time |
28 | ================================= | 28 | ================================= |
diff --git a/documentation/migration-guides/migration-5.3.rst b/documentation/migration-guides/migration-5.3.rst index 22653fc911..09095c7bb2 100644 --- a/documentation/migration-guides/migration-5.3.rst +++ b/documentation/migration-guides/migration-5.3.rst | |||
@@ -59,6 +59,48 @@ Removed classes | |||
59 | 59 | ||
60 | The following classes have been removed in this release: | 60 | The following classes have been removed in this release: |
61 | 61 | ||
62 | - ``kernel-fitimage.bbclass``: the class has been replaced by the | ||
63 | :ref:`ref-classes-kernel-fit-image` class. The new implementation resolves | ||
64 | the long-standing :yocto_bugs:`bug 12912</show_bug.cgi?id=12912>`. | ||
65 | |||
66 | If you are using the kernel FIT image support, you will need to: | ||
67 | |||
68 | #. Make sure to include ``kernel-fit-extra-artifacts`` in your :term:`KERNEL_CLASSES` | ||
69 | variable to ensure the required files are exposed to the :term:`DEPLOY_DIR_IMAGE` | ||
70 | directory:: | ||
71 | |||
72 | KERNEL_CLASSES += "kernel-fit-extra-artifacts" | ||
73 | |||
74 | #. Use the specific FIT image recipe rather than the base kernel recipe. | ||
75 | For example, instead of:: | ||
76 | |||
77 | bitbake linux-yocto | ||
78 | |||
79 | the FIT image is now build by:: | ||
80 | |||
81 | bitbake linux-yocto-fitimage | ||
82 | |||
83 | For custom kernel recipes, creating a corresponding custom FIT image recipe | ||
84 | is usually a good approach. | ||
85 | |||
86 | #. If a FIT image is used as a replacement for the kernel image in the root | ||
87 | filesystem, add the following configuration to your machine configuration | ||
88 | file:: | ||
89 | |||
90 | # Create and deploy the vmlinux artifact which gets included into the FIT image | ||
91 | KERNEL_CLASSES += "kernel-fit-extra-artifacts" | ||
92 | |||
93 | # Do not install the kernel image package | ||
94 | RRECOMMENDS:${KERNEL_PACKAGE_NAME}-base = "" | ||
95 | # Install the FIT image package | ||
96 | MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "linux-yocto-fitimage" | ||
97 | |||
98 | # Configure the image.bbclass to depend on the FIT image instead of only | ||
99 | # the kernel to ensure the FIT image is built and deployed with the image | ||
100 | KERNEL_DEPLOY_DEPEND = "linux-yocto-fitimage:do_deploy" | ||
101 | |||
102 | See the :ref:`ref-classes-kernel-fit-image` section for more information. | ||
103 | |||
62 | Removed features | 104 | Removed features |
63 | ~~~~~~~~~~~~~~~~ | 105 | ~~~~~~~~~~~~~~~~ |
64 | 106 | ||
diff --git a/documentation/migration-guides/release-5.0.rst b/documentation/migration-guides/release-5.0.rst index 3eb7349c78..b3e7a67912 100644 --- a/documentation/migration-guides/release-5.0.rst +++ b/documentation/migration-guides/release-5.0.rst | |||
@@ -16,3 +16,4 @@ Release 5.0 (scarthgap) | |||
16 | release-notes-5.0.7 | 16 | release-notes-5.0.7 |
17 | release-notes-5.0.8 | 17 | release-notes-5.0.8 |
18 | release-notes-5.0.9 | 18 | release-notes-5.0.9 |
19 | release-notes-5.0.10 | ||
diff --git a/documentation/migration-guides/release-notes-4.3.rst b/documentation/migration-guides/release-notes-4.3.rst index 0103ac985e..aa3f31a2ce 100644 --- a/documentation/migration-guides/release-notes-4.3.rst +++ b/documentation/migration-guides/release-notes-4.3.rst | |||
@@ -272,9 +272,9 @@ New Features / Enhancements in 4.3 | |||
272 | 272 | ||
273 | - Prominent documentation updates: | 273 | - Prominent documentation updates: |
274 | 274 | ||
275 | - New :doc:`../contributor-guide/index` document. | 275 | - New :doc:`/contributor-guide/index` document. |
276 | 276 | ||
277 | - New :doc:`../dev-manual/security-subjects` chapter in the Development | 277 | - New :doc:`/dev-manual/security-subjects` chapter in the Development |
278 | Tasks Manual. | 278 | Tasks Manual. |
279 | 279 | ||
280 | - Long overdue documentation for the :ref:`ref-classes-devicetree` class. | 280 | - Long overdue documentation for the :ref:`ref-classes-devicetree` class. |
diff --git a/documentation/migration-guides/release-notes-5.0.10.rst b/documentation/migration-guides/release-notes-5.0.10.rst new file mode 100644 index 0000000000..e9845aa315 --- /dev/null +++ b/documentation/migration-guides/release-notes-5.0.10.rst | |||
@@ -0,0 +1,208 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK | ||
2 | |||
3 | Release notes for Yocto-5.0.10 (Scarthgap) | ||
4 | ------------------------------------------ | ||
5 | |||
6 | Security Fixes in Yocto-5.0.10 | ||
7 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
8 | |||
9 | - binutils: Fix :cve_nist:`2025-1153`, :cve_nist:`2025-1179`, :cve_nist:`2025-1180` and | ||
10 | :cve_nist:`2025-1182` | ||
11 | - connman: Fix :cve_nist:`2025-32366` and :cve_nist:`2025-32743` | ||
12 | - curl: Fix :cve_nist:`2024-11053` and :cve_nist:`2025-0167` | ||
13 | - elfutils: Fix :cve_nist:`2025-1371` | ||
14 | - ffmpeg: Fix :cve_nist:`2024-7055`, :cve_nist:`2024-32230`, :cve_nist:`2024-35366`, | ||
15 | :cve_nist:`2024-36613`, :cve_nist:`2024-36616`, :cve_nist:`2024-36617` and :cve_nist:`2024-36619` | ||
16 | - git: Fix :cve_nist:`2024-50349` and :cve_nist:`2024-52006` | ||
17 | - glib-2.0: fix :cve_nist:`2025-3360` and :cve_nist:`2025-4373` | ||
18 | - iputils: Fix :cve_nist:`2025-47268` | ||
19 | - libpam: Fix :cve_nist:`2024-10041` | ||
20 | - libsoup-2.4: Fix :cve_nist:`2024-52530`, :cve_nist:`2024-52531`, :cve_nist:`2024-52532`, | ||
21 | :cve_nist:`2025-32906`, :cve_nist:`2025-32909`, :cve_nist:`2025-32910`, :cve_nist:`2025-32911`, | ||
22 | :cve_nist:`2025-32912`, :cve_nist:`2025-32913`, :cve_nist:`2025-32914` and :cve_nist:`2025-46420` | ||
23 | - libsoup: Fix :cve_nist:`2025-4476`, :cve_nist:`2025-32906`, :cve_nist:`2025-32909`, | ||
24 | :cve_nist:`2025-32910`, :cve_nist:`2025-32911`, :cve_nist:`2025-32912`, :cve_nist:`2025-32913`, | ||
25 | :cve_nist:`2025-32914` and :cve_nist:`2025-46420` | ||
26 | - libxml2: Fix :cve_nist:`2025-32414` and :cve_nist:`2025-32415` | ||
27 | - openssh: Fix :cve_nist:`2025-32728` | ||
28 | - perl: Fix :cve_nist:`2024-56406` | ||
29 | - ppp: Fix :cve_nist:`2024-58250` | ||
30 | - python3-jinja2: Fix :cve_nist:`2024-56201`, :cve_nist:`2024-56326` and :cve_nist:`2025-27516` | ||
31 | - ruby: Fix :cve_nist:`2025-27221` | ||
32 | - sqlite3: Fix :cve_nist:`2025-3277`, :cve_nist:`2025-29087` and :cve_nist:`2025-29088` | ||
33 | |||
34 | |||
35 | Fixes in Yocto-5.0.10 | ||
36 | ~~~~~~~~~~~~~~~~~~~~~ | ||
37 | |||
38 | - binutils: stable 2.42 branch updates | ||
39 | - bluez5: add missing tools to noinst-tools package | ||
40 | - bluez5: backport a patch to fix btmgmt -i | ||
41 | - bluez5: make media control a :term:`PACKAGECONFIG` option | ||
42 | - build-appliance-image: Update to scarthgap head revision | ||
43 | - buildtools-tarball: Make buildtools respects host CA certificates | ||
44 | - buildtools-tarball: add envvars into :term:`BB_ENV_PASSTHROUGH_ADDITIONS` | ||
45 | - buildtools-tarball: move setting of envvars to respective envfile | ||
46 | - contributor-guide/submit-changes: encourage patch version changelogs | ||
47 | - cve-check.bbclass: Fix symlink handling also for text files | ||
48 | - cve-update-nvd2-native: Revert "cve-update-nvd2-native: Tweak to work better with NFS DL_DIR" | ||
49 | - dev-manual/sbom.rst: fix wrong build outputs | ||
50 | - docs: Fix dead links that use the :term:`DISTRO` macro | ||
51 | - docs: conf.py: tweak SearchEnglish to be hyphen-friendly | ||
52 | - docs:conf.py: define a manpage url | ||
53 | - ffmpeg: upgrade to 6.1.2 | ||
54 | - git: upgrade to 2.44.3 | ||
55 | - glibc-y2038-tests: remove glibc-y2038-tests_2.39.bb recipe | ||
56 | - glibc: Add single-threaded fast path to rand() | ||
57 | - glibc: stable 2.39 branch updates | ||
58 | - initscripts: add function log_success_msg/log_failure_msg/log_warning_msg | ||
59 | - libatomic-ops: Update :term:`GITHUB_BASE_URI` | ||
60 | - manuals: remove repeated word | ||
61 | - migration-guides: add release notes for 4.0.26, 5.0.8, 5.0.9 | ||
62 | - module.bbclass: add KBUILD_EXTRA_SYMBOLS to install | ||
63 | - perl: upgrade to 5.38.4 | ||
64 | - perlcross: upgrade to 1.6.2 | ||
65 | - poky.conf: bump version for 5.0.10 | ||
66 | - poky.yaml: introduce DISTRO_LATEST_TAG | ||
67 | - python3-jinja2: upgrade to 3.1.6 | ||
68 | - ref-manual/release-process: update releases.svg | ||
69 | - ref-manual/variables.rst: HOST_CC_ARCH: fix wrong SDK reference | ||
70 | - ref-manual/variables.rst: WATCHDOG_TIMEOUT: fix recipe name | ||
71 | - ref-manual/variables.rst: add manpage links for toolchain variables | ||
72 | - ref-manual/variables.rst: add missing documentation for BUILD_* variables | ||
73 | - ref-manual/variables.rst: document HOST_*_ARCH variables | ||
74 | - ref-manual/variables.rst: document :term:`INHIBIT_DEFAULT_RUST_DEPS` | ||
75 | - ref-manual/variables.rst: document :term:`INHIBIT_UPDATERCD_BBCLASS` | ||
76 | - ref-manual/variables.rst: document :term:`SSTATE_SKIP_CREATION` | ||
77 | - ref-manual/variables.rst: document :term:`WIC_CREATE_EXTRA_ARGS` | ||
78 | - ref-manual/variables.rst: document autotools class related variables | ||
79 | - ref-manual/variables.rst: document missing SDK_*_ARCH variables | ||
80 | - ref-manual/variables.rst: document the :term:`IMAGE_ROOTFS_MAXSIZE` variable | ||
81 | - ref-manual/variables.rst: document the :term:`INITRAMFS_MAXSIZE` variable | ||
82 | - ref-manual/variables.rst: improve the :term:`PKGV` documentation | ||
83 | - ref-manual/variables.rst: update :term:`ROOT_HOME` documentation | ||
84 | - ref-manual: kernel-fitimage.bbclass does not use :term:`SPL_SIGN_KEYNAME` | ||
85 | - scripts/install-buildtools: Update to 5.0.9 | ||
86 | - sphinx-lint: missing space after literal | ||
87 | - sphinx-lint: trailing whitespace | ||
88 | - sphinx-lint: unbalanced inline literal markup | ||
89 | - systemd: Password agents shouldn't be optional | ||
90 | - systemd: upgrade to 255.18 | ||
91 | - test-manual/intro: remove Buildbot version used | ||
92 | - tzdata/tzcode-native: upgrade 2025a -> 2025b | ||
93 | - u-boot: ensure keys are generated before assembling U-Boot FIT image | ||
94 | - util-linux: Add fix to isolate test fstab entries using CUSTOM_FSTAB | ||
95 | - wic: bootimg-efi: Support + symbol in filenames | ||
96 | |||
97 | |||
98 | Known Issues in Yocto-5.0.10 | ||
99 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
100 | |||
101 | - There is an issue where the target libsoup-2.4 build may fail if apachectl is present on the build | ||
102 | host. The issue only affects test binaries which aren't actually used. The issue can be fixed by | ||
103 | disabling the tests or updating to more recent changes on the scarthgap branch which fix this. | ||
104 | |||
105 | |||
106 | Contributors to Yocto-5.0.10 | ||
107 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
108 | |||
109 | Thanks to the following people who contributed to this release: | ||
110 | |||
111 | - Adrian Freihofer | ||
112 | - Aleksandar Nikolic | ||
113 | - Alexander Kanavin | ||
114 | - Alon Bar-Lev | ||
115 | - Alper Ak | ||
116 | - Andrew Kreimer | ||
117 | - Antonin Godard | ||
118 | - Archana Polampalli | ||
119 | - Ashish Sharma | ||
120 | - Changqing Li | ||
121 | - Christos Gavros | ||
122 | - Deepesh Varatharajan | ||
123 | - Divya Chellam | ||
124 | - Divyanshu Rathore | ||
125 | - Enrico Jörns | ||
126 | - Etienne Cordonnier | ||
127 | - Guðni Már Gilbert | ||
128 | - Haixiao Yan | ||
129 | - Harish Sadineni | ||
130 | - Igor Opaniuk | ||
131 | - Jeroen Hofstee | ||
132 | - Lee Chee Yang | ||
133 | - Nguyen Dat Tho | ||
134 | - Niko Mauno | ||
135 | - Peter Marko | ||
136 | - Praveen Kumar | ||
137 | - Priyal Doshi | ||
138 | - Rogerio Guerra Borin | ||
139 | - Shubham Kulkarni | ||
140 | - Soumya Sambu | ||
141 | - Steve Sakoman | ||
142 | - Sunil Dora | ||
143 | - Trevor Woerner | ||
144 | - Vijay Anusuri | ||
145 | - Virendra Thakur | ||
146 | - Vyacheslav Yurkov | ||
147 | - Yi Zhao | ||
148 | - Yogita Urade | ||
149 | - rajmohan r | ||
150 | |||
151 | Repositories / Downloads for Yocto-5.0.10 | ||
152 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
153 | |||
154 | poky | ||
155 | |||
156 | - Repository Location: :yocto_git:`/poky` | ||
157 | - Branch: :yocto_git:`scarthgap </poky/log/?h=scarthgap>` | ||
158 | - Tag: :yocto_git:`yocto-5.0.10 </poky/log/?h=yocto-5.0.10>` | ||
159 | - Git Revision: :yocto_git:`ac257900c33754957b2696529682029d997a8f28 </poky/commit/?id=ac257900c33754957b2696529682029d997a8f28>` | ||
160 | - Release Artefact: poky-ac257900c33754957b2696529682029d997a8f28 | ||
161 | - sha: ddca7e54b331e78214bea65b346320d4fbcddf4b51103bfbbd9fc3960f32cdc7 | ||
162 | - Download Locations: | ||
163 | https://downloads.yoctoproject.org/releases/yocto/yocto-5.0.10/poky-ac257900c33754957b2696529682029d997a8f28.tar.bz2 | ||
164 | https://mirrors.kernel.org/yocto/yocto/yocto-5.0.10/poky-ac257900c33754957b2696529682029d997a8f28.tar.bz2 | ||
165 | |||
166 | openembedded-core | ||
167 | |||
168 | - Repository Location: :oe_git:`/openembedded-core` | ||
169 | - Branch: :oe_git:`scarthgap </openembedded-core/log/?h=scarthgap>` | ||
170 | - Tag: :oe_git:`yocto-5.0.10 </openembedded-core/log/?h=yocto-5.0.10>` | ||
171 | - Git Revision: :oe_git:`d5342ffc570d47a723b18297d75bd2f63c2088db </openembedded-core/commit/?id=d5342ffc570d47a723b18297d75bd2f63c2088db>` | ||
172 | - Release Artefact: oecore-d5342ffc570d47a723b18297d75bd2f63c2088db | ||
173 | - sha: daa62094f2327f4b3fbcc485e8964d1b86a4722f58fb37e0d8e8e9885094a262 | ||
174 | - Download Locations: | ||
175 | https://downloads.yoctoproject.org/releases/yocto/yocto-5.0.10/oecore-d5342ffc570d47a723b18297d75bd2f63c2088db.tar.bz2 | ||
176 | https://mirrors.kernel.org/yocto/yocto/yocto-5.0.10/oecore-d5342ffc570d47a723b18297d75bd2f63c2088db.tar.bz2 | ||
177 | |||
178 | meta-mingw | ||
179 | |||
180 | - Repository Location: :yocto_git:`/meta-mingw` | ||
181 | - Branch: :yocto_git:`scarthgap </meta-mingw/log/?h=scarthgap>` | ||
182 | - Tag: :yocto_git:`yocto-5.0.10 </meta-mingw/log/?h=yocto-5.0.10>` | ||
183 | - Git Revision: :yocto_git:`bd9fef71ec005be3c3a6d7f8b99d8116daf70c4f </meta-mingw/commit/?id=bd9fef71ec005be3c3a6d7f8b99d8116daf70c4f>` | ||
184 | - Release Artefact: meta-mingw-bd9fef71ec005be3c3a6d7f8b99d8116daf70c4f | ||
185 | - sha: ab073def6487f237ac125d239b3739bf02415270959546b6b287778664f0ae65 | ||
186 | - Download Locations: | ||
187 | https://downloads.yoctoproject.org/releases/yocto/yocto-5.0.10/meta-mingw-bd9fef71ec005be3c3a6d7f8b99d8116daf70c4f.tar.bz2 | ||
188 | https://mirrors.kernel.org/yocto/yocto/yocto-5.0.10/meta-mingw-bd9fef71ec005be3c3a6d7f8b99d8116daf70c4f.tar.bz2 | ||
189 | |||
190 | bitbake | ||
191 | |||
192 | - Repository Location: :oe_git:`/bitbake` | ||
193 | - Branch: :oe_git:`2.8 </bitbake/log/?h=2.8>` | ||
194 | - Tag: :oe_git:`yocto-5.0.10 </bitbake/log/?h=yocto-5.0.10>` | ||
195 | - Git Revision: :oe_git:`696c2c1ef095f8b11c7d2eff36fae50f58c62e5e </bitbake/commit/?id=696c2c1ef095f8b11c7d2eff36fae50f58c62e5e>` | ||
196 | - Release Artefact: bitbake-696c2c1ef095f8b11c7d2eff36fae50f58c62e5e | ||
197 | - sha: fc83f879cd6dd14b9b7eba0161fec23ecc191fed0fb00556ba729dceef6c145f | ||
198 | - Download Locations: | ||
199 | https://downloads.yoctoproject.org/releases/yocto/yocto-5.0.10/bitbake-696c2c1ef095f8b11c7d2eff36fae50f58c62e5e.tar.bz2 | ||
200 | https://mirrors.kernel.org/yocto/yocto/yocto-5.0.10/bitbake-696c2c1ef095f8b11c7d2eff36fae50f58c62e5e.tar.bz2 | ||
201 | |||
202 | yocto-docs | ||
203 | |||
204 | - Repository Location: :yocto_git:`/yocto-docs` | ||
205 | - Branch: :yocto_git:`scarthgap </yocto-docs/log/?h=scarthgap>` | ||
206 | - Tag: :yocto_git:`yocto-5.0.10 </yocto-docs/log/?h=yocto-5.0.10>` | ||
207 | - Git Revision: :yocto_git:`3996388e337377bedc113d072a51fe9d68dd40c6 </yocto-docs/commit/?id=3996388e337377bedc113d072a51fe9d68dd40c6>` | ||
208 | |||
diff --git a/documentation/migration-guides/release-notes-5.1.rst b/documentation/migration-guides/release-notes-5.1.rst index 267934a71e..bab0c14581 100644 --- a/documentation/migration-guides/release-notes-5.1.rst +++ b/documentation/migration-guides/release-notes-5.1.rst | |||
@@ -377,7 +377,7 @@ New Features / Enhancements in 5.1 | |||
377 | :term:`SIGGEN_EXCLUDERECIPES_ABISAFE` and does not trigger a rebuild on a | 377 | :term:`SIGGEN_EXCLUDERECIPES_ABISAFE` and does not trigger a rebuild on a |
378 | change for dependent tasks. | 378 | change for dependent tasks. |
379 | 379 | ||
380 | - In :ref:`ref-classes-kernel-fitimage`, the existence of | 380 | - In ``kernel-fitimage``, the existence of |
381 | :term:`EXTERNAL_KERNEL_DEVICETREE` is checked more thoroughly to avoid | 381 | :term:`EXTERNAL_KERNEL_DEVICETREE` is checked more thoroughly to avoid |
382 | false positives. | 382 | false positives. |
383 | 383 | ||
diff --git a/documentation/migration-guides/release-notes-5.2.rst b/documentation/migration-guides/release-notes-5.2.rst index aad5a2eda0..5fc426c050 100644 --- a/documentation/migration-guides/release-notes-5.2.rst +++ b/documentation/migration-guides/release-notes-5.2.rst | |||
@@ -29,7 +29,7 @@ New Features / Enhancements in |yocto-ver| | |||
29 | ``RuntimeWatchdogSec`` option in ``/etc/systemd/system.conf``. | 29 | ``RuntimeWatchdogSec`` option in ``/etc/systemd/system.conf``. |
30 | 30 | ||
31 | - :term:`FIT_UBOOT_ENV` to allow including a u-boot script as a text in a | 31 | - :term:`FIT_UBOOT_ENV` to allow including a u-boot script as a text in a |
32 | fit image. See the :ref:`ref-classes-kernel-fitimage` for more information. | 32 | fit image. See the ``kernel-fitimage`` for more information. |
33 | 33 | ||
34 | - :ref:`ref-classes-meson`: :term:`MESON_INSTALL_TAGS` to allow passing | 34 | - :ref:`ref-classes-meson`: :term:`MESON_INSTALL_TAGS` to allow passing |
35 | install tags (``--tags``) to the ``meson install`` command during the | 35 | install tags (``--tags``) to the ``meson install`` command during the |
@@ -684,7 +684,7 @@ New Features / Enhancements in |yocto-ver| | |||
684 | command-line tool was added to the different Yocto Project and OpenEmbedded | 684 | command-line tool was added to the different Yocto Project and OpenEmbedded |
685 | repositories. | 685 | repositories. |
686 | 686 | ||
687 | - :ref:`ref-classes-kernel-fitimage`: handle :doc:`multiconfig | 687 | - ``kernel-fitimage``: handle :doc:`multiconfig |
688 | </dev-manual/multiconfig>` dependency when | 688 | </dev-manual/multiconfig>` dependency when |
689 | :term:`INITRAMFS_MULTICONFIG` is set. | 689 | :term:`INITRAMFS_MULTICONFIG` is set. |
690 | 690 | ||
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 85dea9fe05..c9405cdd33 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
@@ -98,7 +98,7 @@ files, and how to package the compiled output. | |||
98 | 98 | ||
99 | The term "package" is sometimes used to refer to recipes. However, since | 99 | The term "package" is sometimes used to refer to recipes. However, since |
100 | the word "package" is used for the packaged output from the OpenEmbedded | 100 | the word "package" is used for the packaged output from the OpenEmbedded |
101 | build system (i.e. ``.ipk`` or ``.deb`` files), this document avoids | 101 | build system (i.e. ``.ipk``, ``.deb`` or ``.rpm`` files), this document avoids |
102 | using the term "package" when referring to recipes. | 102 | using the term "package" when referring to recipes. |
103 | 103 | ||
104 | Classes | 104 | Classes |
@@ -256,7 +256,7 @@ development environment. | |||
256 | .. note:: | 256 | .. note:: |
257 | 257 | ||
258 | The | 258 | The |
259 | scripts/oe-setup-builddir | 259 | ``scripts/oe-setup-builddir`` |
260 | script uses the | 260 | script uses the |
261 | ``$TEMPLATECONF`` | 261 | ``$TEMPLATECONF`` |
262 | variable to determine which sample configuration files to locate. | 262 | variable to determine which sample configuration files to locate. |
@@ -352,7 +352,7 @@ layers the build system uses to further control the build. These layers | |||
352 | provide Metadata for the software, machine, and policies. | 352 | provide Metadata for the software, machine, and policies. |
353 | 353 | ||
354 | In general, there are three types of layer input. You can see them below | 354 | In general, there are three types of layer input. You can see them below |
355 | the "User Configuration" box in the `general workflow | 355 | the "User Configuration" box in the :ref:`general workflow |
356 | figure <overview-manual/concepts:openembedded build system concepts>`: | 356 | figure <overview-manual/concepts:openembedded build system concepts>`: |
357 | 357 | ||
358 | - *Metadata (.bb + Patches):* Software layers containing | 358 | - *Metadata (.bb + Patches):* Software layers containing |
@@ -420,14 +420,14 @@ build. | |||
420 | Distro Layer | 420 | Distro Layer |
421 | ~~~~~~~~~~~~ | 421 | ~~~~~~~~~~~~ |
422 | 422 | ||
423 | The distribution layer provides policy configurations for your | 423 | A distribution layer provides policy configurations for your |
424 | distribution. Best practices dictate that you isolate these types of | 424 | distribution. Best practices dictate that you isolate these types of |
425 | configurations into their own layer. Settings you provide in | 425 | configurations into their own layer. Settings you provide in |
426 | ``conf/distro/distro.conf`` override similar settings that BitBake finds | 426 | ``conf/distro/distro.conf`` override similar settings that BitBake finds |
427 | in your ``conf/local.conf`` file in the :term:`Build Directory`. | 427 | in your ``conf/local.conf`` file in the :term:`Build Directory`. |
428 | 428 | ||
429 | The following list provides some explanation and references for what you | 429 | The following list provides some explanation and references for what you |
430 | typically find in the distribution layer: | 430 | typically find in a distribution layer: |
431 | 431 | ||
432 | - *classes:* Class files (``.bbclass``) hold common functionality that | 432 | - *classes:* Class files (``.bbclass``) hold common functionality that |
433 | can be shared among recipes in the distribution. When your recipes | 433 | can be shared among recipes in the distribution. When your recipes |
@@ -454,7 +454,7 @@ typically find in the distribution layer: | |||
454 | BSP Layer | 454 | BSP Layer |
455 | ~~~~~~~~~ | 455 | ~~~~~~~~~ |
456 | 456 | ||
457 | The BSP Layer provides machine configurations that target specific | 457 | A BSP layer provides machine configurations that target specific |
458 | hardware. Everything in this layer is specific to the machine for which | 458 | hardware. Everything in this layer is specific to the machine for which |
459 | you are building the image or the SDK. A common structure or form is | 459 | you are building the image or the SDK. A common structure or form is |
460 | defined for BSP layers. You can learn more about this structure in the | 460 | defined for BSP layers. You can learn more about this structure in the |
@@ -465,7 +465,7 @@ defined for BSP layers. You can learn more about this structure in the | |||
465 | In order for a BSP layer to be considered compliant with the Yocto | 465 | In order for a BSP layer to be considered compliant with the Yocto |
466 | Project, it must meet some structural requirements. | 466 | Project, it must meet some structural requirements. |
467 | 467 | ||
468 | The BSP Layer's configuration directory contains configuration files for | 468 | A BSP layer's configuration directory contains configuration files for |
469 | the machine (``conf/machine/machine.conf``) and, of course, the layer | 469 | the machine (``conf/machine/machine.conf``) and, of course, the layer |
470 | (``conf/layer.conf``). | 470 | (``conf/layer.conf``). |
471 | 471 | ||
@@ -477,18 +477,18 @@ formfactors, graphics support systems, and so forth. | |||
477 | .. note:: | 477 | .. note:: |
478 | 478 | ||
479 | While the figure shows several | 479 | While the figure shows several |
480 | recipes-\* | 480 | ``recipes-*`` |
481 | directories, not all these directories appear in all BSP layers. | 481 | directories, not all these directories appear in all BSP layers. |
482 | 482 | ||
483 | Software Layer | 483 | Software Layer |
484 | ~~~~~~~~~~~~~~ | 484 | ~~~~~~~~~~~~~~ |
485 | 485 | ||
486 | The software layer provides the Metadata for additional software | 486 | A software layer provides the Metadata for additional software |
487 | packages used during the build. This layer does not include Metadata | 487 | packages used during the build. This layer does not include Metadata |
488 | that is specific to the distribution or the machine, which are found in | 488 | that is specific to the distribution or the machine, which are found in |
489 | their respective layers. | 489 | their respective layers. |
490 | 490 | ||
491 | This layer contains any recipes, append files, and patches, that your | 491 | This layer contains any recipes, append files, and patches that your |
492 | project needs. | 492 | project needs. |
493 | 493 | ||
494 | Sources | 494 | Sources |
@@ -560,9 +560,8 @@ source tree used by the group). | |||
560 | 560 | ||
561 | The canonical method through which to include a local project is to use the | 561 | The canonical method through which to include a local project is to use the |
562 | :ref:`ref-classes-externalsrc` class to include that local project. You use | 562 | :ref:`ref-classes-externalsrc` class to include that local project. You use |
563 | either the ``local.conf`` or a recipe's append file to override or set the | 563 | either ``local.conf`` or a recipe's append file to override or set the |
564 | recipe to point to the local directory on your disk to pull in the whole | 564 | recipe to point to the local directory from which to fetch the source. |
565 | source tree. | ||
566 | 565 | ||
567 | Source Control Managers (Optional) | 566 | Source Control Managers (Optional) |
568 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 567 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index d79173ff55..066d784314 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst | |||
@@ -240,7 +240,7 @@ and so forth. | |||
240 | 240 | ||
241 | For information on finding out who is responsible for (maintains) a | 241 | For information on finding out who is responsible for (maintains) a |
242 | particular area of code in the Yocto Project, see the | 242 | particular area of code in the Yocto Project, see the |
243 | ":doc:`../contributor-guide/identify-component`" | 243 | ":doc:`/contributor-guide/identify-component`" |
244 | section of the Yocto Project and OpenEmbedded Contributor Guide. | 244 | section of the Yocto Project and OpenEmbedded Contributor Guide. |
245 | 245 | ||
246 | The Yocto Project ``poky`` Git repository also has an upstream | 246 | The Yocto Project ``poky`` Git repository also has an upstream |
@@ -272,7 +272,7 @@ push them into the "contrib" area and subsequently request that the | |||
272 | maintainer include them into an upstream branch. This process is called | 272 | maintainer include them into an upstream branch. This process is called |
273 | "submitting a patch" or "submitting a change." For information on | 273 | "submitting a patch" or "submitting a change." For information on |
274 | submitting patches and changes, see the | 274 | submitting patches and changes, see the |
275 | ":doc:`../contributor-guide/submit-changes`" section in the Yocto Project | 275 | ":doc:`/contributor-guide/submit-changes`" section in the Yocto Project |
276 | and OpenEmbedded Contributor Guide. | 276 | and OpenEmbedded Contributor Guide. |
277 | 277 | ||
278 | In summary, there is a single point of entry for changes into the | 278 | In summary, there is a single point of entry for changes into the |
@@ -347,7 +347,7 @@ Book <https://book.git-scm.com>`__. | |||
347 | this type of change, you format the patch and then send the email | 347 | this type of change, you format the patch and then send the email |
348 | using the Git commands ``git format-patch`` and ``git send-email``. | 348 | using the Git commands ``git format-patch`` and ``git send-email``. |
349 | For information on how to use these scripts, see the | 349 | For information on how to use these scripts, see the |
350 | ":doc:`../contributor-guide/submit-changes`" section in the Yocto Project | 350 | ":doc:`/contributor-guide/submit-changes`" section in the Yocto Project |
351 | and OpenEmbedded Contributor Guide. | 351 | and OpenEmbedded Contributor Guide. |
352 | 352 | ||
353 | Git | 353 | Git |
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 15dfb3a6b6..40e9693a8d 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst | |||
@@ -51,7 +51,7 @@ Here are features and advantages of the Yocto Project: | |||
51 | RISC-V and other architectures. Most ODMs, OSVs, and chip vendors create and | 51 | RISC-V and other architectures. Most ODMs, OSVs, and chip vendors create and |
52 | supply BSPs that support their hardware. If you have custom silicon, you can | 52 | supply BSPs that support their hardware. If you have custom silicon, you can |
53 | create a BSP that supports that architecture. See | 53 | create a BSP that supports that architecture. See |
54 | :doc:`ref-manual/yocto-project-supported-features` for details on the level | 54 | :doc:`/ref-manual/yocto-project-supported-features` for details on the level |
55 | of support for some of these architectures. | 55 | of support for some of these architectures. |
56 | 56 | ||
57 | Aside from broad architecture support, the Yocto Project fully | 57 | Aside from broad architecture support, the Yocto Project fully |
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 | ||
1740 | The :ref:`ref-classes-kernel-fitimage` class provides support to pack a kernel image, | 1740 | The :ref:`ref-classes-kernel-fit-image` class provides support to pack a kernel image, |
1741 | device trees, a U-boot script, an :term:`Initramfs` bundle and a RAM disk | 1741 | device trees, a U-boot script, and an :term:`Initramfs` into a single FIT image. |
1742 | into a single FIT image. In theory, a FIT image can support any number | 1742 | In theory, a FIT image can support any number of kernels, U-boot scripts, |
1743 | of kernels, U-boot scripts, :term:`Initramfs` bundles, RAM disks and device-trees. | 1743 | :term:`Initramfs`, and device trees. |
1744 | However, :ref:`ref-classes-kernel-fitimage` currently only supports | 1744 | However, :ref:`ref-classes-kernel-fit-image` currently only supports |
1745 | limited usecases: just one kernel image, an optional U-boot script, | 1745 | limited usecases: just one kernel image, an optional U-boot script, |
1746 | an optional :term:`Initramfs` bundle, an optional RAM disk, and any number of | 1746 | an optional :term:`Initramfs`, and any number of device trees. |
1747 | device trees. | 1747 | |
1748 | 1748 | The FIT image is created by a recipe which inherits the | |
1749 | To create a FIT image, it is required that :term:`KERNEL_CLASSES` | 1749 | :ref:`ref-classes-kernel-fit-image` class. |
1750 | is set to include ":ref:`ref-classes-kernel-fitimage`" and one of :term:`KERNEL_IMAGETYPE`, | 1750 | One such example is the ``linux-yocto-fitimage`` recipe which creates a FIT |
1751 | :term:`KERNEL_ALT_IMAGETYPE` or :term:`KERNEL_IMAGETYPES` to include "fitImage". | 1751 | image for the Linux Yocto kernel. |
1752 | 1752 | Additionally, it is required that :term:`KERNEL_CLASSES` is set to include | |
1753 | The options for the device tree compiler passed to ``mkimage -D`` | 1753 | :ref:`ref-classes-kernel-fit-extra-artifacts`. |
1754 | when creating the FIT image are specified using the | 1754 | The :ref:`ref-classes-kernel-fit-extra-artifacts` class exposes the required kernel |
1755 | :term:`UBOOT_MKIMAGE_DTCOPTS` variable. | 1755 | artifacts 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. | |
1757 | Only 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 | 1758 | The simplest example for building a FIT image is to add:: |
1759 | address where the kernel image is to be loaded by U-Boot is | 1759 | |
1760 | specified 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 | |
1762 | is necessary if such addresses are 64 bit ones. | 1762 | to the machine :term:`configuration file` and to execute:: |
1763 | 1763 | ||
1764 | Multiple 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 | |
1766 | The address where the device tree is to be loaded by U-Boot is | 1766 | This results in a ``fitImage`` file deployed to the :term:`DEPLOY_DIR_IMAGE` |
1767 | specified by :term:`UBOOT_DTBO_LOADADDRESS` for device tree overlays | 1767 | directory and a ``linux-yocto-fitimage`` package which can be installed. |
1768 | and by :term:`UBOOT_DTB_LOADADDRESS` for device tree binaries. | 1768 | |
1769 | 1769 | The same approach works for all variants of the ``linux-yocto`` kernel. | |
1770 | Only a single RAM disk can be added to the FIT image created by | 1770 | For 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. | 1771 | lines to the machine configuration file:: |
1772 | The address where the RAM disk image is to be loaded by U-Boot | 1772 | |
1773 | is 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 | |
1776 | is not set to 1. | 1776 | The FIT image, this time including the RT kernel, is built again by calling:: |
1777 | 1777 | ||
1778 | Only 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 | |
1780 | In case of :term:`Initramfs`, the kernel is configured to be bundled with the root filesystem | 1780 | For other kernels provided by other layers, the same approach would work. |
1781 | in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin). | 1781 | However, it is usually more intuitive to add a custom FIT image recipe next to |
1782 | When the kernel is copied to RAM and executed, it unpacks the :term:`Initramfs` root filesystem. | 1782 | the custom kernel recipe. |
1783 | The :term:`Initramfs` bundle can be enabled when :term:`INITRAMFS_IMAGE` | 1783 | For example, if a layer provides a ``linux-vanilla`` recipe, a |
1784 | is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1. | 1784 | ``linux-vanilla-fitimage`` recipe may be added as well. |
1785 | The address where the :term:`Initramfs` bundle is to be loaded by U-boot is specified | 1785 | The ``linux-vanilla-fitimage`` recipe can be created as a customized copy of |
1786 | by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`. | 1786 | the ``linux-yocto-fitimage`` recipe. |
1787 | 1787 | ||
1788 | Only a single U-boot boot script can be added to the FIT image created by | 1788 | Usually the kernel is built as a dependency of an image. |
1789 | :ref:`ref-classes-kernel-fitimage` and the boot script is optional. | 1789 | If the FIT image should be used as a replacement for the kernel image which |
1790 | The boot script is specified in the ITS file as a text file containing | 1790 | is installed in the root filesystem, then the following variables can be set |
1791 | U-boot commands. When using a boot script the user should configure the | 1791 | e.g. in the machine configuration file:: |
1792 | U-boot :ref:`ref-tasks-install` task to copy the script to sysroot. | 1792 | |
1793 | So 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 |
1794 | class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to | 1794 | KERNEL_CLASSES += "kernel-fit-extra-artifacts" |
1795 | load the boot script from the FIT image and execute it. | 1795 | |
1796 | 1796 | # Do not install the kernel image package | |
1797 | The FIT image generated by the :ref:`ref-classes-kernel-fitimage` class is signed when the | 1797 | RRECOMMENDS:${KERNEL_PACKAGE_NAME}-base = "" |
1798 | variables :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" |
1800 | appropriately. 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 |
1803 | the :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 | 1805 | The :ref:`ref-classes-kernel-fit-image` class processes several variables that | |
1806 | allow 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 | |||
1870 | The :ref:`ref-classes-kernel-fit-extra-artifacts` class exposes the required | ||
1871 | kernel artifacts to the :term:`DEPLOY_DIR_IMAGE` directory. | ||
1872 | These artifacts are used by the :ref:`ref-classes-kernel-fit-image` class to | ||
1873 | create a FIT image that can include the kernel, device trees, an optional | ||
1874 | U-Boot script, and an optional Initramfs. | ||
1875 | |||
1876 | This class is typically included by adding it to the :term:`KERNEL_CLASSES` | ||
1877 | variable in your kernel recipe or machine configuration when building FIT images. | ||
1878 | It ensures that all necessary files are available for packaging into the FIT image, | ||
1879 | such as the kernel binary, device tree blobs (DTBs), and other related files. | ||
1880 | |||
1881 | For example, to enable this class, set:: | ||
1882 | |||
1883 | KERNEL_CLASSES += "kernel-fit-extra-artifacts" | ||
1884 | |||
1885 | This is required when using the :ref:`ref-classes-kernel-fit-image` class to | ||
1886 | generate 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 | ||
2103 | Although applied differently, the :ref:`ref-classes-nativesdk` class is used with both | 2186 | Although applied differently, the :ref:`ref-classes-nativesdk` class is used with both |
2104 | methods. The advantage of the second method is that you do not need to | 2187 | methods. 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 | |||
3436 | and the `signature process | 3519 | and 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 | ||
3439 | See also the description of :ref:`ref-classes-kernel-fitimage` class, which this class | 3522 | See also the description of :ref:`ref-classes-kernel-fit-image` class, which this class |
3440 | imitates. | 3523 | imitates. |
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 | |||
23 | to the project either by creating and sending pull requests, or by | 23 | to the project either by creating and sending pull requests, or by |
24 | submitting patches through email. For information on how to do both as | 24 | submitting patches through email. For information on how to do both as |
25 | well as information on how to identify the maintainer for each area of | 25 | well as information on how to identify the maintainer for each area of |
26 | code, see the :doc:`../contributor-guide/index`. | 26 | code, see the :doc:`/contributor-guide/index`. |
27 | 27 | ||
28 | .. _resources-bugtracker: | 28 | .. _resources-bugtracker: |
29 | 29 | ||
@@ -45,7 +45,7 @@ your expectations). | |||
45 | For a general procedure and guidelines on how to use Bugzilla to submit a bug | 45 | For a general procedure and guidelines on how to use Bugzilla to submit a bug |
46 | against the Yocto Project, see the following: | 46 | against 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/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 | ||
151 | Required Packages for the Build Host | 151 | Required Packages for the Build Host |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 5c18b852d1..c6ae3fb8bc 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -2576,7 +2576,7 @@ system and gives an overview of their function and contents. | |||
2576 | You can safely share this directory between multiple builds on the | 2576 | You can safely share this directory between multiple builds on the |
2577 | same development machine. For additional information on how the build | 2577 | same development machine. For additional information on how the build |
2578 | process gets source files when working behind a firewall or proxy | 2578 | process gets source files when working behind a firewall or proxy |
2579 | server, see this specific question in the ":doc:`faq`" | 2579 | server, see this specific question in the ":doc:`/ref-manual/faq`" |
2580 | chapter. You can also refer to the | 2580 | chapter. You can also refer to the |
2581 | ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" | 2581 | ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" |
2582 | Wiki page. | 2582 | Wiki page. |
@@ -2790,7 +2790,7 @@ system and gives an overview of their function and contents. | |||
2790 | ``meta/classes-recipe`` to see how the variable is used. | 2790 | ``meta/classes-recipe`` to see how the variable is used. |
2791 | 2791 | ||
2792 | :term:`EXTERNAL_KERNEL_DEVICETREE` | 2792 | :term:`EXTERNAL_KERNEL_DEVICETREE` |
2793 | When inheriting :ref:`ref-classes-kernel-fitimage` and a | 2793 | When inheriting :ref:`ref-classes-kernel-fit-image` and a |
2794 | :term:`PREFERRED_PROVIDER` for ``virtual/dtb`` set to ``devicetree``, the | 2794 | :term:`PREFERRED_PROVIDER` for ``virtual/dtb`` set to ``devicetree``, the |
2795 | variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a | 2795 | variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a |
2796 | directory containing one or more compiled device tree or device tree | 2796 | directory containing one or more compiled device tree or device tree |
@@ -3318,7 +3318,7 @@ system and gives an overview of their function and contents. | |||
3318 | Specifies the value of the ``#address-cells`` value for the | 3318 | Specifies the value of the ``#address-cells`` value for the |
3319 | description of the FIT image. | 3319 | description of the FIT image. |
3320 | 3320 | ||
3321 | The default value is set to "1" by the :ref:`ref-classes-kernel-fitimage` | 3321 | The default value is set to "1" by the :ref:`ref-classes-kernel-fit-image` |
3322 | class, which corresponds to 32 bit addresses. | 3322 | class, which corresponds to 32 bit addresses. |
3323 | 3323 | ||
3324 | For platforms that need to set 64 bit addresses, for example in | 3324 | For platforms that need to set 64 bit addresses, for example in |
@@ -3337,11 +3337,11 @@ system and gives an overview of their function and contents. | |||
3337 | Specifies the default device tree binary (dtb) file for a FIT image | 3337 | Specifies the default device tree binary (dtb) file for a FIT image |
3338 | when multiple ones are provided. | 3338 | when multiple ones are provided. |
3339 | 3339 | ||
3340 | This variable is used in the :ref:`ref-classes-kernel-fitimage` class. | 3340 | This variable is used in the :ref:`ref-classes-kernel-fit-image` class. |
3341 | 3341 | ||
3342 | :term:`FIT_DESC` | 3342 | :term:`FIT_DESC` |
3343 | Specifies the description string encoded into a FIT image. The | 3343 | Specifies the description string encoded into a FIT image. The |
3344 | default value is set by the :ref:`ref-classes-kernel-fitimage` class as | 3344 | default value is set by the :ref:`ref-classes-kernel-fit-image` class as |
3345 | follows:: | 3345 | follows:: |
3346 | 3346 | ||
3347 | FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}" | 3347 | FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}" |
@@ -3350,12 +3350,12 @@ system and gives an overview of their function and contents. | |||
3350 | Decides whether to generate the keys for signing the FIT image if | 3350 | Decides whether to generate the keys for signing the FIT image if |
3351 | they don't already exist. The keys are created in | 3351 | they don't already exist. The keys are created in |
3352 | :term:`UBOOT_SIGN_KEYDIR`. The default value is set to "0" | 3352 | :term:`UBOOT_SIGN_KEYDIR`. The default value is set to "0" |
3353 | by the :ref:`ref-classes-kernel-fitimage` class. | 3353 | by the :ref:`ref-classes-kernel-fit-image` class. |
3354 | 3354 | ||
3355 | :term:`FIT_HASH_ALG` | 3355 | :term:`FIT_HASH_ALG` |
3356 | Specifies the hash algorithm used in creating the FIT Image. | 3356 | Specifies the hash algorithm used in creating the FIT Image. |
3357 | This variable is set by default to "sha256" by the | 3357 | This variable is set by default to "sha256" by the |
3358 | :ref:`ref-classes-kernel-fitimage` class. | 3358 | :ref:`ref-classes-kernel-fit-image` class. |
3359 | 3359 | ||
3360 | :term:`FIT_KERNEL_COMP_ALG` | 3360 | :term:`FIT_KERNEL_COMP_ALG` |
3361 | The compression algorithm to use for the kernel image inside the FIT Image. | 3361 | The compression algorithm to use for the kernel image inside the FIT Image. |
@@ -3374,31 +3374,31 @@ system and gives an overview of their function and contents. | |||
3374 | :term:`FIT_KEY_GENRSA_ARGS` | 3374 | :term:`FIT_KEY_GENRSA_ARGS` |
3375 | Arguments to ``openssl genrsa`` for generating a RSA private key for | 3375 | 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 | 3376 | signing the FIT image. The default value is set to "-F4" by the |
3377 | :ref:`ref-classes-kernel-fitimage` class. | 3377 | :ref:`ref-classes-kernel-fit-image` class. |
3378 | 3378 | ||
3379 | :term:`FIT_KEY_REQ_ARGS` | 3379 | :term:`FIT_KEY_REQ_ARGS` |
3380 | Arguments to ``openssl req`` for generating a certificate for signing | 3380 | Arguments to ``openssl req`` for generating a certificate for signing |
3381 | the FIT image. The default value is "-batch -new" by the | 3381 | the FIT image. The default value is "-batch -new" by the |
3382 | :ref:`ref-classes-kernel-fitimage` class, "batch" for | 3382 | :ref:`ref-classes-kernel-fit-image` class, "batch" for |
3383 | non interactive mode and "new" for generating new keys. | 3383 | non interactive mode and "new" for generating new keys. |
3384 | 3384 | ||
3385 | :term:`FIT_KEY_SIGN_PKCS` | 3385 | :term:`FIT_KEY_SIGN_PKCS` |
3386 | Format for the public key certificate used for signing the FIT image. | 3386 | Format for the public key certificate used for signing the FIT image. |
3387 | The default value is set to "x509" by the | 3387 | The default value is set to "x509" by the |
3388 | :ref:`ref-classes-kernel-fitimage` class. | 3388 | :ref:`ref-classes-kernel-fit-image` class. |
3389 | 3389 | ||
3390 | :term:`FIT_SIGN_ALG` | 3390 | :term:`FIT_SIGN_ALG` |
3391 | Specifies the signature algorithm used in creating the FIT Image. | 3391 | Specifies the signature algorithm used in creating the FIT Image. |
3392 | This variable is set by default to "rsa2048" by the | 3392 | This variable is set by default to "rsa2048" by the |
3393 | :ref:`ref-classes-kernel-fitimage` class. | 3393 | :ref:`ref-classes-kernel-fit-image` class. |
3394 | 3394 | ||
3395 | :term:`FIT_PAD_ALG` | 3395 | :term:`FIT_PAD_ALG` |
3396 | Specifies the padding algorithm used in creating the FIT Image. | 3396 | Specifies the padding algorithm used in creating the FIT Image. |
3397 | The default value is set to "pkcs-1.5" by the | 3397 | The default value is set to "pkcs-1.5" by the |
3398 | :ref:`ref-classes-kernel-fitimage` class. | 3398 | :ref:`ref-classes-kernel-fit-image` class. |
3399 | 3399 | ||
3400 | :term:`FIT_SIGN_INDIVIDUAL` | 3400 | :term:`FIT_SIGN_INDIVIDUAL` |
3401 | If set to "1", the :ref:`ref-classes-kernel-fitimage` class signs each | 3401 | 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 | 3402 | 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 | 3403 | other image types present in the FIT image, in addition to signing the |
3404 | configuration nodes. | 3404 | configuration nodes. |
@@ -3431,13 +3431,13 @@ system and gives an overview of their function and contents. | |||
3431 | :term:`FIT_SIGN_NUMBITS` | 3431 | :term:`FIT_SIGN_NUMBITS` |
3432 | Size of the private key used in the FIT image, in number of bits. | 3432 | 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" | 3433 | The default value for this variable is set to "2048" |
3434 | by the :ref:`ref-classes-kernel-fitimage` class. | 3434 | by the :ref:`ref-classes-kernel-fit-image` class. |
3435 | 3435 | ||
3436 | :term:`FIT_UBOOT_ENV` | 3436 | :term:`FIT_UBOOT_ENV` |
3437 | This variable allows to add a U-Boot script as a text file to the | 3437 | 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. | 3438 | FIT image. Such a script can be sourced from the U-Boot shell. |
3439 | 3439 | ||
3440 | When inheriting the :ref:`ref-classes-kernel-fitimage` class a | 3440 | 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 | 3441 | script file should be included in the :term:`SRC_URI` of the Linux |
3442 | kernel recipe. | 3442 | kernel recipe. |
3443 | 3443 | ||
@@ -5075,9 +5075,7 @@ system and gives an overview of their function and contents. | |||
5075 | :term:`KERNEL_CLASSES` | 5075 | :term:`KERNEL_CLASSES` |
5076 | A list of classes defining kernel image types that the | 5076 | A list of classes defining kernel image types that the |
5077 | :ref:`ref-classes-kernel` class should inherit. You typically | 5077 | :ref:`ref-classes-kernel` class should inherit. You typically |
5078 | append this variable to enable extended image types. An example is | 5078 | 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 | 5079 | You can register custom kernel image types with the |
5082 | :ref:`ref-classes-kernel` class using this variable. | 5080 | :ref:`ref-classes-kernel` class using this variable. |
5083 | 5081 | ||
@@ -8764,6 +8762,28 @@ system and gives an overview of their function and contents. | |||
8764 | image), compared to just using the :ref:`ref-classes-create-spdx` class | 8762 | image), compared to just using the :ref:`ref-classes-create-spdx` class |
8765 | with no option. | 8763 | with no option. |
8766 | 8764 | ||
8765 | :term:`SPDX_INCLUDE_COMPILED_SOURCES` | ||
8766 | This option allows the same as :term:`SPDX_INCLUDE_SOURCES` but including | ||
8767 | only the sources used to compile the host tools and the target packages. | ||
8768 | While :term:`SPDX_INCLUDE_SOURCES` includes all files in the source | ||
8769 | directory as source file descriptions, :term:`SPDX_INCLUDE_COMPILED_SOURCES` | ||
8770 | includes only the sources that are used to produce the binaries delivered | ||
8771 | as packages. The source files that are not used during compilation are not | ||
8772 | included in the SBOM. It uses debugsource information generated during | ||
8773 | ``do_package`` to filter out source files. | ||
8774 | |||
8775 | This enables an external tool to use the SPDX information to disregard | ||
8776 | vulnerabilities that are not compiled in the packages. | ||
8777 | |||
8778 | Enable this option as follows:: | ||
8779 | |||
8780 | SPDX_INCLUDE_COMPILED_SOURCES = "1" | ||
8781 | |||
8782 | According to our tests, building ``core-image-minimal`` for the | ||
8783 | ``qemux86-64`` machine, enabling this option compared with the | ||
8784 | :term:`SPDX_INCLUDE_SOURCES` reduces the size of the ``tmp/deploy/spdx`` | ||
8785 | directory from 2GB to 1.6GB. | ||
8786 | |||
8767 | :term:`SPDX_NAMESPACE_PREFIX` | 8787 | :term:`SPDX_NAMESPACE_PREFIX` |
8768 | This option could be used in order to change the prefix of ``spdxDocument`` | 8788 | 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 | 8789 | and the prefix of ``documentNamespace``. It is set by default to |
@@ -10321,13 +10341,13 @@ system and gives an overview of their function and contents. | |||
10321 | :term:`UBOOT_DTB_LOADADDRESS` | 10341 | :term:`UBOOT_DTB_LOADADDRESS` |
10322 | Specifies the load address for the dtb image used by U-Boot. During FIT | 10342 | 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 | 10343 | 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 | 10344 | :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. | 10345 | used in creating the dtb sections of Image Tree Source for the FIT image. |
10326 | 10346 | ||
10327 | :term:`UBOOT_DTBO_LOADADDRESS` | 10347 | :term:`UBOOT_DTBO_LOADADDRESS` |
10328 | Specifies the load address for the dtbo image used by U-Boot. During FIT | 10348 | 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 | 10349 | 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 | 10350 | :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. | 10351 | used in creating the dtbo sections of Image Tree Source for the FIT image. |
10332 | 10352 | ||
10333 | :term:`UBOOT_ENTRYPOINT` | 10353 | :term:`UBOOT_ENTRYPOINT` |
@@ -10339,7 +10359,7 @@ system and gives an overview of their function and contents. | |||
10339 | - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. | 10359 | - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. |
10340 | - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. | 10360 | - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. |
10341 | 10361 | ||
10342 | This variable is used by the :ref:`ref-classes-kernel-fitimage`, | 10362 | This variable is used by the :ref:`ref-classes-kernel-fit-image`, |
10343 | :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, | 10363 | :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, |
10344 | :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` | 10364 | :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` |
10345 | classes. | 10365 | classes. |
@@ -10616,7 +10636,7 @@ system and gives an overview of their function and contents. | |||
10616 | - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. | 10636 | - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. |
10617 | - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. | 10637 | - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. |
10618 | 10638 | ||
10619 | This variable is used by the :ref:`ref-classes-kernel-fitimage`, | 10639 | This variable is used by the :ref:`ref-classes-kernel-fit-image`, |
10620 | :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, | 10640 | :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, |
10621 | :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` | 10641 | :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` |
10622 | classes. | 10642 | classes. |
@@ -10644,15 +10664,15 @@ system and gives an overview of their function and contents. | |||
10644 | 10664 | ||
10645 | :term:`UBOOT_MKIMAGE` | 10665 | :term:`UBOOT_MKIMAGE` |
10646 | Specifies the name of the mkimage command as used by the | 10666 | Specifies the name of the mkimage command as used by the |
10647 | :ref:`ref-classes-kernel-fitimage` class to assemble | 10667 | :ref:`ref-classes-kernel-fit-image` class to assemble |
10648 | the FIT image. This can be used to substitute an alternative command, wrapper | 10668 | the FIT image. This can be used to substitute an alternative command, wrapper |
10649 | script or function if desired. The default is "uboot-mkimage". | 10669 | script or function if desired. The default is "uboot-mkimage". |
10650 | 10670 | ||
10651 | :term:`UBOOT_MKIMAGE_DTCOPTS` | 10671 | :term:`UBOOT_MKIMAGE_DTCOPTS` |
10652 | Options for the device tree compiler passed to ``mkimage -D`` feature | 10672 | Options for the device tree compiler passed to ``mkimage -D`` feature |
10653 | while creating a FIT image with the :ref:`ref-classes-kernel-fitimage` | 10673 | 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 | 10674 | class. If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then the |
10655 | :ref:`ref-classes-kernel-fitimage` class will not pass the ``-D`` option | 10675 | :ref:`ref-classes-kernel-fit-image` class will not pass the ``-D`` option |
10656 | to ``mkimage``. | 10676 | to ``mkimage``. |
10657 | 10677 | ||
10658 | This variable is also used by the :ref:`ref-classes-uboot-sign` class. | 10678 | This variable is also used by the :ref:`ref-classes-uboot-sign` class. |
@@ -10663,42 +10683,42 @@ system and gives an overview of their function and contents. | |||
10663 | 10683 | ||
10664 | :term:`UBOOT_MKIMAGE_SIGN` | 10684 | :term:`UBOOT_MKIMAGE_SIGN` |
10665 | Specifies the name of the mkimage command as used by the | 10685 | Specifies the name of the mkimage command as used by the |
10666 | :ref:`ref-classes-kernel-fitimage` class to sign | 10686 | :ref:`ref-classes-kernel-fit-image` class to sign |
10667 | the FIT image after it has been assembled (if enabled). This can be used | 10687 | 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 | 10688 | to substitute an alternative command, wrapper script or function if |
10669 | desired. The default is "${:term:`UBOOT_MKIMAGE`}". | 10689 | desired. The default is "${:term:`UBOOT_MKIMAGE`}". |
10670 | 10690 | ||
10671 | :term:`UBOOT_MKIMAGE_SIGN_ARGS` | 10691 | :term:`UBOOT_MKIMAGE_SIGN_ARGS` |
10672 | Optionally specifies additional arguments for the | 10692 | Optionally specifies additional arguments for the |
10673 | :ref:`ref-classes-kernel-fitimage` class to pass to the | 10693 | :ref:`ref-classes-kernel-fit-image` class to pass to the |
10674 | mkimage command when signing the FIT image. | 10694 | mkimage command when signing the FIT image. |
10675 | 10695 | ||
10676 | :term:`UBOOT_RD_ENTRYPOINT` | 10696 | :term:`UBOOT_RD_ENTRYPOINT` |
10677 | Specifies the entrypoint for the RAM disk image. During FIT image | 10697 | Specifies the entrypoint for the RAM disk image. During FIT image |
10678 | creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in | 10698 | creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in |
10679 | :ref:`ref-classes-kernel-fitimage` class to specify the entrypoint to be | 10699 | :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. | 10700 | used in creating the Image Tree Source for the FIT image. |
10681 | 10701 | ||
10682 | :term:`UBOOT_RD_LOADADDRESS` | 10702 | :term:`UBOOT_RD_LOADADDRESS` |
10683 | Specifies the load address for the RAM disk image. During FIT image | 10703 | Specifies the load address for the RAM disk image. During FIT image |
10684 | creation, the :term:`UBOOT_RD_LOADADDRESS` variable is used in | 10704 | creation, the :term:`UBOOT_RD_LOADADDRESS` variable is used in |
10685 | :ref:`ref-classes-kernel-fitimage` class to specify the load address to | 10705 | :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. | 10706 | be used in creating the Image Tree Source for the FIT image. |
10687 | 10707 | ||
10688 | :term:`UBOOT_SIGN_ENABLE` | 10708 | :term:`UBOOT_SIGN_ENABLE` |
10689 | Enable signing of FIT image. The default value is "0". | 10709 | Enable signing of FIT image. The default value is "0". |
10690 | 10710 | ||
10691 | This variable is used by the :ref:`ref-classes-kernel-fitimage`, | 10711 | This variable is used by the :ref:`ref-classes-kernel-fit-image`, |
10692 | :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` | 10712 | :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` |
10693 | classes. | 10713 | classes. |
10694 | 10714 | ||
10695 | :term:`UBOOT_SIGN_KEYDIR` | 10715 | :term:`UBOOT_SIGN_KEYDIR` |
10696 | Location of the directory containing the RSA key and certificate used for | 10716 | 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 | 10717 | signing FIT image, used by the :ref:`ref-classes-kernel-fit-image` and |
10698 | :ref:`ref-classes-uboot-sign` classes. | 10718 | :ref:`ref-classes-uboot-sign` classes. |
10699 | 10719 | ||
10700 | :term:`UBOOT_SIGN_KEYNAME` | 10720 | :term:`UBOOT_SIGN_KEYNAME` |
10701 | The name of keys used by the :ref:`ref-classes-kernel-fitimage` class | 10721 | 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` | 10722 | 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`` | 10723 | 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 | 10724 | 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..f67da0e6e8 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) |
@@ -211,20 +211,19 @@ builder(s): | |||
211 | - PowerPC architecture testing (32-bit) | 211 | - PowerPC architecture testing (32-bit) |
212 | - TBD | 212 | - TBD |
213 | - qemuppc, | 213 | - qemuppc, |
214 | qemuppc-alt, | ||
215 | qemuppc-tc | 214 | qemuppc-tc |
216 | * - :oe_git:`meta-openembedded </meta-openembedded>` | 215 | * - :oe_git:`meta-openembedded </meta-openembedded>` |
217 | - meta-openembedded layer testing | 216 | - meta-openembedded layer testing |
218 | - TBD | 217 | - Collective effort / openembedded-devel mailing list <openebedded-devel@lists.openembedded.org> |
219 | - meta-oe | 218 | - meta-oe |
220 | * - `meta-mingw <https://git.yoctoproject.org/meta-mingw>`__ | 219 | * - `meta-mingw <https://git.yoctoproject.org/meta-mingw>`__ |
221 | - mingw based SDKs testing | 220 | - mingw based SDKs testing |
222 | - TBD | 221 | - TBD |
223 | - meta-mingw | 222 | - meta-mingw |
224 | * - `meta-webosose <https://github.com/webosose/meta-webosose>`__ | 223 | * - `meta-virtualization <https://git.yoctoproject.org/meta-virtualization/>`__ |
225 | - meta-webosose layer testing | 224 | - meta-virtualization layer testing |
226 | - TBD | 225 | - meta-virtualization mailing list <meta-virtualization@lists.yoctoproject.org> |
227 | - meta-webosose | 226 | - meta-virt |
228 | * - :wikipedia:`RISC-V (32-bit) <RISC-V>` | 227 | * - :wikipedia:`RISC-V (32-bit) <RISC-V>` |
229 | - RISC-V architecture testing (32-bit) | 228 | - RISC-V architecture testing (32-bit) |
230 | - Collective effort | 229 | - Collective effort |
@@ -256,6 +255,10 @@ it is on a best effort only basis. | |||
256 | qemumips-alt, | 255 | qemumips-alt, |
257 | qemumips-tc, | 256 | qemumips-tc, |
258 | qemumips64-tc | 257 | qemumips64-tc |
258 | * - :wikipedia:`PowerPC (32-bit) <PowerPC>` Systemd | ||
259 | - PowerPC architecture testing (32-bit) with systemd | ||
260 | - No maintainers | ||
261 | - qemuppc-alt | ||
259 | * - :wikipedia:`PowerPC (64-bit) <PowerPC>` | 262 | * - :wikipedia:`PowerPC (64-bit) <PowerPC>` |
260 | - PowerPC architecture testing (64-bit) | 263 | - PowerPC architecture testing (64-bit) |
261 | - No maintainers | 264 | - No maintainers |
diff --git a/documentation/standards.md b/documentation/standards.md index 8300d813dc..801efe3457 100644 --- a/documentation/standards.md +++ b/documentation/standards.md | |||
@@ -126,7 +126,16 @@ that most themes only style these two admonitions. | |||
126 | 126 | ||
127 | ## ReStructured Text Syntax standards | 127 | ## ReStructured Text Syntax standards |
128 | 128 | ||
129 | This section has not been filled yet | 129 | ### doc directive |
130 | |||
131 | The [doc directive](https://www.sphinx-doc.org/en/master/usage/referencing.html#role-doc) | ||
132 | allows to refer to another document within yocto-docs, like: | ||
133 | |||
134 | For more information, read :doc:`/bsp-guide/index`. | ||
135 | |||
136 | Note that only "absolute" paths (starting with a '/') are allowed. The root | ||
137 | directory of that path is documentation/, that is, :doc:`/bsp-guide/index` | ||
138 | points at documentation/bsp-guide/index.rst. | ||
130 | 139 | ||
131 | ## Adding screenshots | 140 | ## Adding screenshots |
132 | 141 | ||
diff --git a/documentation/transitioning-to-a-custom-environment.rst b/documentation/transitioning-to-a-custom-environment.rst index 6ff55e5619..a5f55c567a 100644 --- a/documentation/transitioning-to-a-custom-environment.rst +++ b/documentation/transitioning-to-a-custom-environment.rst | |||
@@ -8,8 +8,8 @@ Transitioning to a custom environment for systems development | |||
8 | 8 | ||
9 | .. note:: | 9 | .. note:: |
10 | 10 | ||
11 | So you've finished the :doc:`brief-yoctoprojectqs/index` and | 11 | So you've finished the :doc:`/brief-yoctoprojectqs/index` and |
12 | glanced over the document :doc:`what-i-wish-id-known`, the latter contains | 12 | glanced over the document :doc:`/what-i-wish-id-known`, the latter contains |
13 | important information learned from other users. You're well prepared. But | 13 | important information learned from other users. You're well prepared. But |
14 | now, as you are starting your own project, it isn't exactly straightforward what | 14 | now, as you are starting your own project, it isn't exactly straightforward what |
15 | to do. And, the documentation is daunting. We've put together a few hints to | 15 | to do. And, the documentation is daunting. We've put together a few hints to |
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst index 836097910d..ddee6ad749 100644 --- a/documentation/what-i-wish-id-known.rst +++ b/documentation/what-i-wish-id-known.rst | |||
@@ -49,7 +49,7 @@ contact us with other suggestions. | |||
49 | their silicon. These layers have names such as "meta-intel" or "meta-ti". Try | 49 | their silicon. These layers have names such as "meta-intel" or "meta-ti". Try |
50 | not to build layers from scratch. If you do have custom silicon, use one of | 50 | not to build layers from scratch. If you do have custom silicon, use one of |
51 | these layers as a guide or template and familiarize yourself with the | 51 | these layers as a guide or template and familiarize yourself with the |
52 | :doc:`bsp-guide/index`. | 52 | :doc:`/bsp-guide/index`. |
53 | 53 | ||
54 | #. **Do not put everything into one layer:** | 54 | #. **Do not put everything into one layer:** |
55 | Use different layers to logically separate information in your build. As an | 55 | Use different layers to logically separate information in your build. As an |
@@ -127,7 +127,7 @@ contact us with other suggestions. | |||
127 | You can build and run a specific task for a specific package (including | 127 | You can build and run a specific task for a specific package (including |
128 | devshell) or even a single recipe. When developers first start using the | 128 | devshell) or even a single recipe. When developers first start using the |
129 | Yocto Project, the instructions found in the | 129 | Yocto Project, the instructions found in the |
130 | :doc:`brief-yoctoprojectqs/index` show how to create an image | 130 | :doc:`/brief-yoctoprojectqs/index` show how to create an image |
131 | and then run or flash that image. However, you can actually build just a | 131 | and then run or flash that image. However, you can actually build just a |
132 | single recipe. Thus, if some dependency or recipe isn't working, you can just | 132 | single recipe. Thus, if some dependency or recipe isn't working, you can just |
133 | say "bitbake foo" where "foo" is the name for a specific recipe. As you | 133 | say "bitbake foo" where "foo" is the name for a specific recipe. As you |