Commit Graph

6879 Commits

Author SHA1 Message Date
Antonin Godard
3ed2348227 set_versions.py: use backward-compatible python argument in run
Some workers on the autobuilder reported the following error:

  File "./set_versions.py", line 102, in <module>
    subprocess.run(["git", "show", "yocto-%s" % release_series[activereleases[0]]], capture_output=True, check=True)
  File "/usr/lib64/python3.6/subprocess.py", line 423, in run
    with Popen(*popenargs, **kwargs) as process:
  TypeError: __init__() got an unexpected keyword argument 'capture_output'

See https://valkyrie.yoctoproject.org/#/builders/34/builds/86.

This is because capture_output was introduced in Python 3.7, and some of
the support distributions are still on Python 3.6. Since capture_output
is essentially just setting stdout and stderr to PIPE
(https://github.com/python/cpython/blob/3.13/Lib/subprocess.py#L547), do
it manually here to be compatible with older python versions.

This is also the case for the "text" parameter, introduced in 3.7 to
alias the universal_newlines parameter. Use "universal_newlines" to be
backward-compatible.

[ YOCTO #15687 ]

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Tested-by: Quentin Schulz <quentin.schulz@cherry.de> # openSUSE Leap
(From yocto-docs rev: 28850c974a3896895bc921c094071523218d6d07)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-20 12:47:59 +00:00
Michael Opdenacker
991b68a00c dev-manual/bmaptool.rst: simplify and fix instructions
- Remove duplicate instructions

- Detail how to run bmaptool directly if you installed it on your host
  instead of building it through the ``bmaptool-native`` recipe,
  as running "oe-run-native bmaptool-native bmaptool ..." won't work
  in this case.

- Use "chmod a+w" instead of "chmod 666", better advice,
  and only run "chmod" in the option that runs "oe-run-native"

(From yocto-docs rev: 4afa71ef6e5bf1db126c80e6d987f588d0b5a086)

Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-20 12:47:59 +00:00
Michael Opdenacker
df98d305de dev-manual/bmaptool.rst: correct command for bmaptool-native
Using only "bitbake bmaptool-native", running "oe-run-native bmaptool-native bmaptool ..."
fails as follows:

Error: Have you run 'bitbake bmaptool-native -caddto_recipe_sysroot'?

Running the "bitbake bmaptool-native -caddto_recipe_sysroot" target
is actually sufficient.

(From yocto-docs rev: 72fe904a3bbb5e2c7279ab1f119c2beca200dcf2)

Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-20 12:47:59 +00:00
Michael Opdenacker
6e09a26641 dev-manual: fix styling of references to bmaptool
To follow the styling conventions when we are
refering to the name of a tool instead of the command itself
(documentation/standards.md).

This also improves the HTML rendering of the bmaptools subsection.

(From yocto-docs rev: c569d840c4b6f43e10629b6f1ff45189211e27a9)

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

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

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

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

(From yocto-docs rev: ee16c96202e5027d1a8d7e89e11c25f127c78326)

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

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

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

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

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

(From yocto-docs rev: 02c090718ac602f7d4760dd28dadbf0631668d49)

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

(From yocto-docs rev: c9c3f6896e4bc967a9b394574532735babb70397)

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-16 11:04:53 +00:00
Antonin Godard
36cc210fb9 poky.yaml.in: replace inkscape dependency by librsvg2-bin
inkscape used to be a requirement to convert SVG images to PNGs/PDFs,
but we replaced it recently by rsvg-convert.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-16 11:04:53 +00:00
Antonin Godard
3aadcdf74c poky.yaml.in: add missing locales dependency
This is a requirement for building the documentation, otherwise we get
(on Ubuntu 24.04):

     File "/usr/lib/python3.12/locale.py", line 615, in setlocale
       return _setlocale(category, locale)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   locale.Error: unsupported locale setting

(From yocto-docs rev: 0943a7b67ef0012b5d9badc15e0c579dbb9014ae)

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

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

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

(From yocto-docs rev: 1ed6118b7cf1b5dcbfca753c83fa30fb97bf44ad)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-16 11:04:53 +00:00
Lee Chee Yang
8f4afc7e15 migration-guides: add release notes for 5.1.1
(From yocto-docs rev: db2ff7bbe64e1dca6b0868046f478d7622f79865)

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

(From yocto-docs rev: 30002019198a168e48537407bb928facb26af82a)

Signed-off-by: Guénaël Muller <guenael.muller@smile.fr>
Reviewed-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Tested-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-16 11:04:53 +00:00
Lee Chee Yang
be11cb2979 migration-guides: add release notes for 4.0.23
(From yocto-docs rev: 5835cb574881d57785f099c768467177d077e867)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-29 18:25:35 +00:00
Antonin Godard
4a90571c57 ref-manual: classes: fix bin_package description
The previous bin_package description was confusing: it would instruct to
use the git fetcher to extract the content of an RPM package using the
`subpath` option - but that's not possible as the git fetcher can be
used to clone a repository but not to do the extraction.

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

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

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

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

(From yocto-docs rev: fd46074dc7bba49ab49c706c408c92958e67cfa4)

Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-29 18:25:35 +00:00
Lee Chee Yang
371f4b7941 migration-guides: add release notes for 5.0.5
(From yocto-docs rev: 4175839e718db49bf6971e900c1cf176d03458d7)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-29 18:25:35 +00:00
Alexander Kanavin
9fe2d71754 migration-guides: document ZSTD_COMPRESSION_LEVEL change
(From yocto-docs rev: 6dcc70c4fa780d8531c58bd7886d6f8b602c10af)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-22 16:56:03 +00:00
Alexander Kanavin
9620944507 ref-manual: document ZSTD_COMPRESSION_LEVEL
(From yocto-docs rev: ca3cbe1bac3261fd01aeb1afdca98fbe283e9ac7)

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

(From yocto-docs rev: b64fb34643343b364705df9c3bd64af91ed9d687)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-22 16:56:03 +00:00
Lee Chee Yang
a11bc1d320 migration-guides: add release notes for 5.0.4
(From yocto-docs rev: bf1077eb1b215ded502a61876eb071c21b21c4ec)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-22 16:56:03 +00:00
Antonin Godard
129756e664 standards.md: add a section on admonitions
We try to limit our usage of these admonitions to `note` and `warning`,
as the Sphinx documentation warns that most themes only style these two
admonitions. So add a section on that.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-22 16:56:03 +00:00
Antonin Godard
b9b59b5a8b dev-manual: bblock: use warning block instead of attention
Sphinx recommends using warning and note here:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-15 11:16:58 +00:00
Antonin Godard
adc323dd4d dev-manual: document how to provide confs from layer.conf
Add a section on providing global level configuration from the
layer.conf file. Since this file is parsed at an earlier stage in the
parsing process, it's not possible to combine bb.utils.contains and
{DISTRO,MACHINE}_FEATURES to conditionally set some configurations.

This patch documents:

- First that this file can be used for providing such configuration.
- Then demonstrate how to conditionally provide them, using a technique
  that is currently used in meta-virtualization
  (https://git.yoctoproject.org/meta-virtualization/tree/conf/layer.conf#n50).

Fixes [YOCTO #12688].

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-15 11:16:58 +00:00
Antonin Godard
4fe8cc4f82 conf.py: add a bitbake_git extlink
To make references to the bitbake repo, add an extlink for it and use it
in the docs with ":bitbake_git:`lib/bb/utils.py </tree/lib/bb/utils.py>`".

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-15 11:16:58 +00:00
Antonin Godard
b8a6e17a4e migration-guides: add placeholder files for next release
Placeholder files for release 5.2 (Walnascar): migration guide and
release notes.

Define two substitutions |yocto-ver| and |yocto-codename| to avoid
mistakes in the document. Note that anchors cannot contain these so
add a note on that in a comment.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-15 11:16:58 +00:00
Antonin Godard
fd5f84556f migration-guides: 5.1: fix titles
- fix title underline
- add anchor for workdir changes
- supported-kernel-versions was misplaced, move it
- "Miscellaneous changes" anchor was wrong

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-15 11:16:58 +00:00
Antonin Godard
a0f93fed3a sphinx-static/switchers.js.in: do not refer to URL_ROOT anymore
This variable was removed from the Sphinx-generated
documentation_options.js, thus breaking the current implementation of
our switchers.js. Like searchtools.js, which is also generated by
Sphinx, use document.documentElement.dataset.content_root as a
replacement.

To be backwards-compatible to get one or the other.

(From yocto-docs rev: 13caec1386708d8609dff5f42956d2329a074f37)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-12 11:09:51 +00:00
Antonin Godard
b5cb33f1f4 doc: add a download page for epub and pdf
These files are placed in the _static directory during publish. Note
that Sphinx does not complain if files do not exist during compilation
(since they are copied at the end). This is why this was used instead of
the ":download:" role.

(From yocto-docs rev: 3b9287eb5cde22cf5be48734d63efbd30c66ef06)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-12 11:09:51 +00:00
Michael Opdenacker
c2fb606502 doc: Makefile: publish pdf and epub versions too
Copy the generated files in the special _static directory.

Fixes [YOCTO #14357]

(From yocto-docs rev: b60c5b86eaef5ddab026837e0952a28c7948bc2d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-12 11:09:51 +00:00
Antonin Godard
06f00545ff doc: Makefile: add support for xelatex
This patch makes the "latexpdf" target compile the documentation with
xelatex instead of the default pdflatex engine.

The reason behind this is stated in [YOCTO #14357]: pdflatex does not
support compiling foreign characters, so we need to resort to another
engine, here xelatex.

It also increases the texmf config buf_size to 10000000 to avoid a
compilation error.

(From yocto-docs rev: bd6265ca323fac547a197bb516dc4a9ef3897508)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-12 11:09:51 +00:00
Antonin Godard
677f218df5 doc: Makefile: remove inkscape, replace by rsvg-convert
Remove inkscape as it is not part of meta/, and use librsvg so we can
ship it in a buildtools tarball for the autobuilder workers.

(From yocto-docs rev: 2d92de35e0029bf151c9a0c0e696a127cef14082)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-12 11:09:51 +00:00
Talel BELHAJSALEM
4cae0cb47f contributor-guide: Remove duplicated words
Remove "and then" as it is duplicated.

(From yocto-docs rev: 90666b8c85fe6afaf102034ebcd5d25d8391e697)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-12 11:09:51 +00:00
Julien Stephan
78f25d9a9c dev-manual: add bblock documentation
bblock is a helper tool to lock/unlock tasks and recipes to specific
signatures. Add a documentation page for it.

(From yocto-docs rev: a082aa39840587d3af6c3f4a2c2747564ca37414)

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

(From yocto-docs rev: 32e3995bed2836f549866ec3b8ad254bdda37dbf)

Signed-off-by: Julien Stephan <jstephan@baylibre.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-07 10:12:24 +00:00
Julien Stephan
41cb3db3e2 styles: vocabularies: Yocto: add sstate
Add sstate as an accepted word to avoid errors when runnign make
stylecheck.

(From yocto-docs rev: 1c50726296e876747ea3f862729e953f025ce619)

Signed-off-by: Julien Stephan <jstephan@baylibre.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-07 10:12:24 +00:00
Julien Stephan
304312bd8c 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: 3dfe7b5c746af31de74f67cf88214e5d52bdb65d)

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>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-07 10:12:24 +00:00
Julien Stephan
7d88e832b5 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: 262237f72534c983e178231cb6839ed69709c443)

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>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-07 10:12:23 +00:00
Lee Chee Yang
965231995e release-notes-5.1: add download section
(From yocto-docs rev: bb472a7000672ce836573c3f2d3baf42cca01546)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-07 10:12:23 +00:00
Antonin Godard
7748c7aa32 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' {} \+

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>
2024-11-07 10:12:23 +00:00
Steve Sakoman
4a41babc17 release-notes-4.0: update BB_HASHSERVE_UPSTREAM for new infrastructure
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>
2024-10-31 14:24:24 +00:00
Antonin Godard
f16dc3705a ref-manual: devtool-reference: document missing commands
Give a brief description for important commands that made it into
devtool or that were missing from this quick reference document.

(From yocto-docs rev: 6238adae1b072c9e09c558038d397dfac6ec109f)

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

(From yocto-docs rev: 1c83037707b4c981a70c968ba04ded502f9bffbf)

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

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

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

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

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-31 14:24:24 +00:00
Antonin Godard
11b1577a15 docs: update current releases
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>
2024-10-31 14:24:24 +00:00
Lee Chee Yang
de1fa1e0b0 migration-guide: add release notes for 4.0.22
(From yocto-docs rev: 9563855ccd92e21fb6f8320c96a3a83e115c947e)

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>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-25 15:31:57 +01:00
Antonin Godard
ee328fe0bc 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: afeded9939777d88bf4cb9ebf7a61aadd476642d)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-25 15:31:57 +01:00
Antonin Godard
e2f65cb9b1 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: aa9a580c8c57af4baa4fb24a43487fb7afc258e5)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-25 15:31:57 +01:00
Antonin Godard
201c4d7ecd 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: 2466a5e7973bf6e724f1cf0b42f838065847d283)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-25 15:31:57 +01:00
Niko Mauno
d5fe0e293b ref-manual: Sync variables letter index
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>
2024-10-25 15:31:57 +01:00
Antonin Godard
223ae08bc6 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: 143c3cacdec36c9d7ab81c89bbcc12c0c3936bd9)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-25 15:31:57 +01:00
Antonin Godard
a20bbe1123 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: 372b5b4ca55819c294970b20aa8b8d8167144329)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-23 12:28:40 +01:00
Antonin Godard
5c46d03ea8 release-notes-5.1: add beaglebone-yocto parselogs test oeqa failure
The beaglebone-yocto currently fails the parselogs runtime test. For
details see: https://bugzilla.yoctoproject.org/show_bug.cgi?id=15624

