linux/poky.git/documentation/overview-manual, branch walnascar-next

documentation/conf.py: define a manpage url

2025-04-03T15:29:51+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: 0d0115cb2d96960837678f775cf5c2297494c51c) Signed-off-by: Antonin Godard (cherry picked from commit 4e63cd74cd1a330ea5e96bb04243a90f607b2857) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

overview-manual/concepts: add UNPACKDIR in the directory description

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

Mention that UNPACKDIR is used as a location to unpack the source code, and that S is the final location of the source code. This is deliberately vague, because as there are multiple instances of how these directories can be defined and used. The proper explanation of how the UNPACKDIR and S directories interact is left to the reference manual, under the UNPACKDIR variable description. (From yocto-docs rev: 76361ae37bd45c9ce5190fb6c7c400bf2fc14003) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

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

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

PR was removed by cc83e4548465 ("bitbake.conf: Drop PE and PR from WORKDIR and STAMP") on OE-Core. (From yocto-docs rev: 569c707c69a7a858553e40b26cb36db18f2a42fc) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

overview-manual: convert analysis-for-package-splitting.png to svg

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

- Convert the png file to an SVG file - Add the UNPACKDIR reference. - Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf: Drop PE and PR from WORKDIR and STAMP") on OE-Core. - Change S value to BP (equal to ${BPN}-${PV}, but more accurate). (From yocto-docs rev: 6fd6af3ea9e556e481cc3c0358c0357b6060798f) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

overview-manual: convert configuration-compile-autoreconf.png to svg

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

- Convert the png file to an SVG file - Add the UNPACKDIR reference. - Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf: Drop PE and PR from WORKDIR and STAMP") on OE-Core. - Change S value to BP (equal to ${BPN}-${PV}, but more accurate). (From yocto-docs rev: f24b00200ac49cda07e4c77e3e1b161a5b78b006) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

overview-manual: convert patching.png to svg

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

- Convert the png file to an SVG file. - Add the new UNPACKDIR directory to the image. - Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf: Drop PE and PR from WORKDIR and STAMP") on OE-Core. - Change S value to BP (equal to ${BPN}-${PV}, but more accurate).- Reviewed-by: Quentin Schulz (From yocto-docs rev: 73b6c0c5e5470d4a929fd3d5cde6d4fb0ace53b8) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

overview-manual: convert source-fetching.png to svg and fix UNPACKDIR

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

- Convert the png file to an SVG file. - Add the new UNPACKDIR directory to the image. - Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf: Drop PE and PR from WORKDIR and STAMP") on OE-Core. - Change S value to BP (equal to ${BPN}-${PV}, but more accurate).- This fixes [YOCTO #15730]. Reviewed-by: Quentin Schulz (From yocto-docs rev: 9fc105137d54523b1f9a477fe7b52587a6bcb6c8) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

Move devtool doc from extensible to dev manual

2025-02-07T17:52:48+00:00

[YOCTO #13417] devtool is not directly tied to the Extensible SDK anymore, and instructions in there can be split and added to the development manual. This patch is a simple bulk move, except for the following: - Intro added to the devtool.rst document (mostly copy-pasted from the devtool quick reference in the ref-manual). - Figures renamed to remove "sdk-" from filenames. - References to sdk-manual/extensible replaced by dev-manual/devtool. Reported-By: Paul Eggleton (From yocto-docs rev: 044d3185b858fce1febcfe3a6834b883f9a598fa) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

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