After introducing the DISTRO_LATEST_TAG and DISTRO_REL_LATEST_TAG
macros, use them in links that currently use DISTRO/DISTRO_REL_TAG. When
building for the tip of a branch, this will replace the current A.B.999
in links to the latest existing tag.
The links were found across the documentation by running 'grep -r
"http.*5\.2\.999"' inside the _build/html output after building the
docs.
[YOCTO #14802]
(From yocto-docs rev: 29be069ebbf2c55d72fc51d99ed5a558af37c05e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Introduce the DISTRO_LATEST_TAG macro, which should always point to the
latest existing tag in the documentation, unlike DISTRO which may point
to A.B.999 to represent the tip of a branch.
This variable is needed to fix dead links in the documentation that
currently use the DISTRO macro.
Also, make DISTRO_REL_TAG use the DISTRO macro directly, to avoid
repetition, and add a DISTRO_REL_LATEST_TAG macro that has the same role
as DISTRO_LATEST_TAG but with "yocto-" prepended to it.
In set_versions.py, run the "git describe --abbrev=0 --tags
--match='yocto-*'" command to get the latest existing tag on the
currently checked out commit. Fallback to ourversion in case we didn't
find any.
(From yocto-docs rev: a85b0e500c94921f77fa7b7dbb877e4945f96d1e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The word "modern" appears twice, remove the extra one.
(From yocto-docs rev: 8a2169431551ea29bf45b2eb120a13f0e444e1ea)
Signed-off-by: Andrew Kreimer <algonell@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document changes between 1c3020f17370 ("expat: Upgrade 2.7.0 -> 2.7.1")
up to e894acce6ede ("build-appliance-image: Update to master head
revision") in Poky:
- Add a note on the devtool upgrade-status change.
- Be more precise about the usage of multiple repositories in SRC_URI,
mention that it makes sense for bare clones only.
As the walnascar branch has now frozen and is up for QA, these should be
the one of the last changes to these documents.
(From yocto-docs rev: 322355ead2be9e267368ca47d805f41ae10ad6cc)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It may be confusing for users that source control information is not
present in the BitBake environment. Document it as a warning block.
(From yocto-docs rev: 39967b9cc87cf216c4658598806fd7a68db5053a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These variables control the flags for the assembler, compiler and
linker, but depend on the context.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 8f070b788c9cd6cc16e03505d978177b4c82de03)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit f8eb33569a5e8cadc036855e2d95eee77e627cb4)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These variables control the flags for the assembler, compiler and linker
when building for nativesdk recipes.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 978300e5f14874f2586efa3474c6f3803e3d9031)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit c08f6d3c8aee86264c069b7c30850cb02de76076)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These toolchain variables are used in a native context. Some of the
BUILD_* variables missed documentation. Also, some of the base commands
were also not there so document them.
Some of existing BUILD_* variable documentation were missing the note
about their usage in a native context, so add it too so that all BUILD_*
variables are documented the same way.
[YOCTO #15719]
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: e42d49218945a030f300dbb608e7cfb0611f5733)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 87103afa1cb6690e9aaa87ca1f23e45eaaa359ac)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Use the :manpage: role to provide links to common toolchain utilities.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 8a25963c8dfc36482582294f0d2e7c7555d96399)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 7023e5f176efde05a6798476712c8a4e006a6b0d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
By defining the manpages_url we can use the :manpage: role in the
documentation for providing links to manpages. See:
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url
Replace existing manpages links to use this role.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 0d0115cb2d96960837678f775cf5c2297494c51c)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 4e63cd74cd1a330ea5e96bb04243a90f607b2857)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Address some of the reviews received on the release notes and migration
guide for 5.2:
- Remove the wget fetcher addition, I misread commit 0a9f90ff658e
("tests/fetch: support setting PV in the wget fetcher") from BitBake,
and it actually affects the tests for the wget fetcher, not the
fetcher itself.
- Add a way to transition from the branch=nameX,nameY syntax. From what
I have tested, I achieve the same behavior when using one or the other
syntax.
- Remove the default value for SPDX_PACKAGE_VERSION in the release note.
- Fix a couple of typos.
Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 39bf43a6009a46d4979337d7401eb46ece618f67)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Improve the current ptest-python-pytest documentation and
PTEST_PYTEST_DIR variable definition. Namely remove the default value
that may evolve over time.
Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: a83406103ca73d84fc8f5c50a8968faf91276a62)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since OE-Core commit 19004950ad56 ("sanity: Check if the C++ toolchain supports --std=gnu++20"),
host GCC must support "--std=gnu++20" for a Yocto build.
This option is available from 10.1.
This is related to [YOCTO #15804].
(From yocto-docs rev: 0e538c102bfcb7184c76c2401e8cb878168c4434)
Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable controls the package version as seen in the SPDX 3.0 JSON
output (software_packageVersion). The default value for this variable is
PV.
(From yocto-docs rev: 3b483c5295b26748c6f2cd63074b20ac3da97b32)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This new Grub variable controls the options passed to the grub-mkimage
command in the Grub recipe.
(From yocto-docs rev: 2e5a3c3d5199cad6fb90e0218cdd4a1779743644)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Before the 5.2 release, update the list of supported distributions to
match the SANITY_TESTED_DISTROS variable in poky.conf.
(From yocto-docs rev: 9dac392c0d834c0089c514d7ad85beeb04d1b698)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Bitbake commit 0d2e682d00df ("bitbake: lib/bb: Bump minimum python
version requirement to 3.9" -- poky commit 67566c7410e1) means that
Ubuntu 20.04 is no longer supported out-of-the-box as detailed further
in the respective commit log.
While it is true that it can still be used with buildtools, that can
also be said for nearly every other unsupported distro out there,
including Ubuntu 18.04 that we listed as unsupported some years ago.
Hence continuing to list it as supported with the new python requirement
in place does not make sense.
So we move it alongside of the 18.04 entry, into the "possibly tested,
but you get what you get" category. And add an explicit mention of the
buildtools, so people have a thread to pull on.
(From yocto-docs rev: b1c09003dc304b1e65044f343fb341aaed58e6f3)
Signed-off-by: Paul Gortmaker <paulg@kernel.org>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This should be clearly mentioned in the BitBake section as it is an
valuable addition to 5.2.
(From yocto-docs rev: 62e0fd7ec9581918935b44427326ae74991bd72a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add security fixes by going through the log between yocto-5.1 and
walnascar branch tip on Poky.
(From yocto-docs rev: 3c895f4188b8c7aaa87198a8bf85776f545ee6a9)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document LICENSE changes between the 5.1 and 5.2 release.
Extracted for commits message containing the "License-Update:" field in
Poky, between tag yocto-5.1 and walnascar.
(From yocto-docs rev: 725135799c4d3ba117376df230be4a1603779121)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes since 87d7341465f8 ("python3-iniparse: remove recipe") up to
9cd6b3ad8b9b ("cronie: Resolve build failure with GCC15") in Poky.
(From yocto-docs rev: ea1636013722c12e72ca115240c8ce533e05ece2)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes since 87d7341465f8 ("python3-iniparse: remove recipe") up to
9cd6b3ad8b9b ("cronie: Resolve build failure with GCC15") in Poky.
(From yocto-docs rev: c20001db2544c7d1c3cd9a34f629f452a2f3029d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Original patch by Ross Burton:
https://lists.yoctoproject.org/g/docs/message/6466
Moved to the migration manual as it is potentially a breaking change.
Co-developed-by: Ross Burton <ross.burton@arm.com>
(From yocto-docs rev: 9b795ad8fdeadf17f08e03eedc93bc922a2d5736)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document the AUTOTOOLS_SCRIPT_PATH and the CONFIGURE_SCRIPT variables.
(From yocto-docs rev: b3964a89fd6a5f19a8f45f9b46e8eaa8b8bff38e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable allows choosing the CVE feed when using the cve-check
class.
(From yocto-docs rev: 639ea86c5034d7706faf14a2ff52b603c3ccd905)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable can be used to add install tags to the 'meson install'
command.
(From yocto-docs rev: 72b502cfb67345cda17bc2ae7af222b7cecb9a0c)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable controls the RuntimeWatchdogSec option in
/etc/systemd/system.conf.
(From yocto-docs rev: 6d6b638ee94c3ba36a02ef2289bf246392d8c854)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable affects the watchdog-config recipe, not the watchdog
recipe.
(From yocto-docs rev: d3350c38910c47c76ed17f24579120013589ca1f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add documentation for the ptest-python-pytest class, and the
PTEST_PYTEST_DIR variable which can be overriden.
(From yocto-docs rev: 1abee62c2b9f32dfa42782893940f211db930b4c)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add how to enable ATF, TEE and User defined ITS for U-Boot FIT image generation.
(From yocto-docs rev: ee6b3698da044e290dbc4fbb852f3cc37638e689)
Signed-off-by: Jamin Lin <jamin_lin@aspeedtech.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add an entry to the known issue as the NVD is not up-to-date, the
impact on current CVE reports and future plans for the Yocto Project.
Follows the discussion on:
https://lists.openembedded.org/g/openembedded-core/message/212446
(From yocto-docs rev: c83aa6649fb7bca7e6b393356c8268aa4f18dc4b)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Incorporate the lessons learned from a regression introduced with commit
OE-Core rev: 259bfa86f384206f0d0a96a5b84887186c5f689e
u-boot: kernel-fitimage: Fix dependency loop if
UBOOT_SIGN_ENABLE and UBOOT_ENV enabled
and fixed with commit
OE-Core rev: 0106e5efab99c8016836a2ab71e2327ce58a9a9d
u-boot: kernel-fitimage: Restore FIT_SIGN_INDIVIDUAL="1"
behavior
into the documentation.
The use of the variable FIT_SIGN_INDIVIDUAL is explicitly discouraged.
(From yocto-docs rev: d34e1d4e3f229bcd6560fe7df544869b0cd9875f)
Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Mention that UNPACKDIR is used as a location to unpack the source code,
and that S is the final location of the source code. This is
deliberately vague, because as there are multiple instances of how these
directories can be defined and used.
The proper explanation of how the UNPACKDIR and S directories interact
is left to the reference manual, under the UNPACKDIR variable
description.
(From yocto-docs rev: 76361ae37bd45c9ce5190fb6c7c400bf2fc14003)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
PR was removed by cc83e4548465 ("bitbake.conf: Drop PE and PR from
WORKDIR and STAMP") on OE-Core.
(From yocto-docs rev: 569c707c69a7a858553e40b26cb36db18f2a42fc)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Convert the png file to an SVG file
- Add the UNPACKDIR reference.
- Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf:
Drop PE and PR from WORKDIR and STAMP") on OE-Core.
- Change S value to BP (equal to ${BPN}-${PV}, but more accurate).
(From yocto-docs rev: 6fd6af3ea9e556e481cc3c0358c0357b6060798f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Convert the png file to an SVG file
- Add the UNPACKDIR reference.
- Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf:
Drop PE and PR from WORKDIR and STAMP") on OE-Core.
- Change S value to BP (equal to ${BPN}-${PV}, but more accurate).
(From yocto-docs rev: f24b00200ac49cda07e4c77e3e1b161a5b78b006)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
