linux/poky.git/documentation/dev-manual, branch yocto-5.1.1

dev-manual: bblock: use warning block instead of attention

2024-11-26T13:37:10+00:00

Sphinx recommends using warning and note here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives Suggested-by: Quentin Schulz Reviewed-by: Quentin Schulz (From yocto-docs rev: 8288c8cae7fe7303e89d8ed286de91fc26ce6cc3) Signed-off-by: Antonin Godard (cherry picked from commit ed49067f172637d38d470a864feed2a02bd84c66) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

dev-manual: document how to provide confs from layer.conf

2024-11-26T13:37:10+00:00

Add a section on providing global level configuration from the layer.conf file. Since this file is parsed at an earlier stage in the parsing process, it's not possible to combine bb.utils.contains and {DISTRO,MACHINE}_FEATURES to conditionally set some configurations. This patch documents: - First that this file can be used for providing such configuration. - Then demonstrate how to conditionally provide them, using a technique that is currently used in meta-virtualization (https://git.yoctoproject.org/meta-virtualization/tree/conf/layer.conf#n50). Fixes [YOCTO #12688]. Reviewed-by: Quentin Schulz (From yocto-docs rev: b73e99b161a11a46a1a96ff42135893e0c978e2a) Signed-off-by: Antonin Godard (cherry picked from commit 31e5bd3e82e11f77da2abd96eb8c17a7c8194b7c) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

dev-manual: add bblock documentation

2024-11-11T17:16:26+00:00

bblock is a helper tool to lock/unlock tasks and recipes to specific signatures. Add a documentation page for it. (From yocto-docs rev: 5692ad6f023289dda63567c1f79132854ae3899d) Signed-off-by: Julien Stephan Reviewed-by: Antonin Godard Signed-off-by: Antonin Godard (cherry picked from commit a082aa39840587d3af6c3f4a2c2747564ca37414) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

dev-manual: Add info on build env initialization

2024-06-16T21:48:18+00:00

Going through the docs we a new trainee, we noticed that the build initialization is only mentioned in the quick build (https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html) but not in the in-depth getting started documentation. While this is repeatedly mentioned later on, e.g. in the "building" section, you might easily end up somewhere where this has not been mentioned yet. E.g. in our case this was: https://docs.yoctoproject.org/dev-manual/layers.html# (which comes right after the "setup" chapter) -> https://docs.yoctoproject.org/dev-manual/layers.html#creating-a-general-layer-using-the-bitbake-layers-script (which is linked right at the top) To avoid any confusion I think it best to mention this required step directly in the "start" document. (From yocto-docs rev: d7a36b7b8e770ae45b991698d588f9522ba59b4e) Signed-off-by: Jasper Orschulko Reviewed-by: Michael Opdenacker Signed-off-by: Alexandre Belloni Signed-off-by: Richard Purdie

manuals: document NVDCVE_API_KEY variable

2024-05-29T19:58:49+00:00

Add brief documentation of NVDCVE_API_KEY variable, that was added in 4.2.3, and emphasize that its use results in lower NVD API request times. (From yocto-docs rev: 9c7b452441bad2d7c929383d4665dfddb8f7ea72) Signed-off-by: Noe Galea Reviewed-by: Michael Opdenacker Reviewed-by: Andrew Murray Signed-off-by: Richard Purdie

dev-manual: update custom distribution section

2024-04-16T06:55:42+00:00

In keeping with the addition of the motd message pointing out that the poky DISTRO is a reference distribution, adjust the opening of the Creating Your Own Distribution section to match. Additionally, add a section on the end pointing out what users need to consider if they just take a copy of the poky distribution and modify it. (From yocto-docs rev: 3dc812e7255ba7c0ddd7b43b9b1319ea4ef3161e) Signed-off-by: Paul Eggleton Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

dev-manual: update reference to sstate-cache-management script

2024-04-16T06:55:42+00:00

* Script is now .py * In the example, we would most likely be within the build directory already, so the path would be just "sstate-cache" not "build/sstate-cache" (From yocto-docs rev: a655ef8f5fee98e55277cbd40a092fcae697cbae) Signed-off-by: Paul Eggleton Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

dev-manual/debugging: mention new ``taskexp_ncurses`` option

2024-04-12T16:29:34+00:00

(From yocto-docs rev: 301c802a92a2c53c3d0c755c31a6e09130956fde) Signed-off-by: Michael Opdenacker Suggested_by: Reyna, David Signed-off-by: Richard Purdie

manuals: remove tab characters

2024-04-12T16:29:34+00:00

As reported by "make sphinx-lint" Tabs are even removed in Makefile examples, as Sphinx turns them to spaces anyway in the generated output. (From yocto-docs rev: 20e9c0c9fad3109567948af6bc40bb0fa2a5552b) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

manuals: fix incorrect double backticks

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

As reported by "make sphinx-lint" (From yocto-docs rev: 1601bf2d294c3a8e7c4c654539c8a4da3ed054d0) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie