Commit Graph

35 Commits

Author SHA1 Message Date
Quentin Schulz
f92147be29 set_versions.py: mark Styhead as EoL
Styhead is now EoL, let's remove it from the active releases.

(From yocto-docs rev: f2e3cf2637ce3ed3475faa472b134a29f019681b)

Signed-off-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>
2025-05-19 15:54:10 +01:00
Lee Chee Yang
d9c8689d69 docs: update walnascar-5.2 release
(From yocto-docs rev: 08dba6f1e0e978b1be8faa5c09ae266ac383f57d)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-09 07:10:42 +01:00
Antonin Godard
76f887eb12 poky.yaml: introduce DISTRO_LATEST_TAG
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>
2025-04-21 21:15:29 +01:00
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
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
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
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 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 Halstead
d9a7f94724 docs: add support for mickledore (4.2) release
This adds support for the Mickledore (4.2) release and update the
current dev branch to Nanbield.

(From yocto-docs rev: 5321befbfdc014d469b298bdd5b31d684231b2cb)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-04 13:53:06 +01:00
Quentin Schulz
641c4d3a1c docs: add support for langdale (4.1) release
This adds support for the Langdale (4.1) release and update the current
dev branch to Mickledore.

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

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>
2022-10-25 13:41:36 +01:00
Quentin Schulz
9926c0bf2f docs: auto-generate releases.rst
In order to maintain one less file, let's auto-generate the releases.rst
file which contains a link for each release ever released.

This gets auto-generated by checking the tags available in this git repo
and adding a link for each that exists.

A few tags are notoriously missing from this git repo and they are
manually listed then, until the tags are pushed for the appropriate
commit.

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

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>
2022-07-20 14:25:01 +01:00
Quentin Schulz
98bef02fe3 docs: set_versions.py: check for first latest release tag
Let's not maintain manually which tag should be locally available before
asking the user to run git fetch --tags. Instead, let's check for the
latest release first tag (e.g. for Kirkstone, 4.0 even though 4.0.1 is
already out).

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

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-02 14:46:41 +01:00
Quentin Schulz
e8f5501d5c docs: set_versions.py: remove honister from active releases list
Honister 3.4.4 is the last release of the series and the series is now
considered obsolete.

Let's remove honister from the list of active releases.

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

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-02 14:46:41 +01:00
Quentin Schulz
4d111eb737 docs: set_versions.py: show release name in switchers.js
Also show release names in the dropdown menu so that people have
knowledge of both the version number and release name of whatever
they're using or planning to use or upgrade to.

This patch will make the dropdown menu show the following entries:
Unstable (dev)
Kirkstone (4.0)
Honister (3.4.3)

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

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>
2022-05-10 12:52:34 +01:00
Quentin Schulz
7acf97ad3b docs: set_versions.py: remove hardknott from active releases list
Hardknott 3.3.6 is the last release of the series and the release is now
obsolete.

Let's remove hardknott from the list of active releases.

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

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>
2022-05-10 12:52:34 +01:00
Richard Purdie
e464cc46bc set_versions: Add a getlatest command to obtain the latest release branch name
This will allow the autobuilder-helper run-docs-build script to obtain
the latest release name.

(From yocto-docs rev: 733b7f301e44010579e1315f19eff737628d635e)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-26 18:25:08 +01:00
Michael Halstead
5639708757 set_versions: update for 4.0 release
Uncomment langdale lines to bump the version.

(From yocto-docs rev: e0016979413ab27f2e5db88ae1de180507c759c2)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-26 10:56:47 +01:00
Quentin Schulz
ee6718fe08 docs: sphinx-static: switchers.js.in: fix broken switcher for branches
The switcher expects URL subpath to match the "release" used by sphinx
to build the documentation. Branches, however, are put in a subpath
after their name (e.g. dunfell) while sphinx sets the "release" to
X.Y.999. This means the switcher cannot replace correctly the path to
switch between releases/versions.

