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

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

manuals: remove tab characters

2024-04-19T11:50:40+00:00

As reported by "make sphinx-lint" Tabs are even removed in Makefile examples, as Sphinx turns them to spaces anyway in the generated output. (From yocto-docs rev: fd1423141e7458ba557db465c171b0b4e9063987) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Steve Sakoman

manuals: fix trailing spaces

2024-04-19T11:50:39+00:00

Fixing errors reported by "make sphinx-lint" (From yocto-docs rev: 45b04c281a567e06fd2904166bcc26603e73e684) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman

dev-manual: improve descriptions of 'bitbake -S printdiff'

2024-04-05T14:24:00+00:00

Try to particularly emphasize that it can be used to find out why something rebuilds when it shouldn't. (From yocto-docs rev: 1cd543e62e8f1b65e65108d919c2f481001e044c) Signed-off-by: Alexander Kanavin Reviewed-by: Michael Opdenacker Signed-off-by: Steve Sakoman

manuals: document VIRTUAL-RUNTIME variables

2024-03-25T14:11:26+00:00

Document the convention to use variables prefixed by VIRTUAL_RUNTIME. Add references to the new term where possible. Another reason is that such variables are recommended in a warning issued by meta/classes-global/insane.bbclass (From yocto-docs rev: db88c2021062c95fe49b54351952753390d45a6a) Signed-off-by: Michael Opdenacker Reported-by: Tim Orling Signed-off-by: Steve Sakoman

dev-manual: packages: fix capitalization

2024-03-25T14:11:26+00:00

Using "PR service" instead of "PR Service", like in the other two instances in this document. (From yocto-docs rev: ef8b7d30738fe8ae6702da111bbafdc0e00e86bf) Signed-off-by: Michael Opdenacker Reported-by: Quentin Schulz Reviewed-by: Quentin Schulz Signed-off-by: Steve Sakoman