Reported-by: Ross Burton <Ross.Burton@arm.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 295e45d17658c8f47a87163be7fc7b6327c3fa4c)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-23 12:28:40 +01:00
Niko Mauno
bf4f76d4d1 docs: Replace VOLATILE_TMP_DIR with FILESYSTEM_PERMS_TABLES
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>
2024-10-23 12:28:40 +01:00
Niko Mauno
58fa363b96 docs: Replace VOLATILE_LOG_DIR with FILESYSTEM_PERMS_TABLES
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>
2024-10-23 12:28:40 +01:00
Robert Yang
581f498489 release-notes-5.0.rst: NO_OUTPUT -> NO_COLOR
(From yocto-docs rev: ac4c4455d40dc0852d95461a3a10d687d2aedd6e)

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>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-23 12:28:40 +01:00
Antonin Godard
57127f6520 ref-manual: fix ordering of insane checks list
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>
2024-10-23 12:28:40 +01:00
Antonin Godard
4ba72b6b34 release-notes-5.1: fix spdx bullet point
(From yocto-docs rev: c3bcbd847779afe78ff7e4345c9a5c61b3321975)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Reported-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-23 12:28:40 +01:00
Antonin Godard
494983bc92 release-notes-5.1: update release note for styhead
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>
2024-10-11 17:05:04 +01:00
Lee Chee Yang
49d98fab62 release-notes-5.1: update for several section
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>
2024-10-11 17:05:04 +01:00
Antonin Godard
c772c2b278 ref-manual: add mission pep517-backend sanity check
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>
2024-10-11 17:05:04 +01:00
Antonin Godard
118fce004d 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: 300c585909743754e0e6662d48d43834c031b835)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-11 17:05:04 +01:00
Antonin Godard
ab2dd7c28c ref-manual: add missing variable PRSERV_UPSTREAM
(From yocto-docs rev: 94a590aad8d503c5d5528bff4d8ec07746ca9805)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-11 17:05:04 +01:00
Antonin Godard
5f807a4b80 ref-manual: add missing OPKGBUILDCMD variable
(From yocto-docs rev: a6a2c8e48995200c9c3be7096f34d912427de145)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-11 17:05:04 +01:00
Antonin Godard
1e54a97da5 ref-manual: drop TCLIBCAPPEND variable
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>
2024-10-11 17:05:04 +01:00
Antonin Godard
1d8284da56 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: 6566ffceab3780dc5ecbfe26f786ebe6ff17e693)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-11 17:05:04 +01:00
Antonin Godard
d3a55ef7f3 ref-manual: add missing image manifest variables
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>
2024-10-11 17:05:04 +01:00
Antonin Godard
9ad863b8a2 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: 2537642d2cdf844dc5f6027fb3097aac52162c1f)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-11 17:05:04 +01:00
Antonin Godard
f1104a323d ref-manual: drop siteconfig class
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>
2024-10-11 17:05:04 +01:00
Antonin Godard
a4f4d35cb5 ref-manual: add new RECIPE_UPGRADE_EXTRA_TASKS variable
(From yocto-docs rev: c80bc42afa40fd9eb5acaba24da3ad3b5915a254)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-11 17:05:04 +01:00
Antonin Godard
ec61c09e0c ref-manual: add missing nospdx class
(From yocto-docs rev: ec41a5bf1a49e5d83bb93a3438ba1cd01f613088)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-11 17:05:04 +01:00
Antonin Godard
37ebf54d1c ref-manual: add new retain class and variables
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>
2024-10-11 17:05:04 +01:00
Antonin Godard
7b717c7e2a ref-manual: add new vex class
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>
2024-10-11 17:05:04 +01:00
Antonin Godard
0116a35c40 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: 14131a42a7ea8bbae2165c1b8dbcabd5f28b2b22)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-11 17:05:04 +01:00
Yoann Congal
b425ab56d3 release-notes-5.1: document spirv-tools reproducibility
This covers Poky's commits
47ed8ac83a (spirv-tools: Fix git-describe related reproducibility, 2024-08-03)
a19bb8c1d5 (spirv-tools: Update merged patch to backport status, 2024-09-05)