Let set_versions.py inject the list of release names into the
switchers.js.in file so it can check whether the subpath is one of the
release names in which case it needs to be stripped.

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

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-20 17:25:33 +01:00
Quentin Schulz
8245b2b1d5 docs: set_versions.py: mark as obsolete only branches and old tags from obsolete releases
Branches are identified by their .999 version suffix which means they
will never be matched in the forloop above this git context. Therefore,
branches will match the condition. However, branches are not necessarily
obsolete (e.g. dunfell, honister and kirkstone today), so let's mark as
obsolete the branches which are from obsolete releases.

Old tags of currently supported releases are not defined as obsolete but
outdated, therefore using the series to which they belong like it is
done for branches is enough for obsolescence detection.

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

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-20 17:25:33 +01:00
Quentin Schulz
a041cb4ea5 docs: update Bitbake objects.inv location for master branch
master branch of Bitbake is now located at docs.yoctoproject.org/dev
instead of docs.yoctoproject.org so let's update the switchers and
set_versions.py to reflect that change.

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

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-20 13:14:00 +01:00
Quentin Schulz
b5882ec908 docs: set_versions.py: fix latest version of an active release shown as obsolete
ourseries can be an active release and therefore shouldn't be marked as
obsolete. By adding ourseries to activereleases, it is impossible to
know if ourseries is actually an active release or not. Instead let's
loop on the active releases with ourseries too (only if it's not active
release, otherwise it'd appear twice).

Fixes: 6f40ef56054ec "docs: set_versions.py: add information about obsolescence of a release"
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: f16b633211b97b2cdf2c65d83c99cd3853d2bb5c)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-19 22:07:52 +01:00
Quentin Schulz
36ccca5cba docs: set_versions.py: fix latest release of a branch being shown twice in switchers.js
versions array is supposed to store the latest version of all active
releases. However, in the loop it is reassigned and therefore, the check
on whether our version is already in the versions array will always
return false (except for the latest version of the last active release)
and write our version again in the list.

By using a local variable for the logic instead of versions array, the
check now works properly.

Fixes: f2b069be8c307 "set_versions: Various improvements"
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 36a088c8c99dd37f5ca07ec8f90f2c51ef8b36f2)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-19 22:07:52 +01:00
Quentin Schulz
8643342d80 docs: set_versions.py: add information about obsolescence of a release
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>
2022-04-19 12:37:42 +01:00
Richard Purdie
28f2442520 set_versions/switchers: Drop versions shown to the active releases
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>
2022-03-31 11:46:03 +01:00
Richard Purdie
e0a812b2fe set_versions: Correct devbranch comparision
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>
2022-03-23 12:38:30 +00:00
Richard Purdie
c9d1536777 set_versions: Handle dev branch in switchers correctly
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>
2022-03-23 12:29:42 +00:00
Richard Purdie
49a411edd4 Revert "set_versions/switchers: Drop versions shown to the active releases"
This reverts commit bf4e51fe5f.
2022-03-23 12:27:50 +00:00
Richard Purdie
13217f8b82 Revert "set_versions: Handle dev branch in switchers correctly"
This reverts commit f7d8533664.
2022-03-23 12:27:40 +00:00
Richard Purdie
bf4e51fe5f set_versions/switchers: Drop versions shown to the active releases
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>
2022-03-23 12:08:56 +00:00
Richard Purdie
f7d8533664 set_versions: Handle dev branch in switchers correctly
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>
2022-03-23 12:08:56 +00:00
Richard Purdie
d51fb3c8b9 set_versions: Various improvements
- 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>
2022-03-23 12:08:56 +00:00
Richard Purdie
8827704443 set_versions/switchers.js: Allow switchers.js version information to be autogenerated
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>
2022-03-23 12:08:56 +00:00
Richard Purdie
767eb1c71c set_versions: Add support for setting POKYVERSION found in older releases
(From yocto-docs rev: 9c7a4318920d468cca10448901868bad080cd895)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23 12:08:56 +00:00
Richard Purdie
b04eda7447 conf.py/set_versions/poky.yaml: Set version in conf.py from poky.yaml
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>
2022-03-23 12:08:56 +00:00
Richard Purdie
8d3e9aaede Makefile/set_versions: Allow poky.yaml to be autogenerated
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>
2022-03-23 12:08:56 +00:00