This adds support for marking releases as obsolete to make the
detection algorithm smarter (in a later commit) than just checking if
it's older than dunfell.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 6f40ef56054ecbd3d8b7310d748c1af78a689add)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since commit f2b069be8c307 "set_versions: Various improvements", an
outdated version will always appear in all_versions, meaning there'll
always be an exact match in the loop (just above the git context of this
patch) so there's no need to add the current_version to the dropdown
menu manually.
This issue showed up only for outdated versions of obsolete releases,
e.g. 3.2.3. In that case, 3.2.4 (latest version of the obsolete release)
will appear in the all_versions array in addition to 3.2.3, which means
the check on release series (3.2) will be matched twice, and 3.2.3 will
be printed once in the 3.2.4 loop because version != current_version and
once in the 3.2.3 because it is an exact match to an entry in
all_versions.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 05065fa1f3855e8b7d9e8af0502b4ae402273400)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the docs to reflect that kirkstone is 4.0, not 3.5.
(From yocto-docs rev: a6f571ad5b087385cad8765ed455c4b4eaeebca6)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Otherwise rendered as "en" dashes by sphinx, for example:
git pull –rebase
instead of
git pull --rebase
Readers could confuse them with normal dashes.
Exception: replace by \-\- in italic text (*text*)
as Sphinx cannot nest italic and quoted text.
For consistency, also update quoting in strings in the same code hunks.
(From yocto-docs rev: 4e7ce372e37f76148f623a5295a15e08bc2603ff)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add the list of renamed and removed variables, show how the renaming
script works. Also mention the change in cve-check output.
(From yocto-docs rev: a0b55789035c8d44426b6ff8267b4042ef0a58ba)
Signed-off-by: Marta Rybczynska <marta.rybczynska@huawei.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The AVAILABLE_LICENSES variable has been removed from OE-Core.
(From yocto-docs rev: dd687b10e1a21222e8dcc3be29635fd3200a205b)
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>
Add new PEP517_* variables, remove obsolete variables, and update for
renamed classes.
(From yocto-docs rev: 3984d4d0804125ba6fba7bf712edb81f97b4bec7)
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>
I believe we should only be showing the "active" versions in the switchers
base list of releases to show. Zeus and warrior are old and no longer actively
maintained and we don't suggest new users use them. gatesgarth is also
outside it's support window.
I therefore propose removing these leaving us with dev, honister, hardknott,
dunfell (LTS). In addition, any release that is selected will be shown, along
with any later release in that release series.
People can still navigate to the older docs using the releases list or by
direct URL but this highlights to users which releases we'd expect/encourage
them to be using.
(From yocto-docs rev: 5bcd6a632ba2ebace9c65fe8529f8f1de40226ce)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Build scripts now only require updates in master.
(From yocto-docs rev: af6a15e376733727eb26c9c2a6b6a85f6faea437)
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Correct the previous commit since we need to compare against ourseries
rather than ourbranch since devbranch would match against the series,
not the branch.
(From yocto-docs rev: 57f5ce5fe427e5387f6ac85225137463e51e5643)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev branch is being displayed in switchers under two different
headings, 4.0.999 and dev (4.0). Add an additional conditional to fix that.
(From yocto-docs rev: 569815ac290f53a17330e53fb46c4870d8d247d2)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I believe we should only be showing the "active" versions in the switchers
base list of releases to show. Zeus and warrior are old and no longer actively
maintained and we don't suggest new users use them. gatesgarth is also
outside it's support window.
I therefore propose removing these leaving us with dev, honister, hardknott,
dunfell (LTS). In addition, any release that is selected will be shown, along
with any later release in that release series.
People can still navigate to the older docs using the releases list or by
direct URL but this highlights to users which releases we'd expect/encourage
them to be using.
(From yocto-docs rev: fdcdc50f3abf10aa702c958b8ba7ab6b19c57bff)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev branch is being displayed in switchers under two different
headings, 4.0.999 and dev (4.0). Add an additional conditional to fix that.
(From yocto-docs rev: 569815ac290f53a17330e53fb46c4870d8d247d2)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Allow specifying the version from the commandline
- Add all previous release series/version mappings (to support transitions branch)
- Add poky mapping for 3.4 as some releases erronously use it
- Improve git branch 'guessing' code to work properly
- Handle poky '.0' release mappings correctly
- Only write poky.yaml if poky.yaml.in exists
- Ensure older non-active releases are shown in the switchers.js
release list.
- Ensure current version and current release series are shown in switcher.
(From yocto-docs rev: f2b069be8c307e3efe518f5d9bb1e6e705b96554)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A horrible blunt hammer approach to updating the version information in
switchers.js based on the available tag information.
To merge and work correctly, this will need a change to the autobuilder-helper
docs generation code to pull the swicthers.js and script from master, then
to run the script. That should hopefully remove the need for other patching
even on old docs branches though.
(From yocto-docs rev: dc858c8b2ffdb792fe8cef05fab3d752aa858f78)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Allow conf.py to read the versions it needs from poky.yaml and have
set_versions.py write this out. This means we don't have to change as
many files when making new releases.
(From yocto-docs rev: bfe74c67f327f0c6445cb4129ee0c32db022b95a)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Use a script to generate the branch/tag information inside poky.yaml.
If the branch isn't a known release branch, include git magic to find
the closest matching release branch we know about.
(From yocto-docs rev: 841e2df0e2e544b82fff9ddd0339a4e775148e3a)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adding 3.1.15 to documentation switcher and release list.
(From yocto-docs rev: 355dd1e3f5bf76244a0b5862475cb06ace1c87b9)
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This doesn't seem to be used anymore and doesn't make much sense,
remove it.
(From yocto-docs rev: 89176e0bd45453ebb7ac77ce6fa333cb94f0cfcc)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
We don't publish tarballs using this version any more, it has been
removed everywhere. Remove the obsolete references in the docs,
adapting references accordingly. The tarballs now are just created
with their sha256 checksum which we don't want or need to reference
in the docs.
(From yocto-docs rev: c7a0ac88b01c48f3d9209536542bf43ae7a7937f)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
journald is not a syslog provider, so using journald exclusively amounts
to just preventing a syslog provider from being specified on a system
where journald is active.
Various spots where this has popped up:
* https://stackoverflow.com/q/48746397
* https://lists.yoctoproject.org/g/yocto/topic/82883035#53548
(From yocto-docs rev: aba38d5dc2db708ed6e8fc6dca4d869fe7fe855c)
Signed-off-by: Nicholas Sielicki <nicholas.sielicki@legrand.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
By alphabetical order, to get the same order as in the HTML
output, sorted thanks to the ":sorted:" directive.
That was needed after the recent variable renaming for
inclusive language, but other variables were already
out of order anyway.
(From yocto-docs rev: 371c30d2f95fa32239c82d4ad8a6329ab191acca)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As already done in the BitBake manual.
Even though we're trying to keep the variable
definitions in alphabetical order, it's useful
to make sure that the variables are ordered in the
generated output.
(From yocto-docs rev: a43887858f46d2870443f7664487a36def23a90e)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add AlmaLinux 8.5, Fedora 35, and OpenSUSE Leap 15.3
Remove Fedora 33, Debian 8, OpenSUSE Leap 15.1 and 15.2
Removing distros that were recently removed from SANITY_TESTED_DISTROS
in meta-poky/conf/distro/poky.conf
(From yocto-docs rev: 734d5db1f166d7722541b25718fb11a12282f0c5)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Steve Sakoman <steve@sakoman.com>
Reported-by: Christian Eggers <ceggers@arri.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A number of classes and variables have been renamed, so update the
documentation as needed.
(From yocto-docs rev: 35b2e1757f5f2f09bb899ed24ffea50e5041b471)
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>
Replace a 10 year-old introduction to the Yocto Project
by the most recent one from Behan Webster and Tom King (Dec. 2021).
(From yocto-docs rev: 92a573d690c82fb9ff717e68af5ee09da33cea2c)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes identified by OE core's
scripts/contrib/convert-variable-renames.py script
Original variable names are kept in old migration notes,
but references to the new ones are provided.
(From yocto-docs rev: 1a35380ca80509fee036018a2bbb22ba9b44d47a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Sphinx seems to offer flexibility in heading styles definitions,
but the new text matches the way subsubsections and subsubsubsections
are defined in the current manuals.
Note that it's not possible to mix different definitions, for example
by using "~~~~" and "^^^^" for subsubsections in different places.
(From yocto-docs rev: 89a9af58adaa4cf4708d0383655b992f8c7239e2)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Branch information is now mandatory for git:// and gitsm:// URIs
(From yocto-docs rev: b862655d812e358dd15b06c0548a276a90666423)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This has recently been changed in expand_wildcard_licenses().
(file: OECORE/meta/classes/license.bbclass).
(From yocto-docs rev: 5121da30350a4edeef07f6722222c9e364617f0e)
Signed-off-by: Christian Eggers <ceggers@arri.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using DiskPart for the systems which lack optimize-vhd
(From yocto-docs rev: c692b77065e6bd8eda789a88fa8fae1351a7274d)
Signed-off-by: Tony McDowell <svet.am@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This change better aligns the name of the variable with its
purpose. Since we removed the older class, the associated
documentation is also removed.
(From yocto-docs rev: aa136a0fb552339db5475fff7947d2248f8af3e1)
Signed-off-by: Saul Wold <saul.wold@windriver.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This makes changes and new files easier to review
(From yocto-docs rev: f3f76236b5c003481a0f211b60a8df9479db833b)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
