linux/poky.git/documentation/overview-manual, branch scarthgap-5.0.13

overview-manual/yp-intro.rst: fix broken link to article

2025-08-20T14:37:19+00:00

(From yocto-docs rev: 1f7bad17b9457c9e74273bceb962c53eb60fdfe3) Signed-off-by: Erik Lindsten Signed-off-by: Antonin Godard (cherry picked from commit b9680ad83ad3fc5e2b87594f7c62c057134d198b) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

overview-manual/concepts.rst: fix sayhello hardcoded bindir

2025-07-11T15:11:53+00:00

Replace the hardcoded /usr/bin by ${bindir}, as it should be. Reported-by: Thomas Perrot (From yocto-docs rev: f06601fd09d6394fcc02134f24e337a9e6170584) Signed-off-by: Antonin Godard (cherry picked from commit 576677eae6960dbc2d2ececeba0fde5bba7bb69f) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

overview-manual: small number of pedantic cleanups

2025-06-20T15:38:12+00:00

In Sections 4.3.1 and 4.3.2 of the Overview Manual, a bit of tidying including: - provide full list of packaging options - add monospaced rendering where appropriate - fix broken "ref" - make capitalization consistent (From yocto-docs rev: 7abe7dde0cbb34a56af30452104355688775ef2b) Signed-off-by: "Robert P. J. Day" Signed-off-by: Antonin Godard (cherry picked from commit 1cf769e3c8a8442cd05449dc97e91ad482d635f3) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

sphinx-lint: unbalanced inline literal markup

2025-05-27T16:38:57+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: 0ba5429953dfa0cdc983ed13ddd06351116031c7) Signed-off-by: Trevor Woerner Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

documentation/conf.py: define a manpage url

2025-04-28T15:18:53+00:00

By defining the manpages_url we can use the :manpage: role in the documentation for providing links to manpages. See: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url Replace existing manpages links to use this role. Reviewed-by: Quentin Schulz (From yocto-docs rev: 73faf4a4fdd3d536e8af92b49bf067746cd9fa05) Signed-off-by: Antonin Godard (cherry picked from commit 4e63cd74cd1a330ea5e96bb04243a90f607b2857) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

overview-manual/concepts: remove PR from the build dir list

2025-03-26T15:48:51+00:00

PR was removed by cc83e4548465 ("bitbake.conf: Drop PE and PR from WORKDIR and STAMP") on OE-Core. (From yocto-docs rev: 56db4fd81f6235428bef9e46a61c11ca0ba89733) Signed-off-by: Antonin Godard (cherry picked from commit d7a1038ee7c8c463623f0996963f9e8f29d40555) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

overview-manual: concepts: add details on package splitting

2024-10-30T15:30:00+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: ccda7c8bb890a290fb41e104f6d818076f4eeaa8) 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-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