Commit Graph

6708 Commits

Author SHA1 Message Date
Julien Stephan
233dd66bad ref-manual: variables: add SIGGEN_LOCKEDSIGS* variables
Variables SIGGEN_LOCKEDSIGS, SIGGEN_LOCKEDSIGS_TASKSIG_CHECK and
SIGGEN_LOCKEDSIGS_TYPES are used to lock specific tasks to specific
signatures. They are used by bitbake -S <lockedsigs> and bblock, so add
documentation for them.

(From yocto-docs rev: 2d7795833fb044e2377f042998fe139cd1543d97)

Signed-off-by: Julien Stephan <jstephan@baylibre.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 32e3995bed2836f549866ec3b8ad254bdda37dbf)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-11-09 05:53:57 -08:00
Julien Stephan
948b6bb320 styles: vocabularies: Yocto: add sstate
Add sstate as an accepted word to avoid errors when runnign make
stylecheck.

(From yocto-docs rev: ae3d79adfaefe86cff55b6fca6e2250cba040b67)

Signed-off-by: Julien Stephan <jstephan@baylibre.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 1c50726296e876747ea3f862729e953f025ce619)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-11-09 05:53:57 -08:00
Julien Stephan
f6ac0554af documentation: Makefile: add SPHINXLINTDOCS to specify subset to sphinx-lint
make sphinx-lint runs sphinx-lint on the whole documentation which can be
long and reports a lot or errors/warnings. Let's add a new
SHPINXLINTDOCS variable to allow specifying a subset, just as VALEDOCS
does. Keep variable assignment aligned and also use $(SOURCEDIR) by
default for SPHINXLINTDOCS and VALEDOCS variables.

Also update the README file and fix a typo in Link checking section
title.

(From yocto-docs rev: c478ef829433c431456835bca240df44ffe8fcca)

Signed-off-by: Julien Stephan <jstephan@baylibre.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Tested-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 3dfe7b5c746af31de74f67cf88214e5d52bdb65d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-11-09 05:53:57 -08:00
Julien Stephan
5c781e69d7 README: add instruction to run Vale on a subset
make stylecheck runs Vale on the whole documentation which can be long
and reports a lot of errors/warnings. We can run Vale on a subset using
the VALEDOCS variable, so update documentation to highlight it.

(From yocto-docs rev: e75064520f86c9fd674acff3dd16c88dcc489ba6)

Signed-off-by: Julien Stephan <jstephan@baylibre.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Tested-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 262237f72534c983e178231cb6839ed69709c443)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-11-09 05:53:57 -08:00
Antonin Godard
8d694594e1 conf.py: rename :cve: role to :cve_nist:
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' {} \+

Cherry pick:

* remove changes to release-notes-5.1.rst, does not exist on this branch.

* release-notes-5.0.4.rst: apply the command to this file as it was
  treated previously.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 15fa3b7e85dde50d7236c1738ad607531cc654b8)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-11-09 05:53:57 -08:00
Steve Sakoman
28385f2040 release-notes-4.0: update BB_HASHSERVE_UPSTREAM for new infrastructure
Public hashserver is now at hashserv.yoctoproject.org:8686

(From yocto-docs rev: 5aeb6a6b2799fb72abbfb272271e3175eca14b37)

Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-11-09 05:53:57 -08:00
Antonin Godard
90e5f29976 ref-manual: devtool-reference: document missing commands
Give a brief description for important commands that made it into
devtool or that were missing from this quick reference document.

(From yocto-docs rev: cf679f2aa05ef1b5872d97820629375a5c7f4610)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 6238adae1b072c9e09c558038d397dfac6ec109f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-11-09 05:53:57 -08:00
Antonin Godard
f189e96904 ref-manual: devtool-reference: refresh example outputs
Previous outputs were missing some commands and options, some others
were obsolete.

