linux/poky.git/documentation, branch styhead-5.1.1

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

2024-11-26T13:37:10+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: 8288c8cae7fe7303e89d8ed286de91fc26ce6cc3) 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-26T13:37:10+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: b73e99b161a11a46a1a96ff42135893e0c978e2a) 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-26T13:37:10+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: 5efb5f678278276aebd6809ab785dcea8c732de3) Signed-off-by: Antonin Godard (cherry picked from commit 8bf3c656ec54a582c75ca7c135121a15f8e4f631) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

migration-guides: 5.1: fix titles

2024-11-26T13:37:10+00:00

- fix title underline - add anchor for workdir changes - supported-kernel-versions was misplaced, move it - "Miscellaneous changes" anchor was wrong Reviewed-by: Quentin Schulz (From yocto-docs rev: 04507c6593d305f830817555a44706a61518b535) Signed-off-by: Antonin Godard (cherry picked from commit 2bfd49176ff71350054417dc6a9a284466876069) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

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

2024-11-26T13:37:10+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: 1771d1b174b42ae9de5b46898a805bee7e10c076) 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-26T13:37:10+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: 3f6848dd88cd4266e721cc7bbb2460b1e9d24f2b) 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-26T13:37:10+00:00

Copy the generated files in the special _static directory. Fixes [YOCTO #14357] (From yocto-docs rev: 8f1364a4a2e04d334128ce59c47f50996aef0c65) 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

doc: Makefile: add support for xelatex

2024-11-26T13:37:10+00:00

This patch makes the "latexpdf" target compile the documentation with xelatex instead of the default pdflatex engine. The reason behind this is stated in [YOCTO #14357]: pdflatex does not support compiling foreign characters, so we need to resort to another engine, here xelatex. It also increases the texmf config buf_size to 10000000 to avoid a compilation error. (From yocto-docs rev: 9a297c65942a52d6165378d6792d5e0788b492ba) Signed-off-by: Antonin Godard (cherry picked from commit 93848842b3ad8aa6b9c9f46d60f2c2ad396c6971) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

doc: Makefile: remove inkscape, replace by rsvg-convert

2024-11-26T13:37:10+00:00

Remove inkscape as it is not part of meta/, and use librsvg so we can ship it in a buildtools tarball for the autobuilder workers. (From yocto-docs rev: 65db816385dd985bfc3bc895102b25e9ea5d9adf) Signed-off-by: Antonin Godard (cherry picked from commit 0caa432b888209bd80443df230143761e1faf415) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

contributor-guide: Remove duplicated words

2024-11-26T13:37:10+00:00

Remove "and then" as it is duplicated. (From yocto-docs rev: 6bab46640d63949034eedc52c6c367198c9e91c5) Signed-off-by: Talel BELHAJSALEM Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit 52ed947120e400620277a58f895294b558a9324e) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman