linux/poky.git/documentation, branch yocto-5.0.6

migration-guides: add release notes for 4.0.23

2024-12-06T13:50:25+00:00

(From yocto-docs rev: 12d0ba4f496b2b28a188d34fc36e36895f397079) Signed-off-by: Lee Chee Yang Signed-off-by: Antonin Godard (cherry picked from commit 5835cb574881d57785f099c768467177d077e867) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

ref-manual: classes: fix bin_package description

2024-12-06T13:50:25+00:00

The previous bin_package description was confusing: it would instruct to use the git fetcher to extract the content of an RPM package using the `subpath` option - but that's not possible as the git fetcher can be used to clone a repository but not to do the extraction. Update the description by telling what it really does and what it doesn't do, and by giving an HTTPS+RPM example. Reviewed-by: Quentin Schulz (From yocto-docs rev: 13c9f861547490a734a7e6396ac0b8f416863f70) Signed-off-by: Antonin Godard (cherry picked from commit 305f024bf99ba02b153eed0cebe3d36594868497) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

migration-guides: add release notes for 5.0.5

2024-12-06T13:50:25+00:00

(From yocto-docs rev: 0a3a2dceb265112c97359f4366f66bd4b48f4310) Signed-off-by: Lee Chee Yang Signed-off-by: Antonin Godard (cherry picked from commit 4175839e718db49bf6971e900c1cf176d03458d7) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

standards.md: add a section on admonitions

2024-12-06T13:50:25+00:00

We try to limit our usage of these admonitions to `note` and `warning`, as the Sphinx documentation warns that most themes only style these two admonitions. So add a section on that. Suggested-by: Quentin Schulz Reviewed-by: Quentin Schulz (From yocto-docs rev: 2c28575c9aa0ca77d9c21f0833bacb19d44a7931) Signed-off-by: Antonin Godard (cherry picked from commit f86ffa1b1dcf0665c17424eee87b6bead09960f6) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

dev-manual: bblock: use warning block instead of attention

2024-11-18T14:59:35+00:00

Sphinx recommends using warning and note here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives Suggested-by: Quentin Schulz Reviewed-by: Quentin Schulz (From yocto-docs rev: cafa551d0927f56854f823e51f3de690f17423cd) Signed-off-by: Antonin Godard (cherry picked from commit ed49067f172637d38d470a864feed2a02bd84c66) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

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

2024-11-18T14:59:35+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: 36f2a230ca810b1dd221b7c8ce71e8086291131a) Signed-off-by: Antonin Godard (cherry picked from commit 31e5bd3e82e11f77da2abd96eb8c17a7c8194b7c) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

conf.py: add a bitbake_git extlink

2024-11-18T14:59:35+00:00

To make references to the bitbake repo, add an extlink for it and use it in the docs with ":bitbake_git:`lib/bb/utils.py `". Reviewed-by: Quentin Schulz (From yocto-docs rev: f0e98d65e3dbdf7c9bed135285f21da8d084edc0) Signed-off-by: Antonin Godard (cherry picked from commit 8bf3c656ec54a582c75ca7c135121a15f8e4f631) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

sphinx-static/switchers.js.in: do not refer to URL_ROOT anymore

2024-11-18T14:59:35+00:00

This variable was removed from the Sphinx-generated documentation_options.js, thus breaking the current implementation of our switchers.js. Like searchtools.js, which is also generated by Sphinx, use document.documentElement.dataset.content_root as a replacement. To be backwards-compatible to get one or the other. (From yocto-docs rev: d8f4e179dd80e2f2618adfe12dbddad4bd29d488) Signed-off-by: Antonin Godard (cherry picked from commit 2849690abf94872e259e712128e90413f3b9a2f2) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

doc: add a download page for epub and pdf

2024-11-18T14:59:35+00:00

These files are placed in the _static directory during publish. Note that Sphinx does not complain if files do not exist during compilation (since they are copied at the end). This is why this was used instead of the ":download:" role. (From yocto-docs rev: a422a2f4fe452d6f01685717961f6acdf09217de) Signed-off-by: Antonin Godard (cherry picked from commit 38aa55418426227203fe3a106fa1e85494a57c12) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

doc: Makefile: publish pdf and epub versions too

2024-11-18T14:59:35+00:00

Copy the generated files in the special _static directory. Fixes [YOCTO #14357] (From yocto-docs rev: 1ee04ff4798be042e9404fca08bbfb7058c79053) Signed-off-by: Michael Opdenacker Signed-off-by: Antonin Godard (cherry picked from commit b6974695993599959c0d5b7436aa290ee5d0dfca) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman