summaryrefslogtreecommitdiffstats
path: root/documentation/set_versions.py
Commit message (Collapse)AuthorAgeFilesLines
* docs: add support for mickledore (4.2) releaseMichael Halstead2023-05-041-2/+4
| | | | | | | | | | | 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>
* docs: add support for langdale (4.1) releaseQuentin Schulz2022-10-251-2/+4
| | | | | | | | | | | | 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>
* docs: auto-generate releases.rstQuentin Schulz2022-07-201-0/+77
| | | | | | | | | | | | | | | | | | | 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>
* docs: set_versions.py: check for first latest release tagQuentin Schulz2022-06-021-1/+1
| | | | | | | | | | | | | 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>
* docs: set_versions.py: remove honister from active releases listQuentin Schulz2022-06-021-1/+1
| | | | | | | | | | | | | 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>
* docs: set_versions.py: show release name in switchers.jsQuentin Schulz2022-05-101-3/+3
| | | | | | | | | | | | | | | | | | 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>
* docs: set_versions.py: remove hardknott from active releases listQuentin Schulz2022-05-101-1/+1
| | | | | | | | | | | | | | 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>
* set_versions: Add a getlatest command to obtain the latest release branch nameRichard Purdie2022-04-261-0/+5
| | | | | | | | | 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>
* set_versions: update for 4.0 releaseMichael Halstead2022-04-261-5/+4
| | | | | | | | | 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>
* docs: sphinx-static: switchers.js.in: fix broken switcher for branchesQuentin Schulz2022-04-201-0/+3
| | | | | | | | | | | | | | | | | | 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>
* docs: set_versions.py: mark as obsolete only branches and old tags from ↵Quentin Schulz2022-04-201-1/+1
| | | | | | | | | | | | | | | | | | | | 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>
* docs: update Bitbake objects.inv location for master branchQuentin Schulz2022-04-201-1/+1
| | | | | | | | | | | | 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>
* docs: set_versions.py: fix latest version of an active release shown as obsoleteQuentin Schulz2022-04-191-5/+2
| | | | | | | | | | | | | | | 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>
* docs: set_versions.py: fix latest release of a branch being shown twice in ↵Quentin Schulz2022-04-191-5/+5
| | | | | | | | | | | | | | | | | | | | 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>
* docs: set_versions.py: add information about obsolescence of a releaseQuentin Schulz2022-04-191-3/+3
| | | | | | | | | | | | 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>
* set_versions/switchers: Drop versions shown to the active releasesRichard Purdie2022-03-311-1/+1
| | | | | | | | | | | | | | | | | | | 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>
* set_versions: Correct devbranch comparisionRichard Purdie2022-03-231-1/+1
| | | | | | | | | | 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>
* set_versions: Handle dev branch in switchers correctlyRichard Purdie2022-03-231-1/+1
| | | | | | | | | 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>
* Revert "set_versions/switchers: Drop versions shown to the active releases"Richard Purdie2022-03-231-1/+1
| | | | This reverts commit bf4e51fe5fad936f8b0e55cb49e07b18498f1837.
* Revert "set_versions: Handle dev branch in switchers correctly"Richard Purdie2022-03-231-1/+1
| | | | This reverts commit f7d853366470d1342e962c9d7164683a40dc0d7e.
* set_versions/switchers: Drop versions shown to the active releasesRichard Purdie2022-03-231-1/+1
| | | | | | | | | | | | | | | | | | | 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>
* set_versions: Handle dev branch in switchers correctlyRichard Purdie2022-03-231-1/+1
| | | | | | | | | 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>
* set_versions: Various improvementsRichard Purdie2022-03-231-29/+88
| | | | | | | | | | | | | | | | - 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>
* set_versions/switchers.js: Allow switchers.js version information to be ↵Richard Purdie2022-03-231-0/+19
| | | | | | | | | | | | | | | | 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>
* set_versions: Add support for setting POKYVERSION found in older releasesRichard Purdie2022-03-231-0/+11
| | | | | | (From yocto-docs rev: 9c7a4318920d468cca10448901868bad080cd895) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* conf.py/set_versions/poky.yaml: Set version in conf.py from poky.yamlRichard Purdie2022-03-231-0/+20
| | | | | | | | | | 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>
* Makefile/set_versions: Allow poky.yaml to be autogeneratedRichard Purdie2022-03-231-0/+120
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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-07-01 04:44:53 +0000