linux/poky.git/documentation/dev-manual, branch 5.3_M1

sphinx-lint: unbalanced inline literal markup

2025-05-26T12:02:49+00:00

Fix as many instances of unbalanced-inline-literals-delimiters as reported by 'make sphinx-lint' as possible. Sphinx and/or its linter seem to get tripped up randomly when references contain links to a heading which contain literals enclosed in double-back-tics; especially in the cases where a heading either contains multiple literals or when the literal is not at the end of the heading. Not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 3460177c46d360b0f2f852cdab23f21bd4ec6d5a) Signed-off-by: Trevor Woerner Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

sphinx-lint: superfluous backtick in front of role

2025-05-26T12:02:49+00:00

Fix all instances of backtick-before-role as reported by 'make sphinx-lint'. (From yocto-docs rev: d38f9b25c0bd095fe1158f14226fb74f8645496a) Signed-off-by: Trevor Woerner Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

sphinx-lint: various fixes

2025-05-19T14:54:10+00:00

A 'make sphinx-lint' pass found the following issues: trailing-whitespace missing-space-after-literal role-with-double-backticks missing-space-before-role (role missing opening tag colon) (From yocto-docs rev: 6d4c67457e00a80dda4cd05bc5f05d8ebd8da5fc) Signed-off-by: Trevor Woerner Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

sbom.rst: how to disable SPDX generation

2025-05-19T14:54:10+00:00

Generating SPDX is enabled by default in poky but it can take a lot of build time resources so document how to disable it. (From yocto-docs rev: bcd58b7a9455fbb0ea5944089d663e327f0eb38f) Signed-off-by: Mikko Rapeli Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

Fix dead links that use the DISTRO macro

2025-04-21T20:15:29+00:00

After introducing the DISTRO_LATEST_TAG and DISTRO_REL_LATEST_TAG macros, use them in links that currently use DISTRO/DISTRO_REL_TAG. When building for the tip of a branch, this will replace the current A.B.999 in links to the latest existing tag. The links were found across the documentation by running 'grep -r "http.*5\.2\.999"' inside the _build/html output after building the docs. [YOCTO #14802] (From yocto-docs rev: 29be069ebbf2c55d72fc51d99ed5a558af37c05e) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

dev-manual: remove qemu machine name list in runqemu invocation

2025-03-24T17:32:34+00:00

This list of "valid" qemu machine names is obsolete and incorrect, so just remove it as it serves no real purpose. (From yocto-docs rev: ee8839480fe574598b4d52a8fd6c11bb301ad3d9) Signed-off-by: Ross Burton Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

Remove all mention of core-image-lsb

2025-03-07T17:04:26+00:00

core-image-lsb was removed in 2019[1], so remove all of the incredibly obsolete references in the documentation. [1] oe-core fb064356af615d67d85b65942103bf943d84d290 (From yocto-docs rev: 062445a49919eff117b5478c1fb18d125c1f895c) Signed-off-by: Ross Burton Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

dev-manual/multiconfig: add suggested best practices and baremetal sections

2025-02-26T14:49:28+00:00

After the suggestions from Mark Hatle on the list (https://lists.yoctoproject.org/g/docs/topic/110487932), add two sections to the multiconfig doc: - Suggested best practices: suggestion for better design of multiconfig builds. - Common use case: baremetal build. This section applies the guidelines from the first sections and apply it to a real-life example of how to use multiconfig. This one to build some baremetal firmware alongside a regular Linux build. Suggested-by: Mark Hatle Reviewed-by: Quentin Schulz (From yocto-docs rev: 36fb1e9e5099aa0d858d5478530143e9bac39588) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

dev-manual/multiconfig: improve the current doc

2025-02-26T14:49:28+00:00

After the suggestions from Mark Hatle on the list (https://lists.yoctoproject.org/g/docs/topic/110487932), rewrite the introduction to multiconfig with the following changes: - Move the part of overriding TMPDIR or not to a note. - Use BB_CURRENT_MC in the example. - Various additions of references & improved formatting. Suggested-by: Mark Hatle Reviewed-by: Quentin Schulz (From yocto-docs rev: 8cedef6d5b701235325e6e0bdd793f8c06dfef57) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

dev-manual/multiconfig: rename to use Multiconfig term

2025-02-26T14:49:27+00:00

Rename this section to explicitely name the multiple configuration feature "multiconfig". Reviewed-by: Quentin Schulz (From yocto-docs rev: 286db24f37bf16a157d3897a046f1fc0d33a44b4) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie