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>
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>
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>
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>
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>
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>
- 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>
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>
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>
The description of the relation between KBUILD_DEFCONFIG and
SRC_URI is reversed. In fact it is the SRC_URI provided
defconfig which will be dropped by the kernel-yocto class
if both are provided.
(From yocto-docs rev: a808420655a0976ba08f013f468cf80f379b1d89)
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>
In OE-core commits:
* b5f8c3e029 (selftest: runqemu: add tests for booting zst compressed image, 2025-07-31)
* e069fe2480 (runqemu: Add support for running compressed .zst rootfs images, 2025-07-31)
runqemu gained the ability to run compressed image (+associated test).
Add this information to the release-notes for 5.3.
(From yocto-docs rev: f268c1b649227d533d02e1a6df797b784fcf80de)
Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There's no need to differentiate crediting contributors from committing
your changes, so let's simply make it the last step of "Commit your
changes" section.
This simply indents the text so it's now part of "Commit your changes"
list instead of the main list in the "Implement and commit changes"
section. Because of this reorganisation, the instruction to use "git
commit --amend" to add the contributors is moved to a note, and the
first few sentences are reworded to better match the wording of other
items in the "Commit your changes" list of instructions.
(From yocto-docs rev: eff4d14e28d323ebfdaeb0c5c805b5f1e2ad153d)
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>
... so that it's clear that you need to read and follow each and every
instruction in this list.
(From yocto-docs rev: c628a489f081925fabaabb5acac6752251150269)
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>
This should hopefully make it clearer what is expected from the
contributor.
This follows my understanding of git-commit(1)[1] where the following is
a git commit message:
"""
git commit title
git commit description
"""
I'm putting the "Fixes [YOCTO" line in "body of the commit message" so
it's understood as being different from the git commit description so
that the note admonition allowing us to have an empty commit description
doesn't apply to the "Fixes [YOCTO" line.
[1] https://www.man7.org/linux/man-pages/man1/git-commit.1.html#DISCUSSION
(From yocto-docs rev: b84903a760350bd118c56ea9ce4e98039edf6e55)
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>
The other tag descriptions have the double colon outside of the
highlight, and start the sentence with a lowercase word, so let's align
the CC tag with those.
(From yocto-docs rev: f116e93fb335e9d0f85891c4cb501bcf55b18ccf)
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>
The example could be understood as the content of the commit message
once the editor (git config core.editor) opens, where the first
line is the actual commit title and not the commit description.
This example would make the Fixes line the commit title, which is not
what we want.
In short, according to my understanding of git-commit(1):
The following is a git commit message:
"""
git commit title
git commit description
"""
Reported-by: Barne Carstensen <barne.carstensen@danfoss.com>
(From yocto-docs rev: a5862406bf3230befe9db9f2539bbbc86c02015d)
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>
I don't know what was the initial intent but this doesn't seem right, so
let's remove the bold formatting.
Fixes: 4abe87cb20d3 ("contributor-guide: submit-changes: detail commit and patch creation")
Cc: Michael Opdenacker <michael.opdenacker@rootcommit.com>
(From yocto-docs rev: 6c499b3796a578a0fe4c319c9547b4321b0d41df)
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>
Extend the description of PERSISTENT_DIR to mention that it should not
be shared between builds. Add a note on sharing the hash equivalence
database by setting up a server and not sharing the file in this
directory.
[YOCTO #15727]
(From yocto-docs rev: 0ff0233770b77f9e74f4241dfb555dac2741d8b9)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It is the libsoup-2.4 recipe that has been removed, not libsoup.
Also add that it has been moved to meta-oe.
(From yocto-docs rev: ac2896c89df7e5dfa91b18a5e1681019f17182d3)
Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This has changed since commit ed4238487c81 ("testexport: Fix to work as
an image class") in OE-Core.
[Antonin Godard: mention oecore commit in commit body]
(From yocto-docs rev: 2caa8e581feaf3640bea68108f9a02583b17b21b)
Signed-off-by: Barne Carstensen <barne.carstensen@danfoss.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a migration note on the pni-names default policy change after commit
9b34a810496f ("systemd: stop enabling non-standard "mac" policy when
using the 'pni-names' DISTRO_FEATURE") in OE-Core.
Cc: Koen Kooi <koen.kooi@oss.qualcomm.com>
Cc: Ross Burton <Ross.Burton@arm.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 237f28de0bf8d1e1be60a0d9429b3a98740778e9)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After commit 47533f20a7ec ("wic: rename wks flag --extra-space to
--extra-filesystem-space") in openembedded-core, document the
renaming of the Wic-specific option extra-space to
extra-filesystem-space.
CC: Alexander Kanavin <alex.kanavin@gmail.com>
(From yocto-docs rev: d3a34e8dca3c774234d3c6f4e575858869a7460d)
Signed-off-by: Pierre-Loup GOSSE <pierre-loup.gosse@smile.fr>
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>
After commits 47533f20a7ec ("wic: rename wks flag --extra-space to
--extra-filesystem-space") and c7f51c23fd268 ("wic: add
--extra-partition-space option to set unused space") in openembedded-core,
document the new Wic-specific option extra-partition-space and rename
the extra-space option to extra-filesystem-space.
CC: Alexander Kanavin <alex.kanavin@gmail.com>
(From yocto-docs rev: cba5dbb32a24c9e20e5a6066ec382cf7ff9b93e2)
Signed-off-by: Pierre-Loup GOSSE <pierre-loup.gosse@smile.fr>
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>
There's a (second) overhead factor applied in images generated with Wic,
and this is already documented in the .wks reference. However, the
IMAGE_OVERHEAD_FACTOR entry does not mention it, and by looking at the
partition sizes (e.g. with parted) one may find it confusing that they
don't match with the expected rootfs size (e.g. in a scenario where the
extra space is "0" and IMAGE_OVERHEAD_FACTOR="1.0").
This second overhead is already documented, though:
https://docs.yoctoproject.org/ref-manual/kickstart.html#command-part-or-partition
Mention the '--overhead-factor' option in the glossary entry and add a
reference to the wks documentation.
(From yocto-docs rev: b9040e20b015e9b02683ec3014e4ade5eb59d41a)
Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.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>
The filename is outdated as its version was already bumped and there are
also different files for different feed choices.
Use glob to match any available file.
Also the directory changed to CVE_CHECK2 meanwhile, so Update it, too.
(From yocto-docs rev: a2f18cb23183401d9d8e2fd4499d164ef8d86e44)
Signed-off-by: Peter Marko <peter.marko@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update mailing lists following changes by Michael Halstead
(https://lists.yoctoproject.org/g/yocto-security/message/1478).
Also fix formatting/spacing.
(From yocto-docs rev: 8066aa92a1acae6c99fbee92d24ee1feea65d974)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After commit c9585bb8689b ("Revert "qemux86-64: Reduce tuning to
core2-64"") in OE-Core, document the QEMU x86 micro-architecture level
bump in the release notes for 5.3.
Co-authored-by: Alexander Kanavin <alex.kanavin@gmail.com>
(From yocto-docs rev: 22c0fc1943c23d6f927034afdfa25ce64c5ba79a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Increase the minimum size requirement to 140G, after running a build
with distro Poky. The size after rm_work has increase of only 1G, so
leave the current value for MIN_DISK_SPACE_RM_WORK.
Also, update the comment to mention that this is for distro Poky. It was
mentioned in commit message 285ba689ce3a ("manuals: update disk space
requirements"), but not in the comment here.
(From yocto-docs rev: dbc6137cd13f982a7fd4d1b2df79dccb177db0fc)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
documentation/scripts/check-glossaries returns:
WARNING: ref-manual/variables.rst: The variable EFI_PROVIDER shouldn't be in the glossary.
WARNING: ref-manual/variables.rst: The variable ZSTD_THREADS shouldn't be in the glossary.
(From yocto-docs rev: 4d3952414d109f9c9ebb029f3e20018664eacc86)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The checks rule can be run to perform some checks on the docs.
For now it only includes running the check-glossaries script.
This rule should only run basic checks or should not prevent the user
from building the docs in case of failure.
This rule can be used in the future to run additional checks on the
documentation.
(From yocto-docs rev: 1d9a4a52fa9f2e2eb7f282324f85a46b28128fbf)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Instead of tracking the glossary manually, add a small script that
checks if it is properly sorted.
Add two comments between the start and end of the glossary for the
script to know where it's located.
The script also checks if the variables are properly sorted. It uses
difflib and returns the diff if there's a difference between the
unsorted and sorted list.
Messages beginning with "WARNING:" are reported by the Autobuilder,
which is the reason for this format.
(From yocto-docs rev: 416d50c0c322eb88bf13353a198db7211e4d665a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the release notes and migration manual for 5.3.
This covers commits from c4a5e590b5 ("rust-llvm: Compile llvm to use
dynamic libraries") to 2a832e6af1 ("orc: set CVE_PRODUCT") in Poky.
(From yocto-docs rev: c8d852ad63219d067e497a77d489a4011b0d0a26)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since commit 24772dd2ae6c ("parse/ConfHandler: Add warning for
deprecated whitespace usage") in BitBake, a warning is printed when
there are no spaces around an `=` assignment.
Adjust the documentation to show good examples only.
(From yocto-docs rev: 77ce1544dd793036b1135817c02e090138fe6407)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After commit 24772dd2ae6c ("parse/ConfHandler: Add warning for
deprecated whitespace usage") in BitBake, a warning is printed is
there's a missing space around an equal assignment in recipes.
Add a qa-check entry to qa-checks.rst.
(From yocto-docs rev: da2e9d45a4c70c5d78d225277a85cc4173e4ee7a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
