MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 21:09:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: set_versions.py: add information about obsolescence of a release

Browse Source 
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>
This commit is contained in:
Quentin Schulz 2022-04-14 13:33:26 +02:00 committed by Richard Purdie
parent 7b3a83f736
commit 8643342d80
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
documentation/set_versions.py
View File

@ -207,7 +207,7 @@ with open("sphinx-static/switchers.js.in", "r") as r, open("sphinx-static/switch
lines = r.readlines() lines = r.readlines()
for line in lines: for line in lines:
if "VERSIONS_PLACEHOLDER" in line: if "VERSIONS_PLACEHOLDER" in line:
w.write(" 'dev': 'dev (%s)',\n" % release_series[devbranch]) w.write(" 'dev': { 'title': 'dev (%s)', 'obsolete': false,},\n" % release_series[devbranch])
for branch in activereleases: for branch in activereleases:
if branch == devbranch: if branch == devbranch:
continue continue
@ -219,9 +219,9 @@ with open("sphinx-static/switchers.js.in", "r") as r, open("sphinx-static/switch
if versions[-1] != "0": if versions[-1] != "0":
version = version + "." + versions[-1] version = version + "." + versions[-1]
versions.append(version) versions.append(version)
w.write(" '%s': '%s',\n" % (version, version)) w.write(" '%s': {'title': '%s', 'obsolete': %s,},\n" % (version, version, str(branch == ourseries).lower()))
if ourversion not in versions and ourseries != devbranch: if ourversion not in versions and ourseries != devbranch:
w.write(" '%s': '%s',\n" % (ourversion, ourversion)) w.write(" '%s': {'title': '%s', 'obsolete': true,},\n" % (ourversion, ourversion))
else: else:
w.write(line) w.write(line)

12
documentation/sphinx-static/switchers.js.in
View File

@ -65,15 +65,15 @@ by https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-b
function build_version_select(current_series, current_version) { function build_version_select(current_series, current_version) {
var buf = ['<select>']; var buf = ['<select>'];
$.each(all_versions, function(version, title) { $.each(all_versions, function(version, vers_data) {
var series = version.substr(0, 3); var series = version.substr(0, 3);
if (series == current_series) { if (series == current_series) {
if (version == current_version) if (version == current_version)
buf.push('<option value="' + version + '" selected="selected">' + title + '</option>'); buf.push('<option value="' + version + '" selected="selected">' + vers_data["title"] + '</option>');
else else
buf.push('<option value="' + version + '">' + title + '</option>'); buf.push('<option value="' + version + '">' + vers_data["title"] + '</option>');
} else { } else {
buf.push('<option value="' + version + '">' + title + '</option>'); buf.push('<option value="' + version + '">' + vers_data["title"] + '</option>');
} }
}); });
@ -223,7 +223,7 @@ by https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-b
$('#outdated-warning').html('Version ' + release + ' of the project is now considered obsolete, please select and use a more recent version'); $('#outdated-warning').html('Version ' + release + ' of the project is now considered obsolete, please select and use a more recent version');
$('#outdated-warning').css('padding', '.5em'); $('#outdated-warning').css('padding', '.5em');
} else if (release != "dev") { } else if (release != "dev") {
$.each(all_versions, function(version, title) { $.each(all_versions, function(version, vers_data) {
var series = version.substr(0, 3); var series = version.substr(0, 3);
if (series == current_series && version != release) { if (series == current_series && version != release) {
$('#outdated-warning').html('This document is for outdated version ' + release + ', you should select the latest release version in this series, ' + version + '.'); $('#outdated-warning').html('This document is for outdated version ' + release + ', you should select the latest release version in this series, ' + version + '.');