Commit Graph

2602 Commits

Author SHA1 Message Date
Antonin Godard
c154a5ac7d ref-manual/variables: document KMETA* and KCONF_AUDIT* variables
Document the variables used to control the outcome of the kernel
configuration auditing done by the kernel-yocto bbclass.

[YOCTO #13835]

Acked-by: Bruce Ashfield <bruce.ashfield@gmail.com>
(From yocto-docs rev: f75a1c1a1447ed52dc6561c67e6afb5fd1413f28)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-07 17:04:26 +00:00
Ross Burton
7f91376d2e ref-manual: remove OE_IMPORTS
oe-core no longer supports OE_IMPORTS[1], so remove the documentation.

[1] oe-core 1f56155e ("base: Switch to use addpylib directive and
    BB_GLOBAL_PYMODULES")

(From yocto-docs rev: d03dad11974ada7a99b4406e2350b9f5f0acc746)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-07 17:04:26 +00:00
Ross Burton
dcaaf3ed57 ref-manual: don't refer to poky-lsb
This was removed in 2019, so swap it for poky-altcfg.

(From yocto-docs rev: 7f7f6570befdda280c174a5f9776b20f53f3ea0d)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-07 17:04:26 +00:00
Ross Burton
63c8e8e530 Remove all mention of core-image-lsb
core-image-lsb was removed in 2019[1], so remove all of the  incredibly
obsolete references in the documentation.

[1] oe-core fb064356af615d67d85b65942103bf943d84d290

(From yocto-docs rev: 062445a49919eff117b5478c1fb18d125c1f895c)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-07 17:04:26 +00:00
Adrian Freihofer
657b458332 ref-manual: cover UBOOT_ENV variables
(From yocto-docs rev: dc2ff96a3401eba8dac86fc8305b261be52c8a13)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-07 17:04:26 +00:00
Antonin Godard
a3669b55f1 variables.rst: add a reference to BB_CURRENT_MC from bbdocs
BB_CURRENT_MC is documented in the Bitbake user manual. Add a reference
to it here.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: a9aaef86bf76027f602546b5d4a3dffc6168d9b4)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:27 +00:00
Marta Rybczynska
8bb220aa11 vulnerabilities/classes: remove references to cve-check text format
The text format has been removed, so also remove references and examples
using this format. Replace with examples with the JSON format.

(From yocto-docs rev: a52cd7bcadccc53e982f90d6e170d00798322597)

Signed-off-by: Marta Rybczynska <marta.rybczynska@ygreky.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:27 +00:00
Weisser, Pascal
b3347ef726 ref-manual: Add missing variable IMAGE_ROOTFS_MAXSIZE
This patch adds the missing documentation of variable IMAGE_ROOTFS_MAXSIZE
to the reference manual.

(From yocto-docs rev: 1dcc8cf7c49da449b324a7bd6bb22effe1d53d70)

Signed-off-by:
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:27 +00:00
Yoann Congal
835af80553 ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS
This documents the variable used in the "automate testing a single
recipe's reproducibility" feature [YOCTO #15701]

(From yocto-docs rev: 417b423ea3d2ba9903d21d930c1982ff2ac6f596)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:27 +00:00
Quentin Schulz
9d7930a4e0 docs: use literalinclude for system requirements
The YAML variables for the host dependencies are updated by hand and
actually only used inside code blocks.

Let's migrate all instructions into separate shell scripts that are then
literalinclude'd into the Sphinx documentation.

This allows a few things:
- ability to run shellcheck on the scripts if we ever want to
- manually calling the appropriate script from a supported distro to
  build stuff (distro or bitbake/yocto stuff)
- use this script to create containers to do CI of documentation on
  different distros, to make sure our instructions are all up to date,

(From yocto-docs rev: 8d993022c2aefc0fde9baa949d39d7a3613f9f46)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Tested-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-18 15:47:37 +00:00
Simon A. Eugster
42957c5c25 ref-manual: Describe grub-efi-cfg overrides and GRUB_TITLE
This patch describes how to use overrides for grub-efi-cfg because that
is otherwise only clear after reading the .bbclass file. It also adds
a description for GRUB_TITLE.

(From yocto-docs rev: b9ec7d124c9cbaf6c05415277fa028a39ce9e02f)

Signed-off-by: "Simon A. Eugster" <simon.eu@gmail.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-07 17:52:48 +00:00
Antonin Godard
0eb974d972 ref-manual/faq: add q&a on systemd as default
Originally written by Richard Purdie, but formatted in rst syntax and
slight rephrasing.

Cc: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 568922014e5c00ecf0c3d19b8c7fefa0e3801183)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-07 17:52:48 +00:00
Antonin Godard
cfe5da1f75 Move devtool doc from extensible to dev manual
[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 <bluelightning@bluelightning.org>
(From yocto-docs rev: 044d3185b858fce1febcfe3a6834b883f9a598fa)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-07 17:52:48 +00:00
Quentin Schulz
fc3e3399c5 ref-manual: variables: fix spurious parenthesis
There's no opening parenthesis, so let's remove the spurious closing
parenthesis.

Fixes: ea638e85316d ("ref-manual/variables: document the KERNEL_CONSOLE variable")
(From yocto-docs rev: 6f0e150179db2a2a8e9ad879167e0d84137190dc)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-01-29 10:41:59 +00:00
Enrico Jörns
dfab86d2f4 ref-manual: add documentation for the barebox class
This adds the initial documentation for the newly added barebox.bbclass
to the Reference Manual's class list.
It also adds the two most notable variables to the variable list.

(From yocto-docs rev: cc8179122441cdc26ff62511dcd97f7bf9bf7e3d)

Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-01-29 10:41:59 +00:00
Antonin Godard
43647390ad Update autobuilder URLs to valkyrie
We have moved to Valkyrie which is hosted on
https://autobuilder.yoctoproject.org/valkyrie. Update the URL in the
documentation.

Also, the YOCTO_AB_URL macro was used in a single location in the
documentation so replace it by the :yocto_ab: custom extlink and remove
the macro.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 0b0ed55d909dd11cdc9b29b105473271627c025e)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-01-20 13:45:06 +00:00
Antonin Godard
d6ae2c0dec ref-manual: move runtime-testing section to the test-manual
In the same fashion as the previous commit ("ref-manual/packages: move
ptest section to the test-manual"), move the runtime testing section of
the development tasks manual to the test environment manual.

Add a link to it from the test-manual/intro document.

(From yocto-docs rev: 6b44257874858db3aa426d3e84a79c41cb4937a3)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-01-09 13:58:17 +00:00
Antonin Godard
d720994f02 ref-manual/packages: move ptest section to the test-manual
[ YOCTO #15106 ]

It makes more sense to document ptests in the test-manual. Since ptests
are still related to packages, keep a link to ptests from packages.rst
to the test-manual.

Reported-by: Yoann Congal <yoann.congal@smile.fr>
(From yocto-docs rev: b389c06b709e4791e1cce5e8a5b58f6b0cd03a14)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-01-09 13:58:17 +00:00
Antonin Godard
b301c74baf SSTATE_MIRRORS/SOURCE_MIRROR_URL: add instructions for mirror authentication
[ YOCTO #15218 ]

There are different ways of configuring the build host when
authentication to a mirror (SSTATE_MIRRORS or SOURCE_MIRROR_URL) is
required.

Document these methods, and begin with the preferred approach which is
to edit ~/.netrc appropriately. When that is not possible, specifying
the credentials from the URL is also possible, so document it as well.

Reported-by: peter.zsifkovits@at.bosch.com
Tested-by: Antonin Godard <antonin.godard@bootlin.com> # Debian 12 container
(From yocto-docs rev: 4c303cce0627e0f2ce52e72597541e220585aaed)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-01-09 13:58:17 +00:00
Antonin Godard
3ca1044360 ref-manual/devtool-reference: add warning note on deploy-target and shared objects
The command `devtool deploy-target` does not handle any dependency of
the application, even when properly listed in DEPENDS or RDEPENDS. While
the current documentation was clear on that, it felt needed to add a
note on the fact that build-time dependencies may also result in
runtime dependencies, especially for people new to the project.

Add a warning block below the existing deploy-target documentation.
Also, link to the Overview and Concepts page, which explains it
thoroughly.

[ YOCTO #14377 ]

Reported-By: Robert Berger <pokylinux@reliableembeddedsystems.com>
(From yocto-docs rev: 56c84004daad5f8a5db53e36852331435d57c8af)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-01-09 13:58:17 +00:00
Antonin Godard
18b9d46d31 ref-manual/qa-checks: remove patch-status-core/patch-status-noncore
These QA checks were merged as "patch-status" after commit
61a881fdbe8b5a21c6276b8a5d06cc30486b1eb3 ("insane: Improve patch-status
layer filtering") in OE-Core.

[ YOCTO #15345 ]

Reported-By: Diego Sueiro <diego.sueiro@arm.com>
(From yocto-docs rev: 3f3a9f53fea6c7d533b9e999dc959dcc3bed7745)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-01-09 13:58:17 +00:00
Antonin Godard
4e49c8bfa5 ref-manual/variables: document the PREFERRED_RPROVIDER variable
This variable is similar to the PREFERRED_PROVIDER variable but it
denotes a runtime provider specifically.

(From yocto-docs rev: 0b0b58070fceff6851a6e137f7f774e706205b32)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:47 +00:00
Antonin Godard
c8f553a177 ref-manual/variables: document the CARGO_INSTALL_LIBRARIES variable
This variable controls whether libraries compiled by recipes inheriting
cargo are installed or not.

(From yocto-docs rev: c42f80a12e9e71fa7dab9672fb3174ed006b214b)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:47 +00:00
Antonin Godard
30ab6f4153 ref-manual/classes: document the yocto-check-layer class
This class is used by the yocto-check-layer script to check if a layer
complies to the Yocto Project Compatible status.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: b3fd3c268ac3f15e4050a983289fc63e62f4c823)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:47 +00:00
Antonin Godard
9fba2b4a82 ref-manual/variables: document the CHECKLAYER_REQUIRED_TESTS variable
This was introduced in oecore by commit
ce2e42ace2d15fb6745437cf0a7f07d28398ca12 ("insane: Split ERROR_QA into
CHECKLAYER_REQUIRED_TESTS").

(From yocto-docs rev: 5b205e113015430f6d04e455af7c0d5643863fbc)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:47 +00:00
Antonin Godard
d6e3e5c00d Drop support for BB_DANGLINGAPPENDS_WARNONLY
Support for this variable was dropped in BitBake, see commit
fca9c9e3cb6f8e9f99bf51dc5e8a8d83f4c84c69 ("cooker: Drop support for
BB_DANGLINGAPPENDS_WARNONLY").

Drop this variable here as well and rewrite the "Appending Other Layers
Metadata With Your Layer" section to advise to rename the recipe and
check if the bbappend is still relevant - otherwise to use BBWARN.

(From yocto-docs rev: 10b59d09ebfb6c119995643ed68cb26092b6f2a4)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:47 +00:00
Antonin Godard
abef9b08dc Remove debug-tweaks references
We no longer provide this feature, so remove documentation for it. In
most cases, we can replace occurrences of "debug-tweaks" by
"allow-empty-password empty-root-password allow-root-login
post-install-logging" to achieve what this feature previously enabled.

Subtle, but the default local.conf does not include
post-install-logging, so in parts where there is mention of the default
local.conf file, adjust the documentation to only mention the first
three above.

In the intro manual, instead of providing instructions that replace
EXTRA_IMAGE_FEATURES entirely, provide ones that append
EXTRA_IMAGE_FEATURES.

(From yocto-docs rev: f0efd4c7df91863304b92514664bdd1fa62b1fbb)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:47 +00:00
Antonin Godard
e4c4208d12 ref-manual/classes: document the cython class
Small class added in oecore by commit
64b6e85808 ("classes-recipe: add cython
class").

(From yocto-docs rev: 0979e02b71b6c91fa27cdeacd70036564fbe1a2d)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:47 +00:00
Antonin Godard
ab4152528f ref-manual/variable: remove obsolete SETUPTOOLS_INSTALL_ARGS
Remove in oecore by commit b4bdfc78e8e1cb8b86221bc55d80d601ea1a065f
("python3-cython: remove obsolete SETUPTOOLS_INSTALL_ARGS").

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: a32b39a4d9bda124e6c19aa1db522656b1e7e807)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:46 +00:00
Antonin Godard
f38b4edf5f ref-manual/variables: document the WIC_SECTOR_SIZE variable
Added recently in oecore to control the sector size of wic images.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 075d4ac67c94d6442ea384b5b0ec68b1aa34a4c3)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:46 +00:00
Antonin Godard
1461717567 ref-manual/variables: add missing entries to SDK_ARCHIVE_TYPE
Both added recently in oecore.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 76b970718d237f60aefe02321d867bed3deb6069)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:46 +00:00
Antonin Godard
81412adb5e ref-manual/variables: document the FIRMWARE_COMPRESSION variable
Added in oecore after the 20241017 update.

(From yocto-docs rev: 9073f575f169ab545198d82b69cca5f9e3db152f)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:46 +00:00
Antonin Godard
f185c78263 ref-manual/classes: drop the migrate_localcount class
This class is obsolete and was removed from openembedded-core with
commits fca25fc4d7721f85f64c942307ebe7ba9f2fad3e ("migrate_localcount:
Drop long obsolete code") and d0f35207f9
("bitbake: fetch2: remove localcount and use AUTOINC instead").

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 0da4f50b2105e0ee2d992338b390e966f38a51c0)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:46 +00:00
Antonin Godard
60e143a589 ref-manual/variables: document the KERNEL_CONSOLE variable
This variables holds the value of the `console` kernel command line
parameter.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: ea638e85316d0bc5c9917cefacef168782e4d92b)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:46 +00:00
Antonin Godard
c9565b89d0 Update the documentation for SRCPV
The variable SRCPV is deprecated since 4.3. Instead of including SRCPV
in PV, including the sign "+" is enough for bitbake to add the source
control information to PKGV during the packaging phase.

Update the documentation for SRCPV and the places where it was used.
When instructions previously referred to SRCPV, replace by mentioning to
include "+" in the assignment.

In most examples, "+git" is added to PV as it is the most popular SCM.
Simply adding "+" is also possible, although it is better practice to
include the SCM name, so give that example.

Update the gcompat example with l3afpad as it didn't include "+git" in
its PV definition anymore.

(From yocto-docs rev: ee16c96202e5027d1a8d7e89e11c25f127c78326)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-20 12:47:59 +00:00
Antonin Godard
783347d27b system-requirements.rst: add dependencies for pdf builds
With the recent changes from commit
bd6265ca323fac547a197bb516dc4a9ef3897508 ("doc: Makefile: add support
for xelatex"), the list of dependencies needs to be updated.

The initial list of dependencies was made for Ubuntu/Debian, and the
packages were translated for the other distros using pkgs.org.

Add them separately from the rest of the dependencies as they pull a
_lot_ of additional dependencies (for LaTeX).

Move the texlive-fncychap documentation dependency to the PDF specific
dependency.

Notes:
- Fedora/OpenSUSE do not have the "lang-all" texlive collection, so
  install all available languages.
- AlmaLinux does not seem to provide texlive-collection-fontsextra,
  texlive-collection-lang*, and texlive-collection-latexextra, so add a
  warning about that.

(From yocto-docs rev: 02c090718ac602f7d4760dd28dadbf0631668d49)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-16 11:04:53 +00:00
Antonin Godard
8c7e7f6805 system-requirements: update list of supported distros
To match the list in meta-poky/conf/distro/poky.conf.

(From yocto-docs rev: c9c3f6896e4bc967a9b394574532735babb70397)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-16 11:04:53 +00:00
Antonin Godard
8e20e984f0 system-requirements: add fedora 39 to supported distros
(From yocto-docs rev: dc7fd0e56fbfed77975f6b4ed2106331476ef7f3)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-16 11:04:53 +00:00
Antonin Godard
9c8a31142b Gather dependencies in poky.yaml.in
We used to have packages here and there in system-requirements.rst for
each distro. Instead, gather all the dependencies in poky.yaml.in so we
have an overview of what we provide for each distro.

Use yaml ">" to list the dependencies in alphabetical order, one entry
per line, which makes them easier to read and compare among distros.

Rename UBUNTU_… variables to UBUNTU_DEBIAN_…, since these are used for
both distros.

(From yocto-docs rev: 1ed6118b7cf1b5dcbfca753c83fa30fb97bf44ad)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-16 11:04:53 +00:00
Guénaël Muller
1c9140b0d4 ref-manual: use standardized method accross both ubuntu and debian for locale install
Modify locale installation method to be standard accross all debian-based distributions.
Pre-existing method is available only on Ubuntu, locale-gen tool has no parameter in Debian.

(From yocto-docs rev: 30002019198a168e48537407bb928facb26af82a)

Signed-off-by: Guénaël Muller <guenael.muller@smile.fr>
Reviewed-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Tested-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-16 11:04:53 +00:00
Antonin Godard
4a90571c57 ref-manual: classes: fix bin_package description
The previous bin_package description was confusing: it would instruct to
use the git fetcher to extract the content of an RPM package using the
`subpath` option - but that's not possible as the git fetcher can be
used to clone a repository but not to do the extraction.

Update the description by telling what it really does and what it
doesn't do, and by giving an HTTPS+RPM example.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 305f024bf99ba02b153eed0cebe3d36594868497)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-29 18:25:35 +00:00
Mikko Rapeli
3aa5c512a3 classes.rst variables.rst: add documentation for uki.bbclass
Documentation for the new class.

[YOCTO #15650]
https://bugzilla.yoctoproject.org/show_bug.cgi?id=15650

(From yocto-docs rev: fd46074dc7bba49ab49c706c408c92958e67cfa4)

Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-29 18:25:35 +00:00
Alexander Kanavin
9620944507 ref-manual: document ZSTD_COMPRESSION_LEVEL
(From yocto-docs rev: ca3cbe1bac3261fd01aeb1afdca98fbe283e9ac7)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-22 16:56:03 +00:00
Alexander Kanavin
b95959a56b ref-manual: merge two separate descriptions of RECIPE_UPGRADE_EXTRA_TASKS
The second description was added due to confusion over the variable rename in oe-core.

(From yocto-docs rev: b64fb34643343b364705df9c3bd64af91ed9d687)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-22 16:56:03 +00:00
Julien Stephan
78f25d9a9c dev-manual: add bblock documentation
bblock is a helper tool to lock/unlock tasks and recipes to specific
signatures. Add a documentation page for it.

(From yocto-docs rev: a082aa39840587d3af6c3f4a2c2747564ca37414)

Signed-off-by: Julien Stephan <jstephan@baylibre.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-07 10:12:24 +00:00
Julien Stephan
c69aaeef11 ref-manual: variables: add SIGGEN_LOCKEDSIGS* variables
Variables SIGGEN_LOCKEDSIGS, SIGGEN_LOCKEDSIGS_TASKSIG_CHECK and
SIGGEN_LOCKEDSIGS_TYPES are used to lock specific tasks to specific
signatures. They are used by bitbake -S <lockedsigs> and bblock, so add
documentation for them.

(From yocto-docs rev: 32e3995bed2836f549866ec3b8ad254bdda37dbf)

Signed-off-by: Julien Stephan <jstephan@baylibre.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-07 10:12:24 +00:00
Antonin Godard
f16dc3705a ref-manual: devtool-reference: document missing commands
Give a brief description for important commands that made it into
devtool or that were missing from this quick reference document.

(From yocto-docs rev: 6238adae1b072c9e09c558038d397dfac6ec109f)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-31 14:24:24 +00:00
Antonin Godard
67cc5cf968 ref-manual: devtool-reference: refresh example outputs
Previous outputs were missing some commands and options, some others
were obsolete.

(From yocto-docs rev: 1c83037707b4c981a70c968ba04ded502f9bffbf)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-31 14:24:24 +00:00
Antonin Godard
af7a8d3dc3 ref-manual: release-process: add a reference to the doc's release
When reading the stable releases section, we want to know for which
release the documentation was built. Use &DISTRO_NAME; to refer to the
current release.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 05ee6844d710beb844bbdac892888879847f6d22)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-31 14:24:24 +00:00
Antonin Godard
56ed60e50f ref-manual: release-process: update releases.svg with month after "Current"
This way we put a timestamp on the image, so that someone looking at the
image on an old release tarball has a representation of the release "as
of <date>".

Here set "Oct. 24" as it was the last time the file was updated.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 7b62bbec900bc84a31e4686839e774ba7bd5ae9f)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-31 14:24:24 +00:00