linux/poky.git/documentation/dev-manual, branch 5.2_M2

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

2025-01-09T13:58:17+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: 6b44257874858db3aa426d3e84a79c41cb4937a3) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

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

2025-01-09T13:58:17+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: b389c06b709e4791e1cce5e8a5b58f6b0cd03a14) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

Drop support for BB_DANGLINGAPPENDS_WARNONLY

2024-12-28T10:57:47+00:00

Support for this variable was dropped in BitBake, see commit fca9c9e3cb6f8e9f99bf51dc5e8a8d83f4c84c69 ("cooker: Drop support for BB_DANGLINGAPPENDS_WARNONLY"). Drop this variable here as well and rewrite the "Appending Other Layers Metadata With Your Layer" section to advise to rename the recipe and check if the bbappend is still relevant - otherwise to use BBWARN. (From yocto-docs rev: 10b59d09ebfb6c119995643ed68cb26092b6f2a4) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

Remove debug-tweaks references

2024-12-28T10:57:47+00:00

We no longer provide this feature, so remove documentation for it. In most cases, we can replace occurrences of "debug-tweaks" by "allow-empty-password empty-root-password allow-root-login post-install-logging" to achieve what this feature previously enabled. Subtle, but the default local.conf does not include post-install-logging, so in parts where there is mention of the default local.conf file, adjust the documentation to only mention the first three above. In the intro manual, instead of providing instructions that replace EXTRA_IMAGE_FEATURES entirely, provide ones that append EXTRA_IMAGE_FEATURES. (From yocto-docs rev: f0efd4c7df91863304b92514664bdd1fa62b1fbb) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

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

2024-12-20T12:47:59+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: 4afa71ef6e5bf1db126c80e6d987f588d0b5a086) Signed-off-by: Michael Opdenacker Reviewed-by: Antonin Godard Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

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

2024-12-20T12:47:59+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: 72fe904a3bbb5e2c7279ab1f119c2beca200dcf2) Signed-off-by: Michael Opdenacker Reviewed-by: Antonin Godard Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

dev-manual: fix styling of references to bmaptool

2024-12-20T12:47:59+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: c569d840c4b6f43e10629b6f1ff45189211e27a9) Signed-off-by: Michael Opdenacker Reviewed-by: Antonin Godard Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

Update the documentation for SRCPV

2024-12-20T12:47:59+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: ee16c96202e5027d1a8d7e89e11c25f127c78326) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

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

2024-11-15T11:16:58+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: 7d5eb0cee5b2b7096969819d7d7ce569a3c92f27) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

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

2024-11-15T11:16:58+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: cc3fa1b0e51377f4e03eaa1ca60c2f2ee0cd917e) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie