From patchwork Sat Mar 19 15:28:02 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Richard Purdie X-Patchwork-Id: 5534 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id A8478C433EF for ; Sat, 19 Mar 2022 15:28:08 +0000 (UTC) Received: from mail-wr1-f41.google.com (mail-wr1-f41.google.com [209.85.221.41]) by mx.groups.io with SMTP id smtpd.web12.8261.1647703687657855445 for ; Sat, 19 Mar 2022 08:28:08 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@linuxfoundation.org header.s=google header.b=G07LU+Jx; spf=pass (domain: linuxfoundation.org, ip: 209.85.221.41, mailfrom: richard.purdie@linuxfoundation.org) Received: by mail-wr1-f41.google.com with SMTP id j18so5717922wrd.6 for ; Sat, 19 Mar 2022 08:28:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linuxfoundation.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=+/Nhn1+rsP6gkA7yhsgMhtyk24eeZNtVIRMMGm/7Yp0=; b=G07LU+JxmIqZLqjlaGdu10C0sXXXe2aVMomeSXO+gpnz6cC6XVr3PuPzJtwkOnR3NB ASL4Cc31UktcTLbuPyFfCP2mGnX06/1RLuT3+z7uBUEFpHY3AsR17XU0SvPUs/oMKoX3 GzjBR77WSJbT9q7TdJU/nFdSGjOtosnqb0jj8= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=+/Nhn1+rsP6gkA7yhsgMhtyk24eeZNtVIRMMGm/7Yp0=; b=YFq8TvGjY4FeoshZQPdOWdK6RAk5W7iqO4+So+dFSHEwIm8gqtfG/VCztjlWB5SfEu Tc3+wJbQj2Vq4Be4W93jYcoloR0lKGPrKe93Lbi3IzwBxwYGsZjHjtZS7w733HuhMWWd XpVk5UK7RgtwPbTFTGMb8ngObkC0xhbjJ7dNgMcp+UsTIQo8i3jXeUAkztKLYYQ59Vyp GqpEJ2rxv5/eGMTuOreZBJNv9GDqQsGvbPkxBe7rZ++Kyb+mjsUk5su+/jW2/utG8fjF uiCIEgdYr+TW0jY4LwkMsliG+/EseLcaVPlWRueyL8UXUQ2FrfOCaeXdoxio5tKPAH+U P+Gg== X-Gm-Message-State: AOAM53116j3xuOtJl2vgyqfCBdOrUt0K5OCsJCIsxA9ZEojwmsIl6x3D fSNNvzjZVF8RPKUXu7kxm1YblsIUBreUvFzv X-Google-Smtp-Source: ABdhPJxPuiEH5RwcBS/mnGv10WCcpmcMWMEJH+FnV/GdC/9he/ql5vAoc4Osjdh6sNJdyiR+dj//MA== X-Received: by 2002:adf:dc92:0:b0:203:f998:7f10 with SMTP id r18-20020adfdc92000000b00203f9987f10mr5472227wrj.567.1647703685549; Sat, 19 Mar 2022 08:28:05 -0700 (PDT) Received: from hex.int.rpsys.net ([2001:8b0:aba:5f3c:3ad7:b7e1:8044:d0f5]) by smtp.gmail.com with ESMTPSA id l126-20020a1c2584000000b00387d4f35651sm12659726wml.10.2022.03.19.08.28.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 19 Mar 2022 08:28:05 -0700 (PDT) From: Richard Purdie To: docs@lists.yoctoproject.org Cc: Quentin Schulz , Nicolas Dechesne , Michael Opdenacker Subject: [PATCH 1/2] set_versions/switchers.js: Allow switchers.js version information to be autogenerated Date: Sat, 19 Mar 2022 15:28:02 +0000 Message-Id: <20220319152803.1110539-2-richard.purdie@linuxfoundation.org> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220319152803.1110539-1-richard.purdie@linuxfoundation.org> References: <20220319152803.1110539-1-richard.purdie@linuxfoundation.org> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Sat, 19 Mar 2022 15:28:08 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/2645 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. Signed-off-by: Richard Purdie Reviewed-by: Michael Opdenacker --- documentation/.gitignore | 1 + documentation/set_versions.py | 20 +++++++++++++++++++ .../{switchers.js => switchers.js.in} | 8 +------- 3 files changed, 22 insertions(+), 7 deletions(-) rename documentation/sphinx-static/{switchers.js => switchers.js.in} (97%) diff --git a/documentation/.gitignore b/documentation/.gitignore index e5e2c1708..096b97ec2 100644 --- a/documentation/.gitignore +++ b/documentation/.gitignore @@ -1,6 +1,7 @@ _build/ Pipfile.lock poky.yaml +sphinx-static/switchers.js .vscode/ */svg/*.png */svg/*.pdf diff --git a/documentation/set_versions.py b/documentation/set_versions.py index db94ef5c1..4cdea8f42 100755 --- a/documentation/set_versions.py +++ b/documentation/set_versions.py @@ -13,6 +13,7 @@ import subprocess import collections import sys +activereleases = ["honister", "hardknott", "dunfell"] devbranch = "kirkstone" #devbranch = "langdale" ltsseries = ["kirkstone", "dunfell"] @@ -143,3 +144,22 @@ with open("poky.yaml.in", "r") as r, open("poky.yaml", "w") as w: w.write(line) print("poky.yaml generated from poky.yaml.in") + +with open("sphinx-static/switchers.js.in", "r") as r, open("sphinx-static/switchers.js", "w") as w: + lines = r.readlines() + for line in lines: + if "VERSIONS_PLACEHOLDER" in line: + w.write(" 'dev': 'dev (%s)',\n" % release_series[devbranch]) + for branch in activereleases: + if branch == devbranch: + continue + versions = subprocess.run('git tag --list yocto-%s*' % (release_series[branch]), shell=True, capture_output=True, text=True).stdout.split() + versions = sorted([v.replace("yocto-" + release_series[branch] + ".", "").replace("yocto-" + release_series[branch], "0") for v in versions], key=int) + version = release_series[branch] + if versions[-1] != "0": + version = version + "." + versions[-1] + w.write(" '%s': '%s',\n" % (version, version)) + else: + w.write(line) + +print("switchers.js generated from switchers.js.in") diff --git a/documentation/sphinx-static/switchers.js b/documentation/sphinx-static/switchers.js.in similarity index 97% rename from documentation/sphinx-static/switchers.js rename to documentation/sphinx-static/switchers.js.in index 3ea8927d7..5d3a4d793 100644 --- a/documentation/sphinx-static/switchers.js +++ b/documentation/sphinx-static/switchers.js.in @@ -10,13 +10,7 @@ by https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-b 'use strict'; var all_versions = { - 'dev': 'dev (3.5)', - '3.4.2': '3.4.2', - '3.3.5': '3.3.5', - '3.2.4': '3.2.4', - '3.1.14': '3.1.14', - '3.0.4': '3.0.4', - '2.7.4': '2.7.4', + VERSIONS_PLACEHOLDER }; var all_doctypes = {