linux/poky.git/documentation/ref-manual, branch kirkstone-4.0.18

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

manuals: refer to new yocto-patches mailing list wherever appropriate

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

There's a new yocto-patches mailing list available for all layers that do not have their own mailing list. c.f. https://lists.yoctoproject.org/g/yocto/topic/105197684 Cc: Quentin Schulz (From yocto-docs rev: d7fc3e978440d9f5724cbce85de000317a3e0783) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Steve Sakoman

ref-manual: add documentation of the variable SPDX_NAMESPACE_PREFIX

2024-04-05T14:24:00+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: 0055b7ea1cdf72359695e08fe6d2ca9a405fba51) Signed-off-by: BELOUARGA Mohamed Reviewed-by: Michael Opdenacker Signed-off-by: Steve Sakoman

manuals: use "manual page(s)"

2024-04-05T14:23:59+00:00

Instead of "manpage(s)" or "man page(s)". To address one of the errors reported by "make stylecheck" (From yocto-docs rev: f6e69f8877d1d33200993f21b448e7fa3cf7859b) Signed-off-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

manuals: replace hyphens with em dashes

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

Fix some hyphens being improperly used as em dashes. See https://www.grammarly.com/blog/hyphens-and-dashes/ Using em dashes may also allow Sphinx to hyphenate and break lines in the best way. Note that the first character after an em dash not supposed to be capitalized, unless a specific rule applies, typically when what follows is a proper noun. Fix a few misuses of parentheses in following text. (From yocto-docs rev: a0d93ea1ddfdfbcde8dac3aa328307be778f9e3c) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie Signed-off-by: Steve Sakoman

ref-manual: variables: adding multiple groups in GROUPADD_PARAM

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

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

ref-manual: variables: correct sdk installation default path

2024-03-25T14:11:26+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: f7ce2abbdcff625356b337137e91f642ff6a4dc2) 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-25T14:11:26+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: 3fb8b5ad7edfa186744396deb7111ba3e31a857b) Signed-off-by: Luca Ceresoli Reviewed-by: Quentin Schulz Signed-off-by: Steve Sakoman