linux/poky.git/documentation/overview-manual, branch kirkstone-4.0.28

sphinx-lint: unbalanced inline literal markup

2025-05-28T15:46:32+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 heading which contain literals enclosed in double-back-tics, and not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 2c1e5b080ad5e62d8283d332cbc473fd2d59c6e6) Signed-off-by: Trevor Woerner Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

overview-manual: concepts: add details on package splitting

2024-11-02T13:06:09+00:00

The package splitting section of the overview manual currently lacks any explanation of how package splitting is implemented and redirects to the package class, which is not really understandable for newcomers to the project. This patch adds a short explanation of what is done: * How the PACKAGES variable is defined. * How the FILES variable is defined. * How the two work together. * How to add a custom package. This should give enough details to a new user on what package splitting achieves and how to add a custom package. Adresses [YOCTO #13225] Reviewed-by: Quentin Schulz (From yocto-docs rev: ef4150029d377ce1c35645971502ae56345915a6) Signed-off-by: Antonin Godard (cherry picked from commit 143c3cacdec36c9d7ab81c89bbcc12c0c3936bd9) Signed-off-by: Antonin Godard 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: 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: 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

manuals: updates for building on Windows (WSL 2)

2024-03-01T15:19:55+00:00

- Use the Wikipedia naming scheme: WSL 2 instead of WSLv2 - Take into account Windows Server 2019 and 2022 which are supported too. - Improve some explanations (From yocto-docs rev: e64c1154c358128d76b1b8e3a5809dbaa8dc6881) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Steve Sakoman

manuals: suppress excess use of "following" word

2024-03-01T15:19:54+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: 2539f1b9cbf9bdd40eff93c6522dc76133debed7) Signed-off-by: Michael Opdenacker CC: Daniel Ammann Signed-off-by: Steve Sakoman

manuals: document VSCode extension

2024-01-24T14:04:56+00:00

The VSCode extension is now officially maintained and published by the Yocto Project so it should be referenced in the manuals to help users discover it. I located the most relevant places to reference the extension by looking at how the old Eclipse plugin was documented in the 2.6 manuals as well as the current Toaster references. (From yocto-docs rev: 21ec0d3b52069dfc85ff47fb4f913a26a092c480) Signed-off-by: Enguerrand de Ribaucourt Reviewed-by: Michael Opdenacker Signed-off-by: Steve Sakoman

manuals: update class references

2023-11-28T15:00:32+00:00

Synchronizing with master whenever possible, to make the branch easier to maintain. (From yocto-docs rev: 825b1292ab08770b2d8cfdc1e11358a2790c1a1b) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman

overview-manual: concepts: Add Bitbake Tasks Map

2023-11-28T15:00:32+00:00

Create a Map to detail how BitBake handles a recipe's tasks and its compile/runtime dependencies along with detailed comments. (From yocto-docs rev: 529c7bf6c434166f4d372166868d46f275eb5bea) Signed-off-by: Talel BELHAJSALEM Reviewed-by: Michael Opdenacker Signed-off-by: Steve Sakoman