diff options
| -rw-r--r-- | documentation/dev-manual/sbom.rst | 3 | ||||
| -rw-r--r-- | documentation/migration-guides/release-notes-4.2.rst | 46 | ||||
| -rw-r--r-- | documentation/ref-manual/variables.rst | 26 |
3 files changed, 75 insertions, 0 deletions
diff --git a/documentation/dev-manual/sbom.rst b/documentation/dev-manual/sbom.rst index 448c071c55..f51d08f84d 100644 --- a/documentation/dev-manual/sbom.rst +++ b/documentation/dev-manual/sbom.rst | |||
| @@ -63,6 +63,9 @@ generated files are available in ``tmp/deploy/spdx/MACHINE`` too, such as: | |||
| 63 | (when :term:`SPDX_ARCHIVE_SOURCES` is set). Those are needed to fulfill | 63 | (when :term:`SPDX_ARCHIVE_SOURCES` is set). Those are needed to fulfill |
| 64 | "source code access" license requirements. | 64 | "source code access" license requirements. |
| 65 | 65 | ||
| 66 | See also the :term:`SPDX_CUSTOM_ANNOTATION_VARS` variable which allows | ||
| 67 | to associate custom notes to a recipe. | ||
| 68 | |||
| 66 | See the `tools page <https://spdx.dev/resources/tools/>`__ on the :term:`SPDX` | 69 | See the `tools page <https://spdx.dev/resources/tools/>`__ on the :term:`SPDX` |
| 67 | project website for a list of tools to consume and transform the :term:`SPDX` | 70 | project website for a list of tools to consume and transform the :term:`SPDX` |
| 68 | data generated by the OpenEmbedded build system. | 71 | data generated by the OpenEmbedded build system. |
diff --git a/documentation/migration-guides/release-notes-4.2.rst b/documentation/migration-guides/release-notes-4.2.rst index 04261244ff..6f7ff03e1b 100644 --- a/documentation/migration-guides/release-notes-4.2.rst +++ b/documentation/migration-guides/release-notes-4.2.rst | |||
| @@ -8,6 +8,52 @@ New Features / Enhancements in 4.2 | |||
| 8 | 8 | ||
| 9 | - Linux kernel 6.1, glibc 2.37 and ~350 other recipe upgrades | 9 | - Linux kernel 6.1, glibc 2.37 and ~350 other recipe upgrades |
| 10 | 10 | ||
| 11 | - Python 3.8 is the minimum Python version required on the build host. | ||
| 12 | For host distributions that do not provide it, this is included as part of the | ||
| 13 | :term:`buildtools` tarball. | ||
| 14 | |||
| 15 | - BitBake in this release now supports a new ``addpylib`` directive to enable | ||
| 16 | Python libraries within layers. | ||
| 17 | |||
| 18 | This directive should be added to your layer configuration | ||
| 19 | as in the below example from ``meta/conf/layer.conf``:: | ||
| 20 | |||
| 21 | addpylib ${LAYERDIR}/lib oe | ||
| 22 | |||
| 23 | - BitBake has seen multiple internal changes that may impact | ||
| 24 | memory and disk usage as well as parsing time, in particular: | ||
| 25 | |||
| 26 | - BitBake's Cooker server is now multithreaded. | ||
| 27 | |||
| 28 | - BitBake's cache has been extended to include more hash | ||
| 29 | debugging data, but has also been optimized to :yocto_git:`compress | ||
| 30 | cache data <https://git.yoctoproject.org/poky/commit/?h=mickledore&id=7d010055e2af3294e17db862f42664ca689a9356>`. | ||
| 31 | |||
| 32 | - BitBake's Cooker server :yocto_git:`can now be pinged | ||
| 33 | </poky/commit/?h=mickledore&id=26f255da09>` | ||
| 34 | from the UI. | ||
| 35 | |||
| 36 | - Architecture-specific enhancements: | ||
| 37 | |||
| 38 | - This release adds initial support for the | ||
| 39 | :wikipedia:`LoongArch <Loongson#LoongArch>` | ||
| 40 | (``loongarch64``) architecture, though there is no testing for it yet. | ||
| 41 | |||
| 42 | - Kernel-related enhancements: | ||
| 43 | |||
| 44 | - QEMU/runqemu enhancements: | ||
| 45 | |||
| 46 | - Image-related enhancements: | ||
| 47 | |||
| 48 | - New variables: | ||
| 49 | |||
| 50 | - :term:`VOLATILE_TMP_DIR` allows to specify | ||
| 51 | whether ``/tmp`` should be on persistent storage | ||
| 52 | or in RAM. | ||
| 53 | |||
| 54 | - :term:`SPDX_CUSTOM_ANNOTATION_VARS` allows to add | ||
| 55 | specific comments to the :term:`SPDX` description of a recipe. | ||
| 56 | |||
| 11 | - Rust improvements: | 57 | - Rust improvements: |
| 12 | 58 | ||
| 13 | - This release adds Cargo support on the target, and includes | 59 | - This release adds Cargo support on the target, and includes |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 29143caa3e..01b710199d 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -7578,6 +7578,32 @@ system and gives an overview of their function and contents. | |||
| 7578 | (+ 0.07\% with the tested image), compared to just enabling | 7578 | (+ 0.07\% with the tested image), compared to just enabling |
| 7579 | :term:`SPDX_INCLUDE_SOURCES`. | 7579 | :term:`SPDX_INCLUDE_SOURCES`. |
| 7580 | 7580 | ||
| 7581 | :term:`SPDX_CUSTOM_ANNOTATION_VARS` | ||
| 7582 | This option allows to associate `SPDX annotations | ||
| 7583 | <https://spdx.github.io/spdx-spec/v2.3/annotations/>`__ to a recipe, | ||
| 7584 | using the values of variables in the recipe:: | ||
| 7585 | |||
| 7586 | ANNOTATION1 = "First annotation for recipe" | ||
| 7587 | ANNOTATION2 = "Second annotation for recipe" | ||
| 7588 | SPDX_CUSTOM_ANNOTATION_VARS = "ANNOTATION1 ANNOTATION2" | ||
| 7589 | |||
| 7590 | This will add a new block to the recipe ``.sdpx.json`` output:: | ||
| 7591 | |||
| 7592 | "annotations": [ | ||
| 7593 | { | ||
| 7594 | "annotationDate": "2023-04-18T08:32:12Z", | ||
| 7595 | "annotationType": "OTHER", | ||
| 7596 | "annotator": "Tool: oe-spdx-creator - 1.0", | ||
| 7597 | "comment": "ANNOTATION1=First annotation for recipe" | ||
| 7598 | }, | ||
| 7599 | { | ||
| 7600 | "annotationDate": "2023-04-18T08:32:12Z", | ||
| 7601 | "annotationType": "OTHER", | ||
| 7602 | "annotator": "Tool: oe-spdx-creator - 1.0", | ||
| 7603 | "comment": "ANNOTATION2=Second annotation for recipe" | ||
| 7604 | } | ||
| 7605 | ], | ||
| 7606 | |||
| 7581 | :term:`SPDX_INCLUDE_SOURCES` | 7607 | :term:`SPDX_INCLUDE_SOURCES` |
| 7582 | This option allows to add a description of the source files used to build | 7608 | This option allows to add a description of the source files used to build |
| 7583 | the host tools and the target packages, to the ``spdx.json`` files in | 7609 | the host tools and the target packages, to the ``spdx.json`` files in |
