linux/poky.git/documentation/dev-manual, branch kirkstone-4.0.28

sphinx-lint: unbalanced inline literal markup

2025-05-28T15:46:32+00:00

Fix as many instances of unbalanced-inline-literals-delimiters as reported by 'make sphinx-lint' as possible. Sphinx and/or its linter seem to get tripped up randomly when references contain links to heading which contain literals enclosed in double-back-tics, and not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 2c1e5b080ad5e62d8283d332cbc473fd2d59c6e6) Signed-off-by: Trevor Woerner Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

dev-manual/sbom.rst: fix wrong build outputs

2025-05-28T15:46:32+00:00

This document was written with SPDX 3.0 in mind (create-spdx-3.0 class) on OE-Core's master, but Kirkstone only supports SPDX 2.2 (named simply create-spdx). The create-spdx class only generate a tar.zst output, so remove the other outputs listed here. Also, ancillary outputs are not only deployed in tmp/deploy/spdx/MACHINE but tmp/deploy/spdx in general. (From yocto-docs rev: 25b5ec4c71c97228f8386f5b6c4fbe272c207ed6) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

Fix dead links that use the DISTRO macro

2025-05-02T15:12:41+00:00

After introducing the DISTRO_LATEST_TAG and DISTRO_REL_LATEST_TAG macros, use them in links that currently use DISTRO/DISTRO_REL_TAG. When building for the tip of a branch, this will replace the current A.B.999 in links to the latest existing tag. The links were found across the documentation by running 'grep -r "http.*5\.2\.999"' inside the _build/html output after building the docs. [YOCTO #14802] (From yocto-docs rev: 0d51e553d5f83eea6634e03ddc9c7740bf72fcea) Signed-off-by: Antonin Godard (cherry picked from commit 29be069ebbf2c55d72fc51d99ed5a558af37c05e) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

Remove all mention of core-image-lsb

2025-03-08T14:35:36+00:00

core-image-lsb was removed in 2019[1], so remove all of the incredibly obsolete references in the documentation. [1] oe-core fb064356af615d67d85b65942103bf943d84d290 (From yocto-docs rev: 6001f1baa513566639abee86376dc72748f3cd34) Signed-off-by: Ross Burton Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit 062445a49919eff117b5478c1fb18d125c1f895c) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

vulnerabilities/classes: remove references to cve-check text format

2025-02-28T14:51:35+00:00

The text format has been removed, so also remove references and examples using this format. Replace with examples with the JSON format. (From yocto-docs rev: 9798689e4f4b74163c2e8594f3d1ce082d295aa1) Signed-off-by: Marta Rybczynska Signed-off-by: Antonin Godard (cherry picked from commit a52cd7bcadccc53e982f90d6e170d00798322597) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

dev-manual/building: document the initramfs-framework recipe

2025-02-05T14:54:35+00:00

[ YOCTO #14747 ] Adding a initramfs is a common task, and the way oe-core offers to do so is by using the initramfs-framework recipe and companion modules. There was already documentation on adding an initramfs but the documentation was lacking details on this framework. Add it before the multiconfig section because it is a bit more important IMO. Reported-by: Alejandro Reviewed-by: Quentin Schulz (From yocto-docs rev: b1a7dd6d34a291e2250e7169f4f9d93e61700a63) Signed-off-by: Antonin Godard (cherry picked from commit caedbca4eced4cf5bc74aaae64e4ad2887c2fc65) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

ref-manual: move runtime-testing section to the test-manual

2025-01-09T16:41:04+00:00

In the same fashion as the previous commit ("ref-manual/packages: move ptest section to the test-manual"), move the runtime testing section of the development tasks manual to the test environment manual. Add a link to it from the test-manual/intro document. (From yocto-docs rev: 3128bf149f40928e6c2a3e264590a0c6c9778c6a) Signed-off-by: Antonin Godard (cherry picked from commit 6b44257874858db3aa426d3e84a79c41cb4937a3) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

ref-manual/packages: move ptest section to the test-manual

2025-01-09T16:41:04+00:00

[ YOCTO #15106 ] It makes more sense to document ptests in the test-manual. Since ptests are still related to packages, keep a link to ptests from packages.rst to the test-manual. Reported-by: Yoann Congal (From yocto-docs rev: 8b6ada020d595d86c7bbe78a27b7a6301715b039) Signed-off-by: Antonin Godard (cherry picked from commit b389c06b709e4791e1cce5e8a5b58f6b0cd03a14) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

dev-manual: document how to provide confs from layer.conf

2024-11-15T14:05:33+00:00

Add a section on providing global level configuration from the layer.conf file. Since this file is parsed at an earlier stage in the parsing process, it's not possible to combine bb.utils.contains and {DISTRO,MACHINE}_FEATURES to conditionally set some configurations. This patch documents: - First that this file can be used for providing such configuration. - Then demonstrate how to conditionally provide them, using a technique that is currently used in meta-virtualization (https://git.yoctoproject.org/meta-virtualization/tree/conf/layer.conf#n50). Fixes [YOCTO #12688]. Reviewed-by: Quentin Schulz (From yocto-docs rev: e49111c280927c922ab40547c02c11772787b731) Signed-off-by: Antonin Godard (cherry picked from commit 31e5bd3e82e11f77da2abd96eb8c17a7c8194b7c) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

dev-manual: update custom distribution section

2024-05-15T16:44:16+00:00

In keeping with the addition of the motd message pointing out that the poky DISTRO is a reference distribution, adjust the opening of the Creating Your Own Distribution section to match. Additionally, add a section on the end pointing out what users need to consider if they just take a copy of the poky distribution and modify it. (From yocto-docs rev: 30bdf5a101466acdf63027bbdfb69ee18ed707ab) Signed-off-by: Paul Eggleton Reviewed-by: Michael Opdenacker Signed-off-by: Steve Sakoman