linux/poky.git/documentation/dev-manual, branch styhead-5.1.3

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

2025-01-29T14:20:44+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: 2df1f56e4863354f05a352d4f61cc797d85100db) 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-09T14:02:49+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: 8ac3e2eb1dd4149b24af03666813dc6d94df466d) 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-09T14:02:49+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: b79d1c8d501418d20c024c92b0ace755dd6b1c88) Signed-off-by: Antonin Godard (cherry picked from commit b389c06b709e4791e1cce5e8a5b58f6b0cd03a14) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

dev-manual/bmaptool.rst: simplify and fix instructions

2024-12-26T14:01:37+00:00

- Remove duplicate instructions - Detail how to run bmaptool directly if you installed it on your host instead of building it through the ``bmaptool-native`` recipe, as running "oe-run-native bmaptool-native bmaptool ..." won't work in this case. - Use "chmod a+w" instead of "chmod 666", better advice, and only run "chmod" in the option that runs "oe-run-native" (From yocto-docs rev: 8e6b07ffcc3aacee2244e064e09c27418017e414) Signed-off-by: Michael Opdenacker Reviewed-by: Antonin Godard Signed-off-by: Antonin Godard (cherry picked from commit 4afa71ef6e5bf1db126c80e6d987f588d0b5a086) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

dev-manual/bmaptool.rst: correct command for bmaptool-native

2024-12-26T14:01:37+00:00

Using only "bitbake bmaptool-native", running "oe-run-native bmaptool-native bmaptool ..." fails as follows: Error: Have you run 'bitbake bmaptool-native -caddto_recipe_sysroot'? Running the "bitbake bmaptool-native -caddto_recipe_sysroot" target is actually sufficient. (From yocto-docs rev: 8c08d627127866194aea1ca19b1e4055fe5e7b9f) Signed-off-by: Michael Opdenacker Reviewed-by: Antonin Godard Signed-off-by: Antonin Godard (cherry picked from commit 72fe904a3bbb5e2c7279ab1f119c2beca200dcf2) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

dev-manual: fix styling of references to bmaptool

2024-12-26T14:01:37+00:00

To follow the styling conventions when we are refering to the name of a tool instead of the command itself (documentation/standards.md). This also improves the HTML rendering of the bmaptools subsection. (From yocto-docs rev: f8bf503b13a53fb0b34c1fdac92d78d66813abfb) Signed-off-by: Michael Opdenacker Reviewed-by: Antonin Godard Signed-off-by: Antonin Godard (cherry picked from commit c569d840c4b6f43e10629b6f1ff45189211e27a9) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

Update the documentation for SRCPV

2024-12-26T14:01:37+00:00

The variable SRCPV is deprecated since 4.3. Instead of including SRCPV in PV, including the sign "+" is enough for bitbake to add the source control information to PKGV during the packaging phase. Update the documentation for SRCPV and the places where it was used. When instructions previously referred to SRCPV, replace by mentioning to include "+" in the assignment. In most examples, "+git" is added to PV as it is the most popular SCM. Simply adding "+" is also possible, although it is better practice to include the SCM name, so give that example. Update the gcompat example with l3afpad as it didn't include "+git" in its PV definition anymore. (From yocto-docs rev: 3866c09cc0460d25fefc0c831affd89633cf8a7b) Signed-off-by: Antonin Godard (cherry picked from commit ee16c96202e5027d1a8d7e89e11c25f127c78326) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

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

dev-manual: add bblock documentation

2024-11-11T17:16:26+00:00

bblock is a helper tool to lock/unlock tasks and recipes to specific signatures. Add a documentation page for it. (From yocto-docs rev: 5692ad6f023289dda63567c1f79132854ae3899d) Signed-off-by: Julien Stephan Reviewed-by: Antonin Godard Signed-off-by: Antonin Godard (cherry picked from commit a082aa39840587d3af6c3f4a2c2747564ca37414) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman