linux/poky.git/documentation/ref-manual, branch nanbield

ref-manual: add documentation of the variable SPDX_NAMESPACE_PREFIX

2024-03-28T17:08:31+00:00

The documentation of the variable SPDX_NAMESPACE_PREFIX does not exist. This variable is used to change the prefix of some links in SPDX docs. (From yocto-docs rev: 33ed2376b501022daf24003e4e6352a91fcb06ee) Signed-off-by: BELOUARGA Mohamed Reviewed-by: Michael Opdenacker Signed-off-by: Steve Sakoman

manuals: use "manual page(s)"

2024-03-28T17:08:30+00:00

Instead of "manpage(s)" or "man page(s)". To address one of the errors reported by "make stylecheck" (From yocto-docs rev: 7d9faaf283454d653e541a8faf0d50f4c968cc66) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman

manuals: document VIRTUAL-RUNTIME variables

2024-03-16T18:33:21+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: 692ee19c99d015adf79da540b03d12245f7024f4) Signed-off-by: Michael Opdenacker Reported-by: Tim Orling Signed-off-by: Steve Sakoman

ref-manual: variables: adding multiple groups in GROUPADD_PARAM

2024-03-16T18:33:21+00:00

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

ref-manual: variables: correct sdk installation default path

2024-03-16T18:33:21+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: ef86bec59f5bd81963e0013fce63a1960df53c57) Signed-off-by: Johan Bezem Reviewed-by: Michael Opdenacker Signed-off-by: Steve Sakoman

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

2024-03-16T18:33:21+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: fe023e48a5014e838fb74b77cdf8b0d546db0d21) Signed-off-by: Luca Ceresoli Reviewed-by: Quentin Schulz Signed-off-by: Steve Sakoman

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

2024-03-16T18:33:21+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: c8ba32df7576ceb4b8371595e14ad51bdb3e33b1) Signed-off-by: Luca Ceresoli Reviewed-by: Quentin Schulz Signed-off-by: Steve Sakoman

manuals: suppress excess use of "following" word

2024-03-13T13:59:26+00:00

To simplify the style, replace "Following is" and "Following are" by "here is" and "here are", sounding more natural. In some cases, also go further by simplifying "Here are/is xxx" by "xxx are/is" when the "are" or "is" are not two far at the end of the sentence. In some cases too, completely remove the sentence, when it's redundant with the preceding title. (From yocto-docs rev: da1cbd7083238657aaeaea16841b24531c86298e) Signed-off-by: Michael Opdenacker CC: Daniel Ammann Signed-off-by: Steve Sakoman

ref-manual: release-process: grammar fix

2024-03-13T13:59:26+00:00

(From yocto-docs rev: e5d03de84a327332d20e74a8634bccfe0bf9405a) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman

ref-manual: system-requirements: update packages to build docs

2024-03-13T13:59:26+00:00

- "git" is now required to run "set_versions.py" - Fix Ubuntu / Debian packages. The previous instructions didn't run on Debian 12 Tested on Ubuntu 22.04 and Debian 12. Reported on https://lists.yoctoproject.org/g/docs/message/4789 (From yocto-docs rev: 1e32b69e1317c05069878e882023a17294cc0524) Signed-off-by: Michael Opdenacker Reported-by: Signed-off-by: Steve Sakoman