(From yocto-docs rev: 98e7f378bc5670d23a6c2bdfcd3b7af965f7c450)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-09 14:03:53 +01:00
Yoann Congal
eb32cf01f9 release-notes-5.1: document fixed _test_devtool_add_git_url test
This covers Poky's commits:
3c05286fa1 (oeqa/selftest/devtool: fix _test_devtool_add_git_url, 2024-04-26)
268dfbd949 (Revert "oeqa/selftest/devtool: fix test_devtool_add_git_style2", 2024-04-26)

(From yocto-docs rev: 8c4efab8f9baf1e8b11232dc8438ab7c103a9a40)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-09 14:03:53 +01:00
Yoann Congal
f311e797f1 release-notes-5.1: document added python3-libarchive-c ptest
This covers Poky's commit
c01e633ab9 (python3-libarchive-c: add ptest, 2024-08-02)

(From yocto-docs rev: 94126f6f5526b460ebd5ce548ad0aa83dbc1eeaa)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-09 14:03:53 +01:00
Yoann Congal
6cbfb582ef migration/release-notes-5.1: document oeqa/selftest envvars change
This covers the Poky commit:
61186bc98a (oeqa/selftest: Only rewrite envvars paths that absolutely point to builddir, 2024-09-10)

(From yocto-docs rev: 59bfb63af0913ad69ae36691436af96d63dd657b)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-09 14:03:53 +01:00
Lee Chee Yang
38b6b7286a migration-guide: add release notes for 4.0.21
(From yocto-docs rev: bbe2ae02d01ffd962e0a7086c9e08a0e205c1728)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-09 14:03:53 +01:00
Jörg Sommer
f8907dc10c doc/features: describe distribution feature pni-name
(From yocto-docs rev: c32b55b3403dcfd76a4694ff407d4b513e14c8f4)

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: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-09-20 10:39:40 +01:00
Jörg Sommer
8149e74258 doc/features: remove duplicate word in distribution feature ext2
(From yocto-docs rev: 20a5986ec3395f83e8469b08dd79f019e2051626)

Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-09-20 10:39:40 +01:00
Lee Chee Yang
9e6030e4a5 migration-guides: add release notes for 5.0.3
(From yocto-docs rev: cf811228d7d25ad7136e24e7c6b9dcd39ca43610)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-08-22 13:48:58 +01:00
Peter Kjellerstedt
7d0ac795ba test-manual: Add a missing dot
Correct "oeqa.utils.commandsrunCmd()" to "oeqa.utils.commands.runCmd()".

