Commit Graph

7010 Commits

Author SHA1 Message Date
Antonin Godard
f4c37762b9 ref-manual/fragments.rst: document core/yocto/root-login-with-empty-password fragment
Added by commit e135458415de ("fragments: add a
'root-login-with-empty-password' fragment") in OE-Core.

(From yocto-docs rev: 072ac843992189f836f72f4be8d873cc8657a918)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-11-07 13:15:33 +00:00
Antonin Godard
eda8043243 brief-yoctoprojectqs: delete unused figures
These images are not used anywhere in the docs. Remove them.

(From yocto-docs rev: a0edada1eb056f726c0e28022ec733cb33f3e1a1)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-11-07 13:15:33 +00:00
Antonin Godard
cc9693d76f ref-manual/structure.rst: document the site.conf file
This was not documented and its usage is going to increase massively
once users start using bitbake-setup. Add a description for this file as
well as an example on how bitbake-setup shares it for multiple builds,
to insist on the "site-wide" usage of this file.

(From yocto-docs rev: 42f68f7de7f0cf74ebdd31fae3173dd3a80386ff)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-11-07 13:15:33 +00:00
Antonin Godard
4a433280ab ref-manual/structure.rst: update the description of local.conf and bblayers.conf
The local.conf file is now mostly empty with the default way of setting
up the environment (with bitbake-setup), and this file is meant to hold
local user configurations, rather than an extensive list of variables.
Adjust the description to reflect the intended way of using this
configuration file.

Also, for both local.conf and bblayers.conf, rephrase the current
usage of the template files (.sample files) to _not_ imply that it is
the default way the OpenEmbedded build system sets things up.

(From yocto-docs rev: 24f24d07fd688825b2ec39dcf0daf8203577f87a)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-11-07 13:15:33 +00:00
Antonin Godard
0f5246cec9 migration-guides/release-notes-5.3: updates
Update the release notes and migration manual for 5.3.

This covers commits from bd4625cd4d ("build-appliance-image: Update to
master head revision") to 4a1f38dd8d ("bitbake: knotty, uihelper:
Remove running_pids and lastpids") in Poky.

Acked-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 5cb37206ca0dfaa0dafabb28ebd546b591c88486)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
ea1481aa48 ref-manual: document UBOOT_MAKE_OPTS
This variable was added by commit 3338330e0c46 ("u-boot: Add specifying
make options as part the config looping") in OE-Core. Document how to
use the option in UBOOT_CONFIG.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
57a885f242 ref-manual/classes.rst: document the relative_symlinks class
Added by commit e478550c8cd8 ("openssl/fontconfig/bzip2: Use relative
symlinks instead of absolute ones (using a new class)") in OE-Core.

(From yocto-docs rev: c0dc554eba7d421023ecc68a70b7a19df38628b0)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
39d29350f7 ref-manual/features.rst: add entry for the coresight machine feature
Added by commit c455bd039104 ("perf: enable coresight if enabled in
MACHINE_FEATURES") in OE-Core.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
6b4be8e413 ref-manual/classes.rst: document the rust-target-config class
Document the rust-target-config class.

(From yocto-docs rev: a9dc48f4bbfb9abfdffc7f0caa8285f7c72cc2d9)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
139f32a902 ref-manual/classes.rst: gettext: extend the documentation of the class
Mention the use of USE_NLS, INHIBIT_DEFAULT_DEPS and the cross-canadian
class.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
25b67dad1e ref-manual/variables.rst: document the USE_NLS variable
Part of bitbake.conf, this variable allowing to enable or disable
translation was undocumented. Add a entry to the glossary.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
741f3a7c02 ref-manual/variables.rst: document the REQUIRED_IMAGE_FEATURES variable
Added by commit 96a9702a24a7 ("distro_features_check: expand with
IMAGE_FEATURES") in OE-Core.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
d27f4131ba ref-manual/variables.rst: document the REQUIRED_COMBINED_FEATURES variable
Added in OE-Core commit: 5f4875b950ce ("distro_features_check: expand
with MACHINE_FEATURES and COMBINED_FEATURES, rename").

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
a16e6aefb4 ref-manual/variables.rst: document the REQUIRED_MACHINE_FEATURES variable
Added in OE-Core commit: 5f4875b950ce ("distro_features_check: expand
with MACHINE_FEATURES and COMBINED_FEATURES, rename").

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
0412f9a105 ref-manual/variables.rst: document the REQUIRED_TUNE_FEATURES variable
Very similar to REQUIRED_DISTRO_FEATURES, added by commit a8ef7339ecb9
("features_check.bbclass: Add support for required TUNE_FEATURES") in
OE-Core.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
c5ce2c1e13 ref-manual/classes,variables: document the CCACHE_DISABLE variable
Can be used in recipes that want to explicitly skip Ccache support when
the ccache class is enabled.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
1dd4a9ed98 ref-manual/classes.rst: ccache: mention that the host's ccache can be used
This feature was added by commit cc91a0f6500e ("ccache: enable ccache
for all recipes if it is in HOSTTOOLS") in OE-Core.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
7eebd8b425 ref-manual/classes.rst: document the python_pdm class
This class was added by commit 20758865e9e0 ("classes/python_pdm: add
PEP517 build class for PDM") in OE-Core.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
ae40c7ada3 ref-manual/features.rst: add new opencl feature
Added by commit 3061d6061e74 ("mesa: add opencl DISTRO_FEATURE") in
OE-Core.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Antonin Godard
76d4f613b0 ref-manual/qa-checks.rst: drop var-undefined
Drop the var-undefined after it was dropped in OE-Core cb69d7eba802
("package: Drop var-undefined QA check").

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Robert P. J. Day
8fced91c40 overview-manual/yp-intro.rst: update on-target packaging info
- drop references to obsolete tar packaging format
  - add references to apt and dpkg utilities for .deb packaging
  - add reference to alternative "dnf" .rpm packaging

(From yocto-docs rev: c0737f253a89cc1f5fa23f24710705929bd75b79)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:34 +00:00
Robert P. J. Day
eae21b0367 dev-manual/start.rst: fix typo "RELEASE" -> "RELEASES"
In addition, some minor grammatical tweaking.

(From yocto-docs rev: 9e9bd1bec2d1ef96ff416bbf94e3821056436073)

Signed-off-by: Robert P. J. Day <robday@acresecurity.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:33 +00:00
Pierre-Loup GOSSE
39b37aa6a1 migration-guides/release-notes-5.3.rst: new wic extra_partition plugin
Added by commit 3892912bd7e0 ("wic: extra partition plugin") in OE-Core.

(From yocto-docs rev: 6a9b26ed0316156975c7ef9209e73ae9d8f7ac03)

Signed-off-by: Pierre-Loup GOSSE <pierre-loup.gosse@smile.fr>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:33 +00:00
Pierre-Loup GOSSE
78026640e6 ref-manual/variables.rst: document IMAGE_EXTRA_PARTITION_FILES
Added by commit 3892912bd7e0 ("wic: extra partition plugin") in OE-Core.

[AG: formatting tweaks]

(From yocto-docs rev: 3d2aaec8218a7cad5653face152e9cd45257aefe)

Signed-off-by: Pierre-Loup GOSSE <pierre-loup.gosse@smile.fr>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:33 +00:00
João Marcos Costa
ecea1027d3 variables.rst: fix LAYERDEPENDS description
This variable does not apply to the scope of a single recipe, but rather
to the scope of the entire layer.

(From yocto-docs rev: eec26e11adb6e3a9c4f53f825b9a1730c9ddee12)

Signed-off-by: João Marcos Costa <joaomarcos.costa@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:33 +00:00
Paul Barker
56d47e9672 dev-manual, test-manual: Update autobuilder output links
The current autobuilder cluster is at valkyrie.yocto.io, published files
on autobuilder.yocto.io will be missing or out-of-date.

(From yocto-docs rev: 9ed06c070e309b52f1dbf8877867dcede79f4cb6)

Signed-off-by: Paul Barker <paul@pbarker.dev>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:33 +00:00
Antonin Godard
fafcdd9bb9 ref-manual/classes.rst: uboot-config: improve documentation
Improve the documentation of the uboot-config class. It was not
explaining any of its entry in UBOOT_CONFIG. Mention that using
UBOOT_CONFIG and UBOOT_MACHINE at the same time is not possible.

(From yocto-docs rev: 3bbd85798f4c9a8b7f930e9f156cf6e970593da0)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:33 +00:00
Antonin Godard
4557ff9cfd ref-manual/variables.rst: fix a typo in UNPACKDIR description
(From yocto-docs rev: abcb3b7aa449e2cdab9bda1a96b5c63c4e376759)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:33 +00:00
Lee Chee Yang
697a1a8458 migration-guides: add release notes for 5.2.4
(From yocto-docs rev: 7c9fd5339549b033812957d636752a674fef5cdc)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:33 +00:00
Antonin Godard
19d7fd3851 ref-manual/classes.rst: extend the uninative class documentation
Extend the documentation of the uninative class based on [1].

[1]: https://lore.kernel.org/r/061e6150ce177221f7b6ee8754b03a20347a92c3.camel@linuxfoundation.org

Co-developed-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 68996f0f3bf882714e8d96a0aa7b2492fe16d0c3)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:33 +00:00
Antonin Godard
3ad4d5de19 ref-manual/variables.rst: document UNINATIVE_URL/CHECKSUM
Document the UNINATIVE_URL and UNINATIVE_CHECKSUM variables.

(From yocto-docs rev: 974fe4e1c5db65b462a382e089e016326e7b3f26)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-29 23:16:33 +00:00
Gyorgy Sarvari
557a3150a1 ref-manual/variables.rst: add note about PSEUDO ignore/include precedence
This commit[1] in pseudo introduced the PSEUDO_INCLUDE_PATHS variable, however
the previous PSEUDO_IGNORE_PATHS variable is still present also. Add a clarifying
note about the order of precedence of the two.

[1]: https://git.yoctoproject.org/pseudo/commit/?id=2c43381180f9cfef4c0a8bb0c1658a86c3fcc876

(From yocto-docs rev: 8b85245490ae0b19a9c3880ec31e55b42e19d094)

Signed-off-by: Gyorgy Sarvari <skandigraun@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-14 11:36:58 +01:00
Antonin Godard
4735aa8fd6 tools/build-docs-container: use the basename of OCI to append args
What we have is OCI = $(which $CONTAINERCMD) = /usr/bin/{docker,podman}.
So we never pass the current if conditions. Compare against the basename
of OCI to pass the checks.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-14 11:36:58 +01:00
Antonin Godard
5e0e1c586d ref-manual/fragments.rst: remove duplicated built-in fragment note
This behavior was removed in commit aea2d69d0533
("lib/bbconfigbuild/configfragments: disable the previous builtin
fragment when enabling a new one") in OE-Core.

(From yocto-docs rev: e420f0f90614b13fc92654219296182858ca17b9)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-14 11:36:58 +01:00
Antonin Godard
3aa2914a08 ref-manual/qa-checks.rst: fix references
The references in this document do not work because references need to
be associated to a title. Change the bullet list into a section
separated document. This way we can cross-reference QA checks in other
parts of the documentation (it was previously failing when attempted).

The diff is a bit hard to digest, but there are no changes to content
except for:

- A fixed typo (inhert -> inherit)
- Indentation

(From yocto-docs rev: 93c30b8a430a981e8b89061c968a006a3e086353)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-14 11:36:58 +01:00
Antonin Godard
ae8b6bae17 tools/build-docs-container: remove obsolete comments
Leap 15.6 worked fine on my local builds, with Docker or Podman.
Ubuntu 23.04 got removed from the list of distros we test.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-14 11:36:58 +01:00
Antonin Godard
7b7aa8c4cc tools/build-docs-container: add option to install essential packages
The script currently only installs the files necessary to build the
docs. Since we also have the essential packages listed it can be useful
to include them in the containers, at least to validate that these
successfully install.

Add an env variable for including these packages in the container. The
default is to not include these, so the current behavior is unchanged.

(From yocto-docs rev: 723e531ea442df96fd592635a2fbfba73e737886)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-14 11:36:58 +01:00
Alexander Kanavin
51ae02fc0d ref-manual: correctly document the difference between auto.conf and newly added toolcfg.conf
[AG: Add reference to YP Autobuilder]

(From yocto-docs rev: f23b93594dbe7e5df9ec55371e4aab4b7b8c50b9)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-14 11:36:58 +01:00
Lee Chee Yang
5e956ddfc5 migration-guides: add release notes for 4.0.30
(From yocto-docs rev: e89c95b167c24cfb9c1d5d548a26872393ca2fee)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-14 11:36:58 +01:00
Antonin Godard
8b4438fe84 dev-manual/layers.rst: yocto-check-layer: update list of test
Update the lists of tests as found OE-Core as of commit 07747aa7390e
("piglit: rename virtual/opencl-icd to virtual/libopencl1").

Add a link to the test directory in case the list is update, users can
still browse through the code.

(From yocto-docs rev: c3783914d01d313a35e29e75e562eefba5e40df4)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-14 11:36:58 +01:00
Antonin Godard
d9bd693589 dev-manual/layers.rst: yocto-check-layer: mention --machines and --dependency
The yocto-check-layer script should be run with the --machines arguments
to test the different machines present in a BSP layer. Mention it in the
documentation. The --dependency can also be used so also mention that.

[YOCTO #15974]

Cc: Mark Hatle <mark.hatle@kernel.crashing.org>
(From yocto-docs rev: 2cd7b5c83978819179b8a47e213b9812b97d5720)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-14 11:36:58 +01:00
Antonin Godard
9ed0d68be2 tools/build-docs-container: update with newly supported distros
Update the build-docs-container file with newly supported distributions.
These were all able to install packages and build the docs (including
the pdf) properly.

(From yocto-docs rev: 09c7800333b17b21e50d2a089a3ae1b123697243)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-03 17:53:57 +01:00
Antonin Godard
3f90a5b12d set_versions.py: fix subprocess.run call for older distros
Like in 28850c974a38 ("set_versions.py: use backward-compatible python
argument in run"), replace the capture_output options by Python <3.7
compatible ones.

(From yocto-docs rev: 6e1f4c18a13f369423599529a6960da5e3947d01)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-03 17:53:57 +01:00
Adrian Freihofer
4c4c2e2bb2 docs: add util-linux-script package for Fedora 42+
Fedora 42 split the script utility from util-linux into a separate
util-linux-script package. This change adds conditional installation
of util-linux-script for Fedora 42 and later versions.
5a2471d6e5

The package is added conditionally using rpm macro evaluation to
maintain compatibility with older Fedora versions where script was
included in the base util-linux package.

Note that different distributions handle this differently - for example,
Debian provides the script utility in a separate bsdutils package
rather than in util-linux.

(From yocto-docs rev: 22e28e817d2c9b49d9fedbb93b08874cec1fa3d3)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-03 17:53:57 +01:00
Antonin Godard
0471fb8c52 ref-manual/system-requirements.rst: update supported distributions
After 837a650aac17 ("poky: Update SANITY_TESTED_DISTROS") in meta-yocto.

(From yocto-docs rev: 4e7ce89ff91f5fa7ade1feb7be96f898b56068ed)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-03 17:53:57 +01:00
Adam Blank
c059eea32f ref-manual/variables.rst: fix the description of STAGING_DIR
There is no single "recipe-sysroots" directory, but rather many
"recipe-sysroot*" directories.

(From yocto-docs rev: f2d6e228409cb1dd1dbf339c405699ac6d3900be)

Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-03 17:53:57 +01:00
Antonin Godard
e86a3d2236 Add documentation on fragments
- terms.rst: Provide the definitions of a Configuration Fragment and a
  Built-in Fragment.
- ref-manual: Add a quick reference guide on bitbake-config-build, and
  list the available fragments in OE-Core.
  Document the underlying variables related to fragments in the
  glossary.
- dev-manual: give instructions on how to create new custom fragments.

(From yocto-docs rev: 0820b71c830cab4151b0219b6d4013c41f461c6e)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-03 17:53:57 +01:00
Antonin Godard
bb64a9adcf ref-manual/structure: document the auto.conf file
Add documentation for auto.conf, which is used by external tools for
automatically setting variables.

(From yocto-docs rev: 134e54a75e0144c4629f702c6f43e92ed1f12dce)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-03 17:53:57 +01:00
Talel BELHAJ SALEM
48b7b4885e dev-manual/building.rst: add note about externalsrc variables absolute paths
(From yocto-docs rev: 33166d70b6ad093bd95ffccafc0b07820682f656)

Signed-off-by: Talel BELHAJ SALEM <bhstalel@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-10-03 17:53:57 +01:00
Quentin Schulz
41062c9287 tools: build-docs-container: remove comment for unsupported distros
Ubuntu 18.04 and 20.04 are not supported distros, so let's remove the
comment listing the reason we don't support them.

(From yocto-docs rev: 9ff31ed417bc7cd80f8bde39372091e40e36b678)

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-10-03 17:53:57 +01:00