(From yocto-docs rev: a0b1cec6f572cf7edd0575c70612ee27fe1239b3)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 1c83037707b4c981a70c968ba04ded502f9bffbf)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-11-09 05:53:57 -08:00
Antonin Godard
987ed7b050 ref-manual: release-process: add a reference to the doc's release
When reading the stable releases section, we want to know for which
release the documentation was built. Use &DISTRO_NAME; to refer to the
current release.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 05ee6844d710beb844bbdac892888879847f6d22)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-11-09 05:53:57 -08:00
Antonin Godard
28bb97b525 ref-manual: release-process: update releases.svg with month after "Current"
This way we put a timestamp on the image, so that someone looking at the
image on an old release tarball has a representation of the release "as
of <date>".

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

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 7b62bbec900bc84a31e4686839e774ba7bd5ae9f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-11-09 05:53:57 -08:00
Lee Chee Yang
2f136ed7ed migration-guide: add release notes for 4.0.22
(From yocto-docs rev: 74369923b34b879275cd1d5af6d73e57be757078)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 9563855ccd92e21fb6f8320c96a3a83e115c947e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Antonin Godard
7799e6ed20 ref-manual: release-process: refresh the current LTS releases
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: 0ed10e173457bf28338115a063cfa42c88a541d8)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit afeded9939777d88bf4cb9ebf7a61aadd476642d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Antonin Godard
03f47f247f ref-manual: release-process: update releases.svg
* 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: 098dd6eaa072b96ba34c15616f973f1c03eaee75)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit aa9a580c8c57af4baa4fb24a43487fb7afc258e5)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Antonin Godard
5310947604 ref-manual: faq: add q&a on class appends
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: a030626167905034e24589119453ca6f5fb41cfe)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 2466a5e7973bf6e724f1cf0b42f838065847d283)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Antonin Godard
cab2c6b225 overview-manual: concepts: add details on package splitting
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: ccda7c8bb890a290fb41e104f6d818076f4eeaa8)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 143c3cacdec36c9d7ab81c89bbcc12c0c3936bd9)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Antonin Godard
ddace1be70 ref-manual: structure.rst: document missing tmp/ dirs
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: 5958b3c7546d71fdd1693c26747e0196c6aaf277)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 372b5b4ca55819c294970b20aa8b8d8167144329)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Robert Yang
5feebd85ed release-notes-5.0.rst: NO_OUTPUT -> NO_COLOR
(From yocto-docs rev: 5becb08c498cf7cd2af006ed3b0422e39f1ab6b6)

Signed-off-by: Robert Yang <liezhi.yang@windriver.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(cherry picked from commit ac4c4455d40dc0852d95461a3a10d687d2aedd6e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Antonin Godard
9d948925b1 ref-manual: merge patch-status-* to patch-status
These are not distinct anymore and check for any patches in any layer.

(From yocto-docs rev: a27e4c426bfb039c9a2a4b7971a74c1fc05e6274)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 300c585909743754e0e6662d48d43834c031b835)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Antonin Godard
a47165d780 ref-manual: add missing OPKGBUILDCMD variable
(From yocto-docs rev: 207dcc17f065760b6a28e762195ed2c48db95935)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a6a2c8e48995200c9c3be7096f34d912427de145)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Antonin Godard
948b044d9c ref-manual: add missing EXTERNAL_KERNEL_DEVICETREE variable
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: 1a8c810eaab846379c6fc37960c7e41a5c7af9ba)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 6566ffceab3780dc5ecbfe26f786ebe6ff17e693)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Antonin Godard
c00c032e03 ref-manual: add missing TESTIMAGE_FAILED_QA_ARTIFACTS
This variable lists space-separated paths on the target to retrieve onto
the host, when inheriting testimage.

(From yocto-docs rev: 519a149521a01156c51b472d246ce0b01a74dbfc)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 2537642d2cdf844dc5f6027fb3097aac52162c1f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Antonin Godard
90798fdc88 ref-manual: add missing CVE_CHECK manifest variables
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: ec12435c8068c3fb78f11c9a550827e25beb6d67)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 14131a42a7ea8bbae2165c1b8dbcabd5f28b2b22)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Aleksandar Nikolic
86373fe16b ref-manual: introduce CVE_CHECK_REPORT_PATCHED variable
(From yocto-docs rev: e84fca10400b0f2862d7d0344fb19df5b1e6dc62)

