linux/poky.git/documentation/overview-manual, branch 5.2_M2

overview-manual: concepts: add details on package splitting

2024-10-25T14:31:57+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: 143c3cacdec36c9d7ab81c89bbcc12c0c3936bd9) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

manuals: fix trailing spaces

2024-04-08T13:36:38+00:00

Fixing errors reported by "make sphinx-lint" (From yocto-docs rev: ef6b650c31c4320314564bb85a45eebde3fd98c1) Signed-off-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

manuals: suppress excess use of "following" word

2024-02-24T16:13:28+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: 52ba6bb16c73cbc2c0e77496d5226c49bce786f5) Signed-off-by: Michael Opdenacker CC: Daniel Ammann Signed-off-by: Richard Purdie

manuals: document VSCode extension

2024-01-12T11:34:05+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: 645153504690aa8a69b028e95a5e9d2da9644cf1) Signed-off-by: Enguerrand de Ribaucourt Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

overview-manual: concepts: Add Bitbake Tasks Map

2023-11-06T22:52:27+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: 7f0ab56aa302babab6c9d600a8d8a91708cf75f7) Signed-off-by: Talel BELHAJSALEM Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

overview: Add note about non-reproducibility side effects

2023-10-09T14:52:17+00:00

Adds an additional note about some of the side effects that can occur if recipes are not reproducible and hash equivalence is enabled. (From yocto-docs rev: 1ccc8eefe21bc432c903bb245bd0dab06e67cc14) Signed-off-by: Joshua Watt Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

contributor guide: update instructions for making and sharing changes

2023-08-30T14:54:59+00:00

- Shifting the focus to multiple changes instead of just one - Advising to create a branch for changes - Removing unnecessary or too verbose explanations - Adding useful resources and examples (From yocto-docs rev: e7e47121fd979e034f8f40a043912640a6a25a5e) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: create a dedicated "Contributor Guide" document

2023-08-30T14:54:59+00:00

Starting from the original contents of dev-manual/changes.rst and from text contributed by Richard Purdie. (From yocto-docs rev: 55587d9dd009cbc92273376e0f7665b2d574d280) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

docs: fix unnecessary double white space

2023-06-24T11:23:01+00:00

There's no need for double white spaces here so let's just remove them. Cc: Quentin Schulz (From yocto-docs rev: e41f6689157359777c3d86d9a7afed6f9e43782b) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie