diff options
author | Quentin Schulz <quentin.schulz@theobroma-systems.com> | 2022-04-14 13:33:27 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-04-19 12:37:42 +0100 |
commit | 57a32692b7e34002c1475763f3b90650b595b851 (patch) | |
tree | 9fca987553823ae26cb6e86d674a6a9cdfb36ee9 /documentation | |
parent | 8643342d80a73f14a84dcc4c9aed2e67a452cb5c (diff) | |
download | poky-57a32692b7e34002c1475763f3b90650b595b851.tar.gz |
docs: sphinx-static: switchers.js.in: improve obsolete version detection
Based on additional information per release, specifically with the
obsolescence status of a release, the obsolescence detection can now be
much smarter than just checking if the release is older than dunfell.
This is required because with LTS (dunfell for example) releases, it is
now possible to have LTS releases that are older than obsolete releases.
This means obsolete releases need to be tracked and only the release
version cannot be used as an indicator of obsolescence.
Let's use the obsolete field of the per-release data in the all_versions
dictionary to display correct warning messages.
The warning message is first about outdated version if there's a newer
one available (*even* if it is for an obsolete release, e.g. 3.0.1 will
say it's outdated and should select 3.0.4 version instead), then if the
version is the last of the release, show a warning message if the
release is obsolete.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 6986baa0d3b544bbad8a7e23ee447abc6f2769f6)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/sphinx-static/switchers.js.in | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/documentation/sphinx-static/switchers.js.in b/documentation/sphinx-static/switchers.js.in index 5ae0325e6d..408e23a71c 100644 --- a/documentation/sphinx-static/switchers.js.in +++ b/documentation/sphinx-static/switchers.js.in | |||
@@ -219,15 +219,20 @@ by https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-b | |||
219 | $('.doctype_switcher_placeholder').html(doctype_select); | 219 | $('.doctype_switcher_placeholder').html(doctype_select); |
220 | $('.doctype_switcher_placeholder select').bind('change', on_doctype_switch); | 220 | $('.doctype_switcher_placeholder select').bind('change', on_doctype_switch); |
221 | 221 | ||
222 | if (ver_compare(release, "3.1") < 0) { | 222 | if (release != "dev") { |
223 | $('#outdated-warning').html('Version ' + release + ' of the project is now considered obsolete, please select and use a more recent version'); | ||
224 | $('#outdated-warning').css('padding', '.5em'); | ||
225 | } else if (release != "dev") { | ||
226 | $.each(all_versions, function(version, vers_data) { | 223 | $.each(all_versions, function(version, vers_data) { |
227 | var series = version.substr(0, 3); | 224 | var series = version.substr(0, 3); |
228 | if (series == current_series && version != release) { | 225 | if (series == current_series) { |
229 | $('#outdated-warning').html('This document is for outdated version ' + release + ', you should select the latest release version in this series, ' + version + '.'); | 226 | if (version != release) { |
230 | $('#outdated-warning').css('padding', '.5em'); | 227 | $('#outdated-warning').html('This document is for outdated version ' + release + ', you should select the latest release version in this series, ' + version + '.'); |
228 | $('#outdated-warning').css('padding', '.5em'); | ||
229 | return false; | ||
230 | } | ||
231 | if (vers_data["obsolete"]) { | ||
232 | $('#outdated-warning').html('Version ' + release + ' of the project is now considered obsolete, please select and use a more recent version'); | ||
233 | $('#outdated-warning').css('padding', '.5em'); | ||
234 | return false; | ||
235 | } | ||
231 | } | 236 | } |
232 | }); | 237 | }); |
233 | } | 238 | } |