(From yocto-docs rev: 4ecdfd0000308a71697abc099ed6e37af907051d)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
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>
2024-08-22 13:48:58 +01:00
Jan Vermaete
49a934e585 ref-manual: added wic.zst to the IMAGE_TYPES
(From yocto-docs rev: da5c0dae1101aae2db15f9f91c980e26c74eb739)

Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
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>
2024-08-22 13:48:58 +01:00
Lee Chee Yang
f2c8b7e31c migration-guide: add release notes for 4.0.20
(From yocto-docs rev: f81623d34a864801075167890d64ee9152ea0c3c)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-08-22 13:48:58 +01:00
Matthias Pritschet
48c6bc2572 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: 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>
2024-08-22 13:48:58 +01:00
Jon Mason
25a6edd381 docs: modify reference from python2.py to python.py
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>
2024-07-09 15:48:55 +01:00
Jörg Sommer
9acacfb264 ref-manual: add DEFAULT_TIMEZONE variable
(From yocto-docs rev: 89323e4d95c7e98c685ad2843f037a291af08b02)

Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
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>
2024-07-09 15:48:55 +01:00
Lee Chee Yang
3be34141ec migration-guides: add release notes for 5.0.2
(From yocto-docs rev: 71af3b43038f04ea35b554dcdb101ce2dd4bca78)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-07-09 15:48:55 +01:00
Lee Chee Yang
6dd76da905 migration-guides: add release notes for 4.0.19
add release notes for 4.0.19.