Signed-off-by: Aleksandar Nikolic <an010@live.com>
Reviewed-by: Michael Opdenacker <michael@opdenacker.org>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
(cherry picked from commit f585a68a8f35f31814e408dd973ea7345adbbacf)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Lee Chee Yang
ab921f9d4c migration-guides: add release notes for 5.0.4
(From yocto-docs rev: 659579ec4e5e1011c362cb51fe9d94c0e69a5b47)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-30 08:30:00 -07:00
Lee Chee Yang
cd44e6bd40 migration-guide: add release notes for 4.0.21
(From yocto-docs rev: a854b398db797394677ac8e15b5459373c1c3cd3)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-10-11 05:47:38 -07:00
Jörg Sommer
71d86290d4 doc/features: describe distribution feature pni-name
(From yocto-docs rev: d71081dd14a9d75ace4d1c62472374f37b4a888d)

Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-09-25 05:07:47 -07:00
Jörg Sommer
85cc3e078d doc/features: remove duplicate word in distribution feature ext2
(From yocto-docs rev: ff4e9d2e516c57c1d0664462ff588666c1fd93a0)

Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-09-25 05:07:47 -07:00
Lee Chee Yang
c5627ab06f migration-guides: add release notes for 5.0.3
(From yocto-docs rev: fd4654df2d9eb36cae872dca4d23341ed5f9be91)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-08-26 05:18:44 -07:00
Lee Chee Yang
35af162f52 migration-guide: add release notes for 4.0.20
(From yocto-docs rev: 9b822bab8d351a120ebcdbc0d43d709921b88dca)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-08-26 05:18:44 -07:00
Matthias Pritschet
e7bfd398dd ref-manual: fix typo and move SYSROOT_DIRS example
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: 74cdaccd4cbe208de037b3b35c2cf0b8aa334748)

Signed-off-by: Matthias Pritschet <matthias@pritschet.eu>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-08-26 05:18:44 -07:00
Lee Chee Yang
a725df1839 migration-guides: add release notes for 5.0.2
(From yocto-docs rev: 09e321d7cbd5bd7071a0c138e6d0c424fb086269)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-07-12 05:47:20 -07:00
Lee Chee Yang
ff5d37d510 migration-guides: add release notes for 4.0.19
add release notes for 4.0.19.

(From yocto-docs rev: ac201a70a5a5fd2c2e4549debbac84bc6aef662f)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael@opdenacker.org>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-07-12 05:47:20 -07:00
Lee Chee Yang
de361f9fcd migration-notes: add release notes for 5.0.1
add release notes for 5.0.1

(From yocto-docs rev: 50b50d9680a49949a34371a45ae9dd1ff0755832)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-07-12 05:47:20 -07:00
Quentin Schulz
b9b47b1a39 docs: brief-yoctoprojectqs: explicit version dependency on websockets python module
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: 875dfe69e93bf8fee3b8c07818a6ac059f228a13)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-05-09 04:45:06 -07:00
Michael Opdenacker
22927ccce3 ref-manual: update releases.svg
- Make Scarthgap a current release
- Add Styhead

