Newer versions of Sphinx already define a :cve: role that points to
cve.org, instead of the role we defined in conf.py that points to
nvd.nist.gov.
Rename our role to :cve_nist: to avoid warnings (treated as errors).
This is also backwards compatible, meaning we can build the doc with an
older Sphinx if needed.
The file were automatically replaced with following command:
find . -name '*.rst' -exec sed -i 's/:cve:/:cve_nist:/g' {} \+
Suggested-By: Quentin Schulz <quentin.schulz@cherry.de>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 15fa3b7e85dde50d7236c1738ad607531cc654b8)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Public hashserver is now at hashserv.yoctoproject.org:8686
(From yocto-docs rev: 7b40c7b73a360a1ec383c4c9f00c3e126208320b)
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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>
Remove dunfell and nanbield which are not supported anymore.
Add styhead as an active release.
Set walnascar as the dev branch.
The switcher menu now contains:
- Unstable (dev)
- Styhead (5.1)
- Scarthgap (5.0.4)
- Kirkstone (4.0.22)
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 4c81e2856c268d7d0221ebb6b8156ad65b9e83ca)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Mention that Scarthgap the latest LTS in a bullet list next to
Kirkstone. Reword the parapraph a bit to make it clearer after this
change.
Reviewed-by: Michael Opdenacker <michael.opdenacker@rootcommit.com>
(From yocto-docs rev: afeded9939777d88bf4cb9ebf7a61aadd476642d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add Walnascar release.
* Remove dunfell, gatesgarth, hardknott, honister: these release are not
supported anymore. Start from kirkstone, which is still supported.
(From yocto-docs rev: aa9a580c8c57af4baa4fb24a43487fb7afc258e5)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add the suggestion by Richard to the FAQ, with some minor rewordings and
additional punctuations.
Suggested-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 2466a5e7973bf6e724f1cf0b42f838065847d283)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update variable name letter index so that each letter leads to first
variable name entry in the list. Also add letters Q and Z to index.
(From yocto-docs rev: 72bbff33fdce60c133074b4ac09721c4ddac5372)
Signed-off-by: Niko Mauno <niko.mauno@vaisala.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>
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 <quentin.schulz@cherry.de>
(From yocto-docs rev: 143c3cacdec36c9d7ab81c89bbcc12c0c3936bd9)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document `hosttools/`, `pkgdata/` and add some more information on
`work-shared/`.
Adresses [YOCTO #14543].
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 372b5b4ca55819c294970b20aa8b8d8167144329)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The VOLATILE_TMP_DIR variable was removed and it's functionality
replaced with a FILESYSTEM_PERMS_TABLES entry in
https://git.yoctoproject.org/poky/commit/?id=2f46b6f27dfa3a9d5ad177900fcecfe64c3536f1
("bitbake.conf: drop VOLATILE_TMP_DIR, use FILESYSTEM_PERMS_TABLES instead")
(From yocto-docs rev: 1ef0eabaa07cc39075a040b99a5c11567d745408)
Signed-off-by: Niko Mauno <niko.mauno@vaisala.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The VOLATILE_LOG_DIR variable was removed and it's functionality
replaced with a FILESYSTEM_PERMS_TABLES entry in
https://git.yoctoproject.org/poky/commit/?id=2f8806deb7655b37d6f8d12ff54680d6acf7a298
("bitbake.conf: drop VOLATILE_LOG_DIR, use FILESYSTEM_PERMS_TABLES instead")
(From yocto-docs rev: b1c22561878ba618eb69e4c8784ea346b989a0ea)
Signed-off-by: Niko Mauno <niko.mauno@vaisala.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It should be before "perllocalpod" and after "patch-status".
Reported-by: Quentin Schulz <quentin.schulz@cherry.de>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 1304b899cd4480f80eaeb6e58d57e87d3d2f6911)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Finalize the release note for the 5.1 release (styhead).
Add enhancements, changes, removals, license changes, and migration
notes for this release by going over the git commit log of
openembedded-core, bitbake and meta-yocto.
(From yocto-docs rev: 65618b0588053d2c4325d995482957b660f5e104)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
update for these changes:
- license
- recipe enable for ptests
- new class, recipe and variable.
- PACKAGECONFIG
- some utility script, class and include file.
- bitbake.
- qemu/runqemu.
- Contributors.
removed wic as no significant change or improvement.
Antonin Godard: amend and fix some typos.
(From yocto-docs rev: afbcc16cd5244d8bb6bb79796aa064156f99e3d3)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New sanity check to check for PEP517-backend compliance.
(From yocto-docs rev: 24e5bbeefe989e22ecdf5e86f48432e437330cc2)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These are not distinct anymore and check for any patches in any layer.
(From yocto-docs rev: 300c585909743754e0e6662d48d43834c031b835)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
No longer required as TMPDIR can be shared for multiple lib providers
nowadays.
(From yocto-docs rev: 6690c0aee9e7f0dcc63ccbe19657b78963240610)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable can be used to specify one or more compiled device tree or
device tree overlays to use in addition to the one compiled by the
kernel.
(From yocto-docs rev: 6566ffceab3780dc5ecbfe26f786ebe6ff17e693)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variables that control the output of the image task manifests.
(From yocto-docs rev: e46af38733ae581c4aa180efc226d8a34ea4e590)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable lists space-separated paths on the target to retrieve onto
the host, when inheriting testimage.
(From yocto-docs rev: 2537642d2cdf844dc5f6027fb3097aac52162c1f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed as it was only used by ncurses and zlib and adding minimal
added-value for a considerable amount of added runtime.
(From yocto-docs rev: c35688a0f4cb115c63387cc15fd15ec57cb386fb)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document the new `retain` class with its configuration variables in the
variable index.
(From yocto-docs rev: b62f1be5dada0fb760ff7e0806b16225f7261560)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a brief description on the new vex.bbclass that is used to generate
metadata needed by external tools to check for vulnerabilities.
(From yocto-docs rev: 32cf3414f5ed127f59119e38639bc8dbd57b7891)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Variables that can be used for toggling creation of manifest and
specifying the path to the output in the deploy directory.
(From yocto-docs rev: 14131a42a7ea8bbae2165c1b8dbcabd5f28b2b22)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
1. Changed one letter (s/B/A), so the sentence is correct again.
2. Moved example from SYSROOT_DIRS_IGNORE into SYSROOT_DIRS section.
(From yocto-docs rev: 7d762fbad07bf16a0a657169c09a3e402dabbe90)
Signed-off-by: Matthias Pritschet <matthias@pritschet.eu>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
python2.py referenced does not exist. Change the reference to the
existing python.py oeqa file.
(From yocto-docs rev: 48f8eaf956e6897d714a9f628295bf0a320b3547)
Signed-off-by: Jon Mason <jdmason@kudzu.us>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document the new RECIPE_UPDATE_EXTRA_TASKS variable
and give cargo-update-recipe-crates as a concrete
example.
(From yocto-docs rev: 9cc4e395571dcef58d9d8545c08d9fdf8070bb32)
Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Refer to package requirements for building documentation
from supported distributions. The simple instructions
previously listed no longer work on Ubuntu 24.04, for example.
(From yocto-docs rev: c474f211a9a9ab9399627558b801d7546ebcd52b)
Signed-off-by: Michael Opdenacker <michael@opdenacker.org>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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 <jasper@fancydomain.eu>
Reviewed-by: Michael Opdenacker <michael@opdenacker.org>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
>From discussion [0], the presence of git version signature at the end of
patches has been questionned. To avoid a bit more noise, the setting git
format.signature is added to the documentation and its use is
recommended.
[0]: https://lists.openembedded.org/g/openembedded-core/topic/106323318#msg199967
(From yocto-docs rev: 7da39b91a0f20cb7215d51e00c098f3dc13180fd)
Signed-off-by: Alexandre Truong <alexandre.truong@smile.fr>
Reviewed-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Michael Opdenacker <michael@opdenacker.org>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
add release notes for 5.0.1
(From yocto-docs rev: 9ca8ae1aae8d98ca2c9d2e67b3e07b49de9c20f6)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Andrew Murray <amurray@thegoodpenguin.co.uk>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Note that this doesn't touch the "Source Fetching" section
in overview-manual/concepts.rst yet, as the unpack implementation
may not be finalized yet.
(From yocto-docs rev: 2c892663c3e2d72493ee29898e99335a1e45c01f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Andrew Murray <amurray@thegoodpenguin.co.uk>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These are variables that some Python recipes are starting to use, but
there is no documentation for them currently in the reference manual.
(From yocto-docs rev: 78cde86cc31f238b8b31569ac9df2eeb15ef5e33)
Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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 <ngalea@thegoodpenguin.co.uk>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Andrew Murray <amurray@thegoodpenguin.co.uk>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Align with finalized text-based release notes.
(From yocto-docs rev: 0ee5078d1f042d3dc57e7b3b15174398c574b8a5)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
We now check that the websockets module version is at least 9.1 in
bitbake itself so we can specify more precisely what "recent version"
means.
While at it, list which distributions have a recent enough websockets
python module in their package feed and give some hint at how to support
other distributions.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 9a14157c4d723da0970cfd4bbb2c9500d3e692e0)
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Make Scarthgap a current release
- Add Styhead
(From yocto-docs rev: 4ff729c58d462cf8513e6339a5518e1c5b56f54a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: de7f379b3950c0d345a798fff417e0004c0dbc27)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
add release notes for 4.0.18 (rc1).
(From yocto-docs rev: 88ba51a40a2672288096d0de784c4dd51a99d7d3)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
They used to be required for qemu graphics support, but neither is being
for anything anymore.
(From yocto-docs rev: 96e96382cecb4928f49d37bf870335fa6aeb4dd1)
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Also add a note about needing python websockets installed.
(From yocto-docs rev: 9c7869b95b1784f58f0a31f7c015ad3e15af34e1)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Prepared for Scarthgap release. Add references to Styhead.
(From yocto-docs rev: 906d228f1cedc25dd7530db3ce509239152da89f)
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
update recipes changes in 5.0 rc4.
update new recipes, license changes, patched cve and recipes version
changes.
(From yocto-docs rev: 0fc86205668d122d4e550a5eae301cd6997f8a71)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Set a new standard to introduce project names with single quotes,
so that they appear in generated text with an italic font,
to make them easier to distinguish from command names and from
ordinary English words.
Rework and move the standard for command and file names
to make the whole description "flow" better.
(From yocto-docs rev: fa6700af56213a5079eaa8d9683f3c2b2fc93740)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable in 5.0.
(From yocto-docs rev: 57a9117a8c4c020b2f643d6835af29b4e49f4f7f)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add additional features and tweak some existing entries.
Also add one known issue for gpgme.
(From yocto-docs rev: 0cdc0afd3332459d30cfc8f4c2e62bdcc23f5ed5)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a few missing entries based upon combing through the release
commits, as well as minor tweaks to existing items.
(From yocto-docs rev: 0680ee719edaa31a52f9cb7bd5138b402b1b26ce)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add CVEs from commits
* Add recipe upgrades using layer index branch comparison
* Add contributors from commits
(From yocto-docs rev: 4cf6b62939c226fb9c49b7d61f3d95075a9cd8bd)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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 <paul.eggleton@microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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 <paul.eggleton@microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable in 5.0.
(From yocto-docs rev: 047780931ec8156d77ec10f3f051bd98b83714f8)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document the change in behaviour in 5.0.
(From yocto-docs rev: f7a223d4e78bee67107fa47e147208f57a2d9521)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add brief documentation of python_maturin and python_mesonpy classes
that were added in 5.0.
(From yocto-docs rev: ce7dd61a928dec778a5df538701dfdeb26db0ebd)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add the new virtual-slash QA check to the insane class section and the
QA checks section.
(From yocto-docs rev: fdca0217558185eca67f7ec04b9d282b7819d107)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add remove-libtool and create-spdx to INHERIT_DISTRO defaults per
meta/conf/distro/defaultsetup.conf
(From yocto-docs rev: a5193a97d774dd6aad09fc756fcd362638d7d2fe)
Signed-off-by: Geoff Parker <geoffrey.parker@arthrex.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 4b839c460867d685584134dbd322cd9b20f2ae6d)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Mention the new section about variable context in the BitBake manual.
(From yocto-docs rev: a8b81d8a7974207e2a9fe63da4a0c239132818ed)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Simone Weiß <simone.p.weiss@posteo.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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 <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Mention this new class in QEMU section.
(From yocto-docs rev: ddd0e0817a12ebbd3d33d20e20d2407ac1e63b71)
Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This patch should cover those commits (from poky) :
* 789b10030c (cve-update-nvd2-native: remove rejected cve from database, 2024-03-15)
* 19f27037b2 (cve-update-nvd2-native: add an age threshold for incremental update, 2024-03-13)
* 6ce61b4357 (strace: disable bluetooth support by default, 2023-12-13)
* 381ef628fa (ref-manual: add documentation for the unimplemented-ptest qa warning, 2023-10-10)
(From yocto-docs rev: da44182aa084378dbf7a04bb010cbd87e508a607)
Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
To make it more obvious which directories are needed, pass only these to
*mkdir* and use the option `-p` to create the missing parents.
(From yocto-docs rev: 92806d2ab1f909eef9ccc532958a7ced6262b9b0)
Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As reported by "make sphinx-lint"
(From yocto-docs rev: 7e8d8d6d47da61457798e90b1d53f3082fe76668)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As reported by "make sphinx-lint"
(From yocto-docs rev: 1601bf2d294c3a8e7c4c654539c8a4da3ed054d0)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Makes it possible to catch errors not reported by sphinx,
such as idle spaces. After customization, this should be used
to enforce our syntax conventions, such as two spaces after a "-"
character to introduce a list item.
Just run "make sphinx-lint".
(From yocto-docs rev: 9e1aeeddca06cb7d65631010ba0eebdcd8ecf9ee)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
List systemd changes
Add PACKAGECONFIG-related changes, as well as systemd-boot-native, to
'Miscellaneous changes section'.
Mention the licensing changes in systemd and libsystemd.
Add changes to wic
Summarize changes in 'wic Image Creator enhancements' item.
Add Go language upgrade
There were multiple bumps between Scarthgap and Nanbield, but overall
the version was upgraded from 1.20.10 (in Nanbield) to 1.22.1 (in Scarthgap).
Mention the new class 'go-vendor' in 'Miscellaneous changes'.
Add create_go.py to script changes
Mention this new script, at recipetool, in 'Utility script changes'.
(From yocto-docs rev: 3e24a1cf2f2089beedad11b91fc11b8b402caf87)
Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
List removed recipes
Fill the 'Removed recipes' section for the upcoming release 5.0
Leave some sections empty
Only mention that no classes were removed and no variables were removed in the
upcoming release 5.0.
List systemd changes
Mention the nss-resolve related changes.
Add Go language changes
List removed variables
Fill the 'Removed variables' section for the upcoming release 5.0
Add QEMU changes
Add Miscellaneous changes
(From yocto-docs rev: cbc0b6fa333984c0c49f3c94daffd496815b5d68)
Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A reference to this class in the release notes will be added in a
follow-up commit.
(From yocto-docs rev: bfd38ad1056ded01a25acfa37e89302df2290ddf)
Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 26a94025d4ce445495e83565b4d53bda5b7aeef6)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There's a new yocto-patches mailing list available for all layers that
do not have their own mailing list.
c.f. https://lists.yoctoproject.org/g/yocto/topic/105197684
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: ac512f76b93a20507a6835ddafa954b4ae45e268)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
reorder CVEs from alphabetical order to numerical order, align it
with text based release notes.
(From yocto-docs rev: da670cfe7c22ece8925cb620f52832cc1c34e736)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Try to particularly emphasize that it can be used to find
out why something rebuilds when it shouldn't.
(From yocto-docs rev: cfaf2707b4a77888316d5eb24bf41ccc21e2c12b)
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
They were separated in
https://git.yoctoproject.org/poky/commit/?id=63e53fb8b60d38315015844bd3357fa1649cd639
(From yocto-docs rev: b880ac9498764027de435103d493f34adf68dc13)
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The documentation of the variable SPDX_NAMESPACE_PREFIX does not exist.
This variable is used to change the prefix of some links in SPDX docs.
(From yocto-docs rev: 85c56d8f7f65875628ab63abf661705b26f55224)
Signed-off-by: BELOUARGA Mohamed <m.belouarga@technologyandstrategy.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
According to errors reported by "make stylecheck"
(From yocto-docs rev: fc808b2dca4321209bfa6206d9e43aa1a5a0c5b8)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Use the "Vale" (https://vale.sh) tool to perform text style checks
Run "make stylecheck" to run the checks.
This just checks the text, not the Sphinx syntax style choices.
(From yocto-docs rev: 51b1f9a4d5aa02d337b105633de38e18b923a13a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* this is often confused to apply for e.g. meta-oe as well
where it doesn't apply as meta-oe has own ML mentioned
in README.
(From yocto-docs rev: 63be0814a7ecf38c570b6d776f62b7c7803eb299)
Signed-off-by: Martin Jansa <martin.jansa@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 224de9dfb6238677ecff715e1d57376487b6517f)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
releases.rst is generated by the set_versions.py script
(From yocto-docs rev: 4b7773f59bab2d653d07b7e06cd21745b646b604)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Allowing to remove nested parentheses in the text!
(From yocto-docs rev: 7cfa49fe17a8a20a8d4671c0daf1820c3cd69952)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Instead of "manpage(s)" or "man page(s)".
To address one of the errors reported by "make stylecheck"
(From yocto-docs rev: 86f5f5cd385f09c48c4cf0b1ab222d6e1e7c7e54)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Plus a few text styling improvements, some reported by "make stylecheck"
(From yocto-docs rev: c29a1bf4dd5223e4af9c1be5a8a8ea6a88bb7a58)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Use the "Vale" (https://vale.sh) tool to perform text style checks
Run "make stylecheck" to run the checks.
This just checks the text, not the Sphinx syntax style choices.
(From yocto-docs rev: d145e1dc45dc0792c8b8f7e73500b56face1e710)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Cite usage of IMGCLASSES variable in class 'image' as found in OE-Core's
commit [1].
[1] 451363438d38 ("classes/recipes: Switch to use inherit_defer")
(From yocto-docs rev: 674f376ece98466d3498459d5b5428a8bfbd5112)
Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
What was previously known variously as Bmaptool, bmaptools, bmap-tool,
and/or bmap-tools has been updated to the singular name: bmaptool. Update
all references to suit.
Since we are not in charge of debian's package naming policy, any
references that relate to debian package(s) will stay as "bmap-tools".
(From yocto-docs rev: 9c1505eabd69af548652381cf996d44f40a4fa8a)
Signed-off-by: Trevor Woerner <twoerner@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document the convention to use variables prefixed by VIRTUAL_RUNTIME.
Add references to the new term where possible.
Another reason is that such variables are recommended
in a warning issued by meta/classes-global/insane.bbclass
(From yocto-docs rev: 11e1ba97edac979868f199e43c1004db6678044c)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Tim Orling <ticotimo@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This adds some hints that and how changes should be tested when contributing.
Fixes [YOCTO #15412]
(From yocto-docs rev: 6f3dbb2a909ba5b71efb09b251ee3f8650e30146)
Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using "PR service" instead of "PR Service", like in the other
two instances in this document.
(From yocto-docs rev: f1061014dff7732fe97866dbd9208f09dcde56dc)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add missing documentation on how to add multiple groups with a single
GROUPADD_PARAM:${PN}
(From yocto-docs rev: e55d2aa6a0ee58ee980de2a6ca8d531c7c0cd44a)
Signed-off-by: Geoff Parker <geoffrey.parker@arthrex.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The SDKPATH variable seems mistakenly identified as the
default path where the SDK will be installed by the generated
installation script, unless option '-d' or a manual input
overrides this default.
The intended variable is SDKPATHINSTALL. SDKPATH indicates
where the SDK is being composed and built.
The definitions have been added/updated.
(From yocto-docs rev: d5b9c4b9c443cc728a11fd1e0a26a11aac8ee2c5)
Signed-off-by: Johan Bezem <jbezem.extern@arri.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
do_cleansstat can produce build errors when using a shared sstate cache.
Add a note to clearly discourage, provide a safe alternative (bitbake -f),
and the rationale.
Suggested-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Link: https://lore.kernel.org/yocto-docs/20240219155513.76738-1-luca.ceresoli@bootlin.com/T/#m5529687ecb0f9ec2dacddcb6ff58e2df73af9cde
(From yocto-docs rev: 6fb06bb4a917c1515e54fa3e699119f6bbb85767)
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
do_cleanall can produce failures when used in legitimate cases, such as
with recipe variants (foo and foo-native) or a shared DL_DIR. This is why
it is forbidden when writing tests that will run on the autobuilders
(https://docs.yoctoproject.org/test-manual/intro.html?highlight=cleanall#considerations-when-writing-tests).
Reword the documentation to clearly discourage, provide a safe alternative
(bitbake -f -c fetch), and the rationale with an example.
Reported-by: Sam Liddicott
Link: https://bootlin.com/blog/yocto-sharing-the-sstate-cache-and-download-directories/#comment-2650335
(From yocto-docs rev: bfeb00f9213b9d2650ccf03ea666387415227be4)
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With a new check was added for oe.qa for CVE_STATUS via commit
3c5b7605acd9cd68b ("cve-check: Log if CVE_STATUS set but not
reported for component")
in poky. Add related documentation here.
(From yocto-docs rev: 04e1ff01e1b43daa0e5832904a82f95d0cfab678)
Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Enough free storage space is needed to apply package upgrades.
(From yocto-docs rev: 6571eb02cbd5c2b96df0f279f25b63255ab7eac4)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Explicit the problems previous described as "obvious".
(From yocto-docs rev: ca939f9ceebbf9b5e82bb76abf1c4d20f039d68e)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Cover the new devtool ide plugin in the extensible sdk section.
Many thanks to Enguerrand de Ribaucourt for his re-view and
contributions.
(From yocto-docs rev: d318cc41e0600ca8e18bc6789cac414ae0226a07)
Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
PYTHON_PN is on its way out, therefore it's good to remove it from
documentation so its use is not promoted anymore.
(From yocto-docs rev: 74180c0f6bcdeadbd6f9a69d26f733c716f420fd)
Signed-off-by: Khem Raj <raj.khem@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 89403af3fa49ecb00dfec04ac9c490b6dc031008)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
To simplify the style, replace "Following is" and "Following are"
by "here is" and "here are", sounding more natural.
In some cases, also go further by simplifying "Here are/is xxx"
by "xxx are/is" when the "are" or "is" are not two far at
the end of the sentence.
In some cases too, completely remove the sentence, when
it's redundant with the preceding title.
(From yocto-docs rev: 52ba6bb16c73cbc2c0e77496d5226c49bce786f5)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Daniel Ammann <daniel.ammann@bytesatwork.ch>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- "git" is now required to run "set_versions.py"
- Fix Ubuntu / Debian packages.
The previous instructions didn't run on Debian 12
Tested on Ubuntu 22.04 and Debian 12.
Reported on https://lists.yoctoproject.org/g/docs/message/4789
(From yocto-docs rev: cd0525f1a081567d5d8722d368511179655ca541)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: <mhagans@skyviewsat.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Make the options more clear by providing them in a list instead of plain prosa.
Also add a ref for a presentation wrt spdx 3.0 in the Yocto project.
Fixes [YOCTO 7476]
(From yocto-docs rev: a15e354f98607592a67d2df91dfa2bf0707d8f38)
Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This fixes an ugly formatting issue in the HTML output
(From yocto-docs rev: 79530aeb97976b9a63bf04ed247f98061fc9d737)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This fixes an issue introduced by d8fdec653f96c4ddcb705ff0ef17ed641afcfe2d
(From yocto-docs rev: bd970a2101df6e7437fce9cd74deb8bb86aedbd0)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add the hint to the test setup that runqemu-gen-tapdevs will need the
iptables package installed.
(From yocto-docs rev: 4a688fb991282bf606f080d748f5290d988e4354)
Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 5a7a60cef173e8e73949629129182471b0a8f4b9)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This recipe was renamed some time ago. Update the name here as well for
consistency.
(From yocto-docs rev: cbbda4a95e0c6d5b669cf3bc844b6bb5cca881d3)
Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 29cee590d59294306600a119048a234f10375603)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
UBOOT_CONFIG accepts a third parameter for the UBOOT_BINARY that isn't
documented. To show its usage another example from the meta-freescale layer
was picked.
(From yocto-docs rev: 8b227582efbe9957026cdce4aef5621661af1fa5)
Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The VSCode extension is now officially maintained and published by the
Yocto Project so it should be referenced in the manuals to help users
discover it.
I located the most relevant places to reference the extension by looking
at how the old Eclipse plugin was documented in the 2.6 manuals as well
as the current Toaster references.
(From yocto-docs rev: 645153504690aa8a69b028e95a5e9d2da9644cf1)
Signed-off-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After changes in openembedded-core@1a4ab9f, image licenses moved one
directory down into ${SSTATE_PKGARCH} subdir.
(From yocto-docs rev: ea9675f079cef919a9d13ab12d095144b2eae6ab)
Signed-off-by: Ilya A. Kriveshko <iillyyaa@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
insserv.bbclass was removed from oe-core:
commit e6bb5dbb62
Author: Richard Purdie <richard.purdie@linuxfoundation.org>
Date: Sun May 10 12:30:49 2015 +0100
insserv: Remove
(From yocto-docs rev: 41a15a80a325cb63a41be81e632ec2799bfb2957)
Signed-off-by: Maxin John <maxin.john@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The yocto website has changed its structure. Update the section for
Accessing the Downloads page to match the new structure.
(From yocto-docs rev: d8fdec653f96c4ddcb705ff0ef17ed641afcfe2d)
Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
According to currently active workers
https://autobuilder.yoctoproject.org/typhoon/#/workers
Also correct the text saying that SANITY_TESTED_DISTROS
lists currently tested distros.
Also replace AlmaLinux 8.8 and 9.2 by just AlmaLinux 8 and 9,
as we update our workers anyway.
(From yocto-docs rev: bceadfad0954e8473b0e87bba8d6b1e67fd88eef)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As used in the rest of the manual.
(From yocto-docs rev: 5a5dfc446bb62568da50056660d18c5c309d1051)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: e52128cd0e555f16c86812a21e92f27ca5d76152)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Align the order from `BB_SIGNATURE_HANDLER` to `SSTATE_MIRRORS` in Quick Build
with the order in the default local conf. While trivial it is easier to find,
if the order matches.
(From yocto-docs rev: d4a836d1ea2b97c81f7edb4dc234b4a1bd532766)
Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reword a fix to align with the final release notes.
(From yocto-docs rev: b1b2fdbbb7549af2737cb868a821a4472214f420)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Better than using "python unittest" without any
special formatting.
(From yocto-docs rev: ddf899611c56e6f44e9da2c69ed9c75a5491d882)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
SRC_URI[md5sum] has been deprecated for a long time. Discourage its use
by removing it from examples and note that it should be replaced by
SRC_URI[sha256sum] when updating recipes.
Also mention that bitbake supports other checksums, though they are not
commonly used.
(From yocto-docs rev: 806c6cb0b457248ac7401487ba2cdd17a1eba320)
Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: ab48159aa99a7bba38c81166e75f8b612cbadc65)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
"--subject-prefix" applies to "git format-patch", not "git send-email"
(From yocto-docs rev: d0e255f4ace445e076f37d42bbc69378f5985c59)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
release notes based on 4.2.4 rc3.
(From yocto-docs rev: de4fb1f877ae9994c61dfc60447446da317bee0f)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- nanbield is now released
- update the start and end dates
(From yocto-docs rev: 81afa3c95276f9e3fbd1f282ad5954d591fbbb95)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 9c2e64fdc884f74bbeef5a830f098a714e3809a7)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After the following meta-yocto commits, MIRRORS & PREMIRRORS are no
longer set in the poky distro config file:
67b79df4fbff ("poky.conf: remove redundant MIRRORS")
1b71a3b9418f ("poky: Drop PREMIRRORS entries for scms")
(From yocto-docs rev: bc84dd0b6cdb1b2432ae60c036df9ee15cd53f34)
Signed-off-by: Paul Barker <paul.barker.ct@bp.renesas.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add Repositories/Downloads Section for 4.3 release notes.
(From yocto-docs rev: d8ee569524663ac738cb71ff2fd8cca49d0acf6c)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This adds support for the Nanbield (4.3) release and update the
current dev branch to Scarthgap.
(From yocto-docs rev: cfbb2cda2c3d221f944ae610c05039c9d12093bc)
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Reword the layername side-effects commentary to be a bit more readable
* Extend edgerouter removal description
* Correct capitalisation of systemd
* For QEMU_USE_SLIRP, specify what to use instead, and adjust the
following list item to use the same style
* Extend statement on -crossssdk / MLPREFIX change to indicate what
needs to be done
(From yocto-docs rev: bfc49b59b6cd905cef0294792f05661b36181a6e)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Remove some items from the 4.3 migration guide:
* The PERLVERSION and PERLARCH items are already mentioned under the
removed variables section
* The jsDelivr item is interesting, but it isn't a backwards
compatibility issue that the user would need to take action to
resolve, and we already cover it in the release notes.
(From yocto-docs rev: c72d190cd8ccc471a0b93b90b272c95cd57ef3dc)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some additional feature items from combing through commits (not 100%
complete yet.)
(From yocto-docs rev: 05c13cf0964a892a38531e3cfac68687278ee601)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These are both Rust-related, let's move them the Rust section since they
are more notable there.
(From yocto-docs rev: 0510136abf8868d510125bae7f4096342bb94ec0)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section doesn't make a lot of sense to separate out. The SPDX
change is now no longer Poky-specific, and the poky-altcfg usrmerge
change is not really notable given that poky-altcfg is not widely used
outside of our testing and also itself selects systemd as INIT_MANAGER
and thus requires usrmerge anyway (as noted elsewhere).
(From yocto-docs rev: 234379c81db810c1fc3b860d51a59c200e97b2ca)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add the list of CVE fixes, recipe upgrades (from commits since layer
index version comparison not currently working), license changes and
contributor list.
(From yocto-docs rev: 32bc3d603894ddefb4766fdf4e10442f1aa75216)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A few grammar tweaks.
(From yocto-docs rev: a3e1258be27a08147b062603bd1b6526b26e9516)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In nanbield these are no longer needed - spaces are sufficient.
The code still handles any semicolons (replacing them with spaces before
interpreting the value), but let's avoid people adding them from now on
in case we decide to change that in future.
(From yocto-docs rev: 2947f6309f86cdf5322a39d4420e77431a8e3572)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update for changes in nanbield. Note that I am documenting what is set
by poky.conf here (since this is Yocto Project documentation), which is
slightly different from what is done in meta/conf/bitbake.conf.
(From yocto-docs rev: 9764cb9e19788eb1caea0d2e95fbe7a5c19887d4)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
apm is no longer supported in nanbield.
(From yocto-docs rev: fa07d34db3b5ba670ed2dc1228ffb3c0c09b3c08)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Create a Map to detail how BitBake handles a recipe's tasks
and its compile/runtime dependencies along with detailed comments.
(From yocto-docs rev: 7f0ab56aa302babab6c9d600a8d8a91708cf75f7)
Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Extend the description on how to prepare a patch for a CVE issue.
Add a more illustrative and current example of how to modify
the patch file. Add an example of how to use CVE_STATUS.
(From yocto-docs rev: f982f6be6b52ba0915b2e6f712270dec5dde64fc)
Signed-off-by: Marta Rybczynska <marta.rybczynska@syslinbit.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
No longer in use in Poky (dropped in Nanbield through
multiple commits)
(From yocto-docs rev: e5d39e85a0db27bfc857fae9649f799179888eee)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Mention CVE_STATUS_GROUPS in the development manual
(otherwise only present in the reference manual, but with
no reference to it)
- In the reference manual description of CVE_STATUS,
link back to the development manual, to provide context.
(From yocto-docs rev: cfef5fe41b6c819e783c88829448ae38141650a5)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Plus a minor whitespace fix change
(From yocto-docs rev: 6f7e1b935168464b4682a8687aa6d031a1a9fb73)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Mark Hatle <mark.hatle@kernel.crashing.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Introduced by
https://git.yoctoproject.org/poky/commit/?id=66ed174ccdf7a89cb998f503cc6b631e2d1adcc0
(From yocto-docs rev: 4bdd4976667b802895b13541b77191a65335a175)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Bruce Ashfield <bruce.ashfield@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Now that https://bugzilla.yoctoproject.org/show_bug.cgi?id=14481
is closed.
(From yocto-docs rev: de23d389f3fe7c2e18325cf29361d90b9bb19ead)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add the initial version of the section on vulnerability reports,
operations of the Security Team with a
transcription of https://wiki.yoctoproject.org/wiki/Security_private_reporting
(From yocto-docs rev: 2b86ac95c557f1e57176cceff428eb63e56c6328)
Signed-off-by: Marta Rybczynska <marta.rybczynska@syslinbit.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
systemd-resolved is a distro feature added in poky commit
6f30e3586e
(From yocto-docs rev: 2adb9c0a37f7bdbb293e78d71c872ca3bd9c06c4)
Signed-off-by: Eero Aaltonen <eero.aaltonen@vaisala.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Remove a reference to a web resource which is clearly marked as obsolete.
Replace the unnecessarily verbose note by just links to the mentioned tools.
[YOCTO #15233]
(From yocto-docs rev: 3f979f5d2446d57d75f0c4ad2199510d533880e8)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Recommended instead of the Yocto Project mirror, because expected
to be faster. Make sure you only set one such mirror.
(From yocto-docs rev: 5a2d09501ab807a0f61c10533f3bd81894f6f20e)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: richard.purdie@linuxfoundation.org
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Make it clear that patchtest only supports openembedded-core for now
- Add a short list of instructions for installing Python module
dependencies on the host
- Add a step to add meta-selftest with bitbake layers so that all tests
can run
(From yocto-docs rev: bcd58d68e72226be1930593f5f7fb37de15b7913)
Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As discussed before with Richard Purdie, the code supports this but the documentation does not.
Developers in general will not notice this or focus on it because they do not mess with the
layer.conf template file, but in my opinion I think more details can help.
(From yocto-docs rev: 15fc103d4ddd14698c8e75cc654ac157ca1ad740)
Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
COMPATIBLE_MACHINE is used to forbid the use of a recipe or its packages
for a specific set of machines.
In some cases, it may make more sense to have the logic inverted and
have the recipe always forbidden except for hand-picked machines. Such
could be the case for pieces of software that only support some
architectures. In that scenario, it is sometimes a bit easier on the eye
and for maintenance to use the OVERRIDES mechanism but for that, a
default should be set.
COMPATIBLE_MACHINE:aarch64 = "^(aarch64)$"
COMPATIBLE_MACHINE:mips64 = "^(mips64)$"
wouldn't do much because if COMPATIBLE_MACHINE isn't set, the recipe is
assumed compatible and therefore, if no default is provided we enter
that case.
Hence, we need to add
COMPATIBLE_MACHINE = "^$"
as default so that it only matches the empty string, which isn't
possible for MACHINEOVERRIDES.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 52196d39bc85de267daffb0074eb59786751f57d)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Various aesthetic cleanups of section 1 of that manual, including:
* replace 'HOWTO' with manual
* add more examples of sdk-related images
* font fixes
(From yocto-docs rev: 608e93e13a8316a8d40e0675d4335084efa3736a)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
PACKAGECONFIG's first and second flag value will be added to PACKAGECONFIG_CONFARGS
and then it will be added to the appropriate variable (EXTRA_OECMAKE, or ...)
So we need to only mention PACKAGECONFIG_CONFARGS and it will lead to other variables.
I added a custom example that can help understanding very well PACKAGECONFIG.
(From yocto-docs rev: 7f26b0c0a08d6be9810128369265b0c494e7191b)
Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add missing parenthesis, and another example of a compressed patch filename.
(From yocto-docs rev: d44ccb5ed4292b0371651f38b9a0e3083f60ae87)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 0f8fe127eb9ae2f56b280a7634ea7ab9a270f382)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: ceb1812e63b9fac062f886c2a1dde23137c0e1ed)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