(From yocto-docs rev: ffbefbabb9b50720fec29d30335c58e190e90f16)

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: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-07-09 15:48:55 +01:00
Tim Orling
41780c62d2 ref-manual: add RECIPE_UPDATE_EXTRA_TASKS variable
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>
2024-06-16 22:49:21 +01:00
Michael Opdenacker
5020a0f560 documentation/README: refer to doc package requirements
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>
2024-06-16 22:48:18 +01:00
Aleksandar Nikolic
9ece314372 ref-manual: introduce CVE_CHECK_REPORT_PATCHED variable
(From yocto-docs rev: f585a68a8f35f31814e408dd973ea7345adbbacf)

Signed-off-by: Aleksandar Nikolic <an010@live.com>
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>
2024-06-16 22:48:18 +01:00
Jasper Orschulko
5d737bf584 dev-manual: Add info on build env initialization
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>
2024-06-16 22:48:18 +01:00
Alexandre Truong
0df9d22928 recipe style guide: add recommendation for patches without signature
>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>
2024-06-16 22:48:18 +01:00
Yoann Congal
8fc967d0c7 migration-5.1: add the recommended pattern for S/UNPACKDIR definition
(From yocto-docs rev: 9fb708986cb9019062078f8a34288c44f2667dbd)

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-05-29 20:58:49 +01:00
Lee Chee Yang
cad8556566 migration-notes: add release notes for 5.0.1
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>
2024-05-29 20:58:49 +01:00
Michael Opdenacker
bebe947dd5 migration-5.1.rst: preliminary description of UNPACKDIR changes
(From yocto-docs rev: ac7a35edbd20ba2d1789ff77b53484ad34cc0850)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-05-29 20:58:49 +01:00
Michael Opdenacker
c3d154813b ref-manual: introduce UNPACKDIR variable
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>
2024-05-29 20:58:49 +01:00
Michael Opdenacker
90e510aee7 migration-guides: placeholder files for 5.1
(From yocto-docs rev: f3ab2c5ec975683383cd8129a607c3e1e8c68053)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-05-29 20:58:49 +01:00
Trevor Gamblin
e35c8d53fb ref-manual: variables: document PYPI_PACKAGE_EXT, PYPI_SRC_URI
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>
2024-05-29 20:58:49 +01:00
Noe Galea
66aac2588d manuals: document NVDCVE_API_KEY variable
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>
2024-05-29 20:58:49 +01:00
Lee Chee Yang
b392401b46 release-notes-4.0.18: specify backported license
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>
2024-05-29 20:58:49 +01:00
Quentin Schulz
13078ea23f 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: 9a14157c4d723da0970cfd4bbb2c9500d3e692e0)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-05-09 11:57:14 +01:00
Michael Opdenacker
5df41be683 ref-manual: update releases.svg
- 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>
2024-05-09 11:57:14 +01:00
Lee Chee Yang
639104796b release-notes-5.0: update Repositories / Downloads section
(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>
2024-05-09 11:57:14 +01:00
Lee Chee Yang
730072c7cf migration-notes: add release notes for 4.0.18
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>
2024-05-09 11:57:14 +01:00
Alexander Kanavin
fd1ea6a600 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: 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>
2024-05-09 11:57:14 +01:00
Richard Purdie
0e163082bd brief-yoctoprojectqs: Update to the correct hash equivalence server address
Also add a note about needing python websockets installed.

(From yocto-docs rev: 9c7869b95b1784f58f0a31f7c015ad3e15af34e1)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-05-02 17:07:13 +01:00
Michael Halstead
e172625639 docs: add support for scarthgap 5.0 release
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>
2024-05-01 23:00:34 +01:00
Lee Chee Yang
ecaf4e14b3 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:22:55 +01:00
Michael Opdenacker
05d54880e4 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:22:55 +01:00
Paul Eggleton
30d5b6f7dd 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:22:55 +01:00
Paul Eggleton
34a67fc165 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:22:55 +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
Michael Opdenacker
6806bd2349 migration-guides: fix empty sections
(From yocto-docs rev: 897d5017eae6b3af2d5d489fc4e0915d9ce21458)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:28 +00:00
Michael Opdenacker
0593fd3416 ref-manual: classes: explain cml1 class name
(From yocto-docs rev: 0ee4b7417087c105a4419b316c6b2c195c343f82)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Martin Jansa <martin.jansa@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:28 +00:00
Paul Eggleton
9f966b15f8 migration-4.3: additional migration items
Add the following:

* Removed recipes
* One removed class
* Output file name changes
* Versioning changes
* tunctl removal

(From yocto-docs rev: 72114088bc9be184aab7b55087ea97a32a65cd6d)

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>
2023-11-06 22:52:28 +00:00
Paul Eggleton
99926a4052 migration-4.3: adjustments to existing text
* 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>
2023-11-06 22:52:28 +00:00
Paul Eggleton
fe98b96022 migration-4.3: remove some unnecessary items
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>
2023-11-06 22:52:28 +00:00
Paul Eggleton
042610fe4a release-notes-4.3: feature additions
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>
2023-11-06 22:52:28 +00:00
Paul Eggleton
610a4030ba release-notes-4.3: move new classes to Rust section
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>
2023-11-06 22:52:28 +00:00
Paul Eggleton
10e7cdea5b release-notes-4.3: remove the Distribution section
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>
2023-11-06 22:52:28 +00:00
Paul Eggleton
dee87ea100 release-notes-4.3: add CVEs, recipe upgrades, license changes, contributors
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>
2023-11-06 22:52:28 +00:00
Paul Eggleton
268710be0a release-notes-4.3: tweaks to existing text
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>
2023-11-06 22:52:28 +00:00
Paul Eggleton
66fa00b224 release-notes-4.3: fix some typos
(From yocto-docs rev: 3c98d2a1bc023aed75261ed7f4e18977b587d2f0)

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>
2023-11-06 22:52:27 +00:00
Paul Eggleton
7a026c41aa ref-manual: remove semicolons from *PROCESS_COMMAND variables
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>
2023-11-06 22:52:27 +00:00
Paul Eggleton
27949b33b7 ref-manual: update SDK_NAME variable documentation
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>
2023-11-06 22:52:27 +00:00
Paul Eggleton
736705804b Remove references to apm in MACHINE_FEATURES
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>
2023-11-06 22:52:27 +00:00
Michael Opdenacker
1b37c60493 bsp-guide: bsp.rst: update beaglebone example
(From yocto-docs rev: 8fb31b507c37d2c11e9dc98559bd7d145e1dce04)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
BELHADJ SALEM Talel
5abd1e1945 overview-manual: concepts: Add Bitbake Tasks Map
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>
2023-11-06 22:52:27 +00:00
Marta Rybczynska
1081a2617a dev-manual: extend the description of CVE patch preparation
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>
2023-11-06 22:52:27 +00:00
Ross Burton
7d6a77ce37 migration-guides: git recipes reword
(From yocto-docs rev: 9ef7cfd47a53ed45f3d0db8534a42cefbfdf63b3)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
553256bc8b migration-guides: packaging changes
(From yocto-docs rev: 7558c99f50f4d96e12299a5b3c1059a71281a475)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
d95d236add migration-guides: add BitBake changes
(From yocto-docs rev: c719d78cc9d7fb5092d2f5d0285b3eea9ad8acfe)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
589c1d85dc migration-guides: add utility notes
(From yocto-docs rev: ba0dcf57944058d9d5f2f791d463c72098c49561)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
9e10ca8159 migration-guides: add testing notes
(From yocto-docs rev: cd71d0406c96b44cc872f9eb4c8604bcdd62fed6)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
8ceb2bf960 migration-guides: enabling SPDX only for Poky, not a global default
(From yocto-docs rev: fae0b4af717602d04e06d8619389d6b50e0e8e2d)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
bb54a9a7dd migration-guides: remove SERIAL_CONSOLES_CHECK
(From yocto-docs rev: 364f8c17ba380107b2d837e17403307c3e04477c)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
8f860dc46c migration-guides: add kernel notes
(From yocto-docs rev: 45b67c5a37d560738037478b28cb7eb3d2f8e966)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
54d900ab6d migration-guides: mention CDN
(From yocto-docs rev: b7efe7984f9bd62891dc72a6763a6a5935454fdf)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
d2ca69cbbf migration-guides: mention LLVM 17
(From yocto-docs rev: 64099ca9b89dd74df7b3a6a287b95a5a317cf916)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
f00da52ca3 migration-guides: remove non-notable change
(From yocto-docs rev: 7e6276993fa3ce9c87e4d7945f140f381a99a902)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
8eea2e1948 migration-guides: QEMU_USE_SLIRP variable removed
(From yocto-docs rev: f50e9fe501ccafd18ed2d8a9e505be503a721846)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00