(From yocto-docs rev: 41ddae07a73da38eb82b00146fd970402b4ac5a7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-05-06 13:32:02 -07:00
Lee Chee Yang
cc5aededce release-notes-5.0: update Repositories / Downloads section
(From yocto-docs rev: cdce92a0f1595b4cf7b7797f5f95a2d8d8f7d376)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-05-06 13:32:02 -07:00
Lee Chee Yang
af21f39987 migration-notes: add release notes for 4.0.18
add release notes for 4.0.18 (rc1).

(From yocto-docs rev: 9be2db28278774676e9fd6919603fc06d27a3676)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-05-06 13:32:02 -07:00
Alexander Kanavin
a4e6110a91 documentation/poky.yaml.in: drop mesa/sdl from essential host packages
They used to be required for qemu graphics support, but neither is being
for anything anymore.

(From yocto-docs rev: 3c11dfd49902cd8962fc6c732158c3c43ce9c34e)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-05-06 13:32:02 -07:00
Michael Halstead
b1c0e46031 docs: add support for scarthgap 5.0 release
Prepared for Scarthgap release. Add references to Styhead.

(From yocto-docs rev: 1b5f2ac75c069f972cdd9c6691519d50a5f8e468)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-05-06 13:32:02 -07:00
Richard Purdie
3e10e2afba brief-yoctoprojectqs: Update to the correct hash equivalence server address
Also add a note about needing python websockets installed.

(From yocto-docs rev: 9dfe3d2dcba8bb2d2e277ff2204862dc8b77c8b9)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-05-02 17:07:17 +01:00
Lee Chee Yang
eb723d4a10 release-notes-5.0: update recipes changes
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>
2024-04-24 14:23:00 +01:00
Michael Opdenacker
299ead538a manuals: standards.md5: add standard for project names
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>
2024-04-24 14:23:00 +01:00
Paul Eggleton
795511f0ea release-notes: add a few more new features
Add some features I missed earlier (patchtest, Toaster, hash
equivalence enhancements, screenshot-based UI test,
USERADD_DEPENDS).

(From yocto-docs rev: 774f0ba6345592571c7c7cff495f2b15dca21f25)

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>
2024-04-24 14:23:00 +01:00
Paul Eggleton
8eb06eb958 ref-manual: variables: add USERADD_DEPENDS
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>
2024-04-24 14:23:00 +01:00
Paul Eggleton
ed5ba9b900 release-notes: additional features and one known issue for 5.0
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>
2024-04-16 07:55:42 +01:00
Paul Eggleton
1c35484be2 migration: extend migration guide for 5.0
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>
2024-04-16 07:55:42 +01:00
Paul Eggleton
0b86798f04 release-notes: add CVEs, recipe upgrades and contributors for 5.0
* 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>
2024-04-16 07:55:42 +01:00
Paul Eggleton
8ccdf6df3c dev-manual: update custom distribution section
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>
2024-04-16 07:55:42 +01:00
Paul Eggleton
bba5a688ea dev-manual: update reference to sstate-cache-management script
* 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>
2024-04-16 07:55:42 +01:00
Paul Eggleton
bb4f3bc1fc ref-manual: variables: add TARGET_DBGSRC_DIR
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>
2024-04-16 07:55:42 +01:00
Paul Eggleton
7d41877ce9 ref-manual: classes: cve_check: add note about remote patches
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>
2024-04-16 07:55:42 +01:00
Paul Eggleton
0ff0de3c65 ref-manual: add new python classes
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>
2024-04-16 07:55:42 +01:00
Paul Eggleton
cb7663fe2b ref-manual: add virtual-slash QA check
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>
2024-04-16 07:55:42 +01:00
Geoff Parker
073c07ef76 ref-manual: variables: Update default INHERIT_DISTRO value
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>
2024-04-16 07:55:42 +01:00
Lee Chee Yang
eb8d6f9a09 release-notes-5.0: various additions and improvements
(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>
2024-04-16 07:55:42 +01:00
Michael Opdenacker
90bf2ec7e4 migration-guides: release-notes-5.0: update docs highlights
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>
2024-04-12 17:29:34 +01:00
Michael Opdenacker
28ea006454 dev-manual/debugging: mention new `taskexp_ncurses` option
(From yocto-docs rev: 301c802a92a2c53c3d0c755c31a6e09130956fde)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested_by: Reyna, David <david.reyna@windriver.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-04-12 17:29:34 +01:00
Michael Opdenacker
a738448d83 manuals: remove tab characters
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>
2024-04-12 17:29:34 +01:00
Michael Opdenacker
3ad2f245f0 release-notes-5.0: documentation highlights
(From yocto-docs rev: d8f63d3c83e33793e6249fd660ef7b75d87e12db)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-04-12 17:29:34 +01:00
Joao Marcos Costa
6522e13fd3 release-notes-5.0: mention cmake-qemu.bbclass
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>
2024-04-12 17:29:34 +01:00
Joao Marcos Costa
a122a14ddc release-notes-5.0: add updates
- add new core recipes section
- add new variables
- add arch-specific enhancements
- add kernel-related enhancements
- add qemu enhancements
- add rust enhancements
- add wic enhancements
- add sdk-related improvements
- add testing enhancements
- add utility script changes
- add packaging changes
- add bitbake improvements
- add miscellaneous changes

(From yocto-docs rev: 72a80395199dd8a5d757b9e67629e1bb849273f1)

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>
2024-04-12 17:29:34 +01:00
Joao Marcos Costa
e877e81a3c ref-manual/variables: add new variables for v5.0
Add variables newly referenced in release-notes-5.0.

(From yocto-docs rev: 1d064cf0e260a1271c2fad7cd01bb154361f6691)

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>
2024-04-12 17:29:34 +01:00
Yoann Congal
e050327407 release-notes-5.0: document some cve, strace and qa changes
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>
2024-04-12 17:29:34 +01:00
Yoann Congal
f6f6d98e6d ref-manual: variables: document CVE_DB_INCR_UPDATE_AGE_THRES variable
(From yocto-docs rev: 7f1db309205f9c3cb0b44b6d75d6c65c928787e2)

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>
2024-04-12 17:29:34 +01:00
Jörg Sommer
c0b4eff954 kernel-dev: join mkdir commands with -p
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>
2024-04-08 14:36:38 +01:00
Michael Opdenacker
88f04994ef migration-guides: add missing opening tag colon
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>
2024-04-08 14:36:38 +01:00
Michael Opdenacker
e426fd7f86 manuals: fix incorrect double backticks
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>
2024-04-08 14:36:38 +01:00
Michael Opdenacker
fed404fca0 manuals: fix trailing spaces
Fixing errors reported by "make sphinx-lint"

(From yocto-docs rev: ef6b650c31c4320314564bb85a45eebde3fd98c1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-04-08 14:36:38 +01:00
Michael Opdenacker
ae1b8c6079 manuals: add initial sphinx-lint support
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>
2024-04-08 14:36:38 +01:00
Joao Marcos Costa
6981712250 release-notes updates for 5.0
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>
2024-04-08 14:36:38 +01:00
Joao Marcos Costa
6e147fabdd migration updates for 5.0
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>
2024-04-08 14:36:38 +01:00
Joao Marcos Costa
d72ace8e5a classes: document new go-vendor class
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>
2024-04-08 14:36:38 +01:00
Lee Chee Yang
d357a08fb1 migration-guides: add release notes for 4.3.4
(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>
2024-04-08 14:36:38 +01:00
Michael Opdenacker
54e4bc1c91 manuals: fix duplicate "stylecheck" target
(From yocto-docs rev: f19e4231b1982f97ffd210b76978404fe1f2893b)

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>
2024-04-08 14:36:38 +01:00
Quentin Schulz
4de1b38922 manuals: refer to new yocto-patches mailing list wherever appropriate
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>
2024-04-08 14:36:38 +01:00
Quentin Schulz
e802b06490 docs: conf.py: properly escape backslashes for latex_elements
There are some syntax warnings returned by Python:
"""
yocto-docs/documentation/conf.py:162: SyntaxWarning: invalid escape sequence '\P'
  'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}',
yocto-docs/documentation/conf.py:163: SyntaxWarning: invalid escape sequence '\s'
  'preamble': '\setcounter{tocdepth}{2}',
"""

Backslashes must be doubled in Python string literals to avoid
interpretation as escape sequence, c.f.
https://www.sphinx-doc.org/en/master/latex.html#module-latex.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: a78d9bde7f90f860aa969b7d8e47350de9106183)

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>
2024-04-08 14:36:38 +01:00
Lee Chee Yang
251b5f7a06 release-notes-4.0.17: reorder CVEs
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>
2024-04-08 14:36:38 +01:00
Alexander Kanavin
27e72a5f13 dev-manual: improve descriptions of 'bitbake -S printdiff'
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>
2024-03-19 15:22:27 +00:00
Alexander Kanavin
bc06390947 dev/ref-manual: document conf-summary.txt together with conf-notes.txt
(From yocto-docs rev: b92f2eac3b7455ebfc87f668b9442122dbf1c66f)

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>
2024-03-19 15:22:27 +00:00
Alexander Kanavin
b685c76b68 sdk-manual: correctly describe separate build-sysroots tasks in direct sdk workflows
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>
2024-03-19 15:22:27 +00:00
BELOUARGA Mohamed
98fb300f40 ref-manual: add documentation of the variable SPDX_NAMESPACE_PREFIX
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>
2024-03-19 15:22:27 +00:00
Michael Opdenacker
d255faa35e profile-manual: usage.rst: further style improvements
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>
2024-03-19 15:22:27 +00:00
Michael Opdenacker
f6584a38ae manuals: add initial stylechecks with Vale
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>
2024-03-19 15:22:27 +00:00
Martin Jansa
8a8040b37e contributor-guide: be more specific about meta-* trees
* 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>
2024-03-19 15:22:27 +00:00
Lee Chee Yang
13d1ee8cb4 migration-guides: add release notes for 4.0.17
(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>
2024-03-19 15:22:27 +00:00
Michael Opdenacker
ddd8f69db9 migration-guides: draft notes for upcoming release 5.0
(From yocto-docs rev: e81c4da57aacce4a5c9e7b36ad4f911116747dd1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-03-19 15:22:27 +00:00
Michael Opdenacker
df44348f0b documentation: Makefile: remove releases.rst in "make clean"
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>
2024-03-19 15:22:27 +00:00
Michael Opdenacker
2b66b2f8eb profile-manual: usage.rst: fix reference to bug report
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>
2024-03-19 15:22:27 +00:00
Michael Opdenacker
3b86df94f7 manuals: use "manual page(s)"
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>
2024-03-19 15:22:27 +00:00
Michael Opdenacker
063b0cf8f9 profile-manual: usage.rst: formatting fixes
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>
2024-03-19 15:22:27 +00:00
Michael Opdenacker
e987c5151c manuals: add initial stylechecks with Vale
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>
2024-03-19 15:22:27 +00:00
Ulrich Ölmann
0808113517 ref-manual: classes: update description of class 'image_types'
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>
2024-03-19 15:22:27 +00:00
Trevor Woerner
002a6bbf66 dev-manual: bmaptool: rename
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>
2024-03-06 16:54:54 +00:00
Michael Opdenacker
dbcb74ef81 manuals: document VIRTUAL-RUNTIME variables
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>
2024-03-06 16:54:54 +00:00
Simone Weiß
f9e1cfe9e8 contributor-guide: add notes for tests
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>
2024-03-06 16:54:54 +00:00
Michael Opdenacker
c2fd0446ec dev-manual: packages: fix capitalization
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>
2024-03-06 16:54:54 +00:00
Geoff Parker
833506169c ref-manual: variables: adding multiple groups in GROUPADD_PARAM
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>
2024-03-06 16:54:54 +00:00
Johan Bezem
9400b992fd ref-manual: variables: correct sdk installation default path
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>
2024-03-06 16:54:54 +00:00
Luca Ceresoli
81be53672f ref-manual: tasks: do_cleansstate: recommend using '-f' instead for a shared sstate
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>
2024-03-06 16:54:54 +00:00
Luca Ceresoli
aca3afe827 ref-manual: tasks: do_cleanall: recommend using '-f' instead
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>
2024-03-06 16:54:54 +00:00
Simone Weiß
aaa609ac2b ref-manual: classes: add cve status check for oe.qa
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>
2024-03-06 16:54:54 +00:00
Michael Opdenacker
6b356b74d8 dev-manual: packages: need enough free space
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>
2024-02-24 16:13:29 +00:00
Michael Opdenacker
ea5fa49bfc dev-manual: packages: clarify shared PR service constraint
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>
2024-02-24 16:13:29 +00:00
Adrian Freihofer
1a2cf4c538 sdk-manual: extensible.rst: cover devtool ide-sdk
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>
2024-02-24 16:13:29 +00:00
Khem Raj
736ba6823d ref-manual: variables: remove PYTHON_PN
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>
2024-02-24 16:13:29 +00:00
Lee Chee Yang
baa7f95aab migration-guide: add release notes for 4.3.3
(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>
2024-02-24 16:13:29 +00:00
Michael Opdenacker
025386d53c manuals: suppress excess use of "following" word
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>
2024-02-24 16:13:28 +00:00
Michael Opdenacker
67efdd63c2 ref-manual: release-process: grammar fix
(From yocto-docs rev: e8a59c67a8719096f8b67942cec4f8a0656c410c)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-02-24 16:13:28 +00:00
Michael Opdenacker
8a3e233a37 ref-manual: system-requirements: update packages to build docs
- "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>
2024-02-24 16:13:28 +00:00
Simone Weiß
1f247f5451 dev-manual: Rephrase spdx creation
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>
2024-02-24 16:13:28 +00:00
Michael Opdenacker
f4fc8e6232 release-notes-4.3: fix spacing
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>
2024-02-05 14:30:34 +00:00
Michael Opdenacker
559313fe03 docs: remove support for mickledore (4.2) release
(From yocto-docs rev: a6c28b89b40df38d6456d1a3ddb42d0231759b41)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-02-05 14:30:34 +00:00
Michael Opdenacker
4697b6454c dev-manual: start: remove idle line
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>
2024-02-05 14:30:34 +00:00
baruch@tkos.co.il
c71f5236a4 contributor-guide: fix lore URL
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>
(From yocto-docs rev: 5962a09a120681c1328e05335c2f14fad06c63ce)

Signed-off-by: Baruch Siach <baruch@tkos.co.il>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-02-05 14:30:34 +00:00
Simone Weiß
8ae9a598ce dev-manual: gen-tapdevs need iptables installed
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>
2024-02-05 14:30:34 +00:00
Lee Chee Yang
596d5bb6fa migration-guide: add release notes for 4.0.16
(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>
2024-02-05 14:30:34 +00:00
Simone Weiß
27d2c6dd1a bsp-guide: correct formfactor recipe name
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>
2024-02-05 14:30:34 +00:00
Lee Chee Yang
0971cf620c migration-guide: add release notes for 4.3.2
(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>
2024-01-12 11:34:06 +00:00
Jörg Sommer
b0f2fd0fad documentation: Add UBOOT_BINARY, extend UBOOT_CONFIG
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>
2024-01-12 11:34:06 +00:00
Enguerrand de Ribaucourt
ed6c38e3af manuals: document VSCode extension
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>
2024-01-12 11:34:05 +00:00
Adrian Freihofer
f72759de57 ref-manual: document cmake-qemu class
(From yocto-docs rev: b2e396bd970ea8f27ba575b49c1489e2181442b8)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-01-12 11:34:05 +00:00
Ilya A. Kriveshko
0b449adebe dev-manual: update license manifest path
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>
2024-01-12 11:34:05 +00:00
Maxin B. John
b5b64bd0e3 ref-manual: classes: remove insserv bbclass
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>
2024-01-12 11:34:05 +00:00
Simone Weiß
040eea3de6 dev-manual: start.rst: update use of Download page
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>
2024-01-12 11:34:05 +00:00
Michael Opdenacker
5841968223 ref-manual: update tested and supported distros
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>
2024-01-12 11:34:05 +00:00
Michael Opdenacker
120ac9aa8b contributor-guide: use "apt" instead of "aptitude"
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>
2024-01-12 11:34:05 +00:00
Lee Chee Yang
17ce339581 migration-guides: add release notes for 4.0.15
(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>
2023-12-18 13:18:55 +00:00
Michael Opdenacker
d59a8b7f46 dev-manual: runtime-testing: fix test module name
(From yocto-docs rev: e0f4f67d5e702b6d9c9c7b77896a397221d825d8)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-12-18 13:18:55 +00:00
Simone Weiß
401bc1480a manuals: brief-yoctoprojectqs: align variable order with default local.conf
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>
2023-12-18 13:18:55 +00:00
Lee Chee Yang
ede920cb03 migration-guides: reword fix in release-notes-4.3.1
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>
2023-12-18 13:18:55 +00:00
Etienne Cordonnier
a1ae83c59b manuals: document minidebuginfo
(From yocto-docs rev: 1a6327f2d92b390248afb45119d79bb05cda3dcc)

Signed-off-by: Etienne Cordonnier <ecordonnier@snap.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-12-18 13:18:55 +00:00
Michael Opdenacker
bd8f3acd14 test-manual: add or improve hyperlinks
(From yocto-docs rev: db88611b8d80ce909afa697766123001fa4e5741)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-12-18 13:18:55 +00:00
Michael Opdenacker
d9be74b13f test-manual: explicit or fix file paths
(From yocto-docs rev: e6fd1912bdbaeb1c8e29f5d7987ee24f9def1ab7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-12-18 13:18:55 +00:00
Michael Opdenacker
98ee926e2c test-manual: add links to python unittest
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>
2023-12-18 13:18:55 +00:00
Michael Opdenacker
51c390571f test-manual: use working example
(From yocto-docs rev: 29dce8130e4de68a4690add673bca0eef17c8260)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-12-18 13:18:55 +00:00
Michael Opdenacker
3090312661 test-manual: resource updates
(From yocto-docs rev: 230523f2b834d3fdb2114956678e3003a486cebc)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-12-18 13:18:55 +00:00
Michael Opdenacker
84b242ef8b test-manual: text and formatting fixes
(From yocto-docs rev: 7c4f616f773bb9071b395e977b2ca9f8ac8f7e2a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-12-18 13:18:55 +00:00
Peter Kjellerstedt
c24e3b9f67 dev-manual: Discourage the use of SRC_URI[md5sum]
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>
2023-12-18 13:18:55 +00:00
Michael Opdenacker
e2c364a642 migration-guides: release 3.5 is actually 4.0
(From yocto-docs rev: 7107e18bfa4cf24b912df6c60d8ffb8c74152bca)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-12-01 17:45:06 +00:00
Lee Chee Yang
275240132e migration-guides: add release notes for 4.3.1
(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>
2023-12-01 17:45:06 +00:00
Michael Opdenacker
dbcc4df413 contributor-guide: fix command option
"--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>
2023-12-01 17:45:06 +00:00
Justin Bronder
9773b0c64c contributor-guide: add License-Update tag
Porting from the old wiki
https://www.openembedded.org/index.php?title=Commit_Patch_Message_Guidelines&oldid=10935#Describing_license_changes

(From yocto-docs rev: 51e55b44a4532ae16595bd5a712c34deeff5d47b)

Signed-off-by: Justin Bronder <jsbronder@cold-front.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-12-01 17:45:06 +00:00
Michael Opdenacker
5785754244 dev-manual: layers: update link to YP Compatible form
(From yocto-docs rev: bf69c60b6fafad2497d7c8de51c7e1eb85bcb756)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Megan Knight <megankn@amazon.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-12-01 17:45:06 +00:00
Lee Chee Yang
2f23231eb1 migration-guide: add release notes for 4.2.4
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>
2023-11-20 10:59:40 +00:00
Michael Opdenacker
dd67934e5f ref-manual: releases.svg: update nanbield release status
- 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>
2023-11-20 10:59:40 +00:00
Michael Opdenacker
8e1302cf2d manuals: fix URL
[YOCTO #15279]

(From yocto-docs rev: 2a5373ca928ac402a97e108ffbb4d23507dec0fd)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by:  Steve Landherr <steve-yocto@chiquapin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-20 10:59:40 +00:00
Lee Chee Yang
7031a961f2 migration-guide: add release notes for 4.0.14
(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>
2023-11-20 10:59:40 +00:00
Paul Barker
9723982ecf ref-manual: Fix reference to MIRRORS/PREMIRRORS defaults
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>
2023-11-20 10:59:40 +00:00
Lee Chee Yang
dc2f087dc9 release-notes-4.3: add Repositories / Downloads section
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>
2023-11-20 10:59:40 +00:00
Michael Halstead
abf3e54d11 docs: add support for nanbield (4.3) release
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>
2023-11-13 17:29:26 +00:00