linux/poky.git/documentation, branch 5.0_M3

dev-manual: bmaptool: rename

2024-03-06T16:54:54+00:00

What was previously known variously as Bmaptool, bmaptools, bmap-tool, and/or bmap-tools has been updated to the singular name: bmaptool. Update all references to suit. Since we are not in charge of debian's package naming policy, any references that relate to debian package(s) will stay as "bmap-tools". (From yocto-docs rev: 9c1505eabd69af548652381cf996d44f40a4fa8a) Signed-off-by: Trevor Woerner Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: document VIRTUAL-RUNTIME variables

2024-03-06T16:54:54+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: 11e1ba97edac979868f199e43c1004db6678044c) Signed-off-by: Michael Opdenacker Reported-by: Tim Orling Signed-off-by: Richard Purdie

contributor-guide: add notes for tests

2024-03-06T16:54:54+00:00

This adds some hints that and how changes should be tested when contributing. Fixes [YOCTO #15412] (From yocto-docs rev: 6f3dbb2a909ba5b71efb09b251ee3f8650e30146) Signed-off-by: Simone Weiß Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

dev-manual: packages: fix capitalization

2024-03-06T16:54:54+00:00

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

ref-manual: variables: adding multiple groups in GROUPADD_PARAM

2024-03-06T16:54:54+00:00

Add missing documentation on how to add multiple groups with a single GROUPADD_PARAM:${PN} (From yocto-docs rev: e55d2aa6a0ee58ee980de2a6ca8d531c7c0cd44a) Signed-off-by: Geoff Parker Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

ref-manual: variables: correct sdk installation default path

2024-03-06T16:54:54+00:00

The SDKPATH variable seems mistakenly identified as the default path where the SDK will be installed by the generated installation script, unless option '-d' or a manual input overrides this default. The intended variable is SDKPATHINSTALL. SDKPATH indicates where the SDK is being composed and built. The definitions have been added/updated. (From yocto-docs rev: d5b9c4b9c443cc728a11fd1e0a26a11aac8ee2c5) Signed-off-by: Johan Bezem Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

ref-manual: tasks: do_cleansstate: recommend using '-f' instead for a shared sstate

2024-03-06T16:54:54+00:00

do_cleansstat can produce build errors when using a shared sstate cache. Add a note to clearly discourage, provide a safe alternative (bitbake -f), and the rationale. Suggested-by: Quentin Schulz Link: https://lore.kernel.org/yocto-docs/20240219155513.76738-1-luca.ceresoli@bootlin.com/T/#m5529687ecb0f9ec2dacddcb6ff58e2df73af9cde (From yocto-docs rev: 6fb06bb4a917c1515e54fa3e699119f6bbb85767) Signed-off-by: Luca Ceresoli Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

ref-manual: tasks: do_cleanall: recommend using '-f' instead

2024-03-06T16:54:54+00:00

do_cleanall can produce failures when used in legitimate cases, such as with recipe variants (foo and foo-native) or a shared DL_DIR. This is why it is forbidden when writing tests that will run on the autobuilders (https://docs.yoctoproject.org/test-manual/intro.html?highlight=cleanall#considerations-when-writing-tests). Reword the documentation to clearly discourage, provide a safe alternative (bitbake -f -c fetch), and the rationale with an example. Reported-by: Sam Liddicott Link: https://bootlin.com/blog/yocto-sharing-the-sstate-cache-and-download-directories/#comment-2650335 (From yocto-docs rev: bfeb00f9213b9d2650ccf03ea666387415227be4) Signed-off-by: Luca Ceresoli Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

ref-manual: classes: add cve status check for oe.qa

2024-03-06T16:54:54+00:00

With a new check was added for oe.qa for CVE_STATUS via commit 3c5b7605acd9cd68b ("cve-check: Log if CVE_STATUS set but not reported for component") in poky. Add related documentation here. (From yocto-docs rev: 04e1ff01e1b43daa0e5832904a82f95d0cfab678) Signed-off-by: Simone Weiß Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

dev-manual: packages: need enough free space

2024-02-24T16:13:29+00:00

Enough free storage space is needed to apply package upgrades. (From yocto-docs rev: 6571eb02cbd5c2b96df0f279f25b63255ab7eac4) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie