linux/poky.git/documentation/set_versions.py, branch yocto-4.0.17

set_versions: update for 4.0 release

2022-04-26T09:56:52+00:00

Uncomment langdale lines to bump the version. (From yocto-docs rev: b4cf85ac951b1d09b8698effaf62ba052e772eac) Signed-off-by: Michael Halstead Signed-off-by: Richard Purdie

docs: sphinx-static: switchers.js.in: fix broken switcher for branches

2022-04-25T14:22:12+00:00

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 (From yocto-docs rev: 5ef3d129b8d0d8ae98a694103930988a46285525) Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

docs: set_versions.py: mark as obsolete only branches and old tags from obsolete releases

2022-04-25T14:22:12+00:00

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 (From yocto-docs rev: 7181a432da18b47608784363d243ea39b80be1ed) Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

docs: update Bitbake objects.inv location for master branch

2022-04-25T14:22:12+00:00

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 (From yocto-docs rev: 18338292d99ed236e2bac6e73a5152ef11c4a9e5) Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

docs: set_versions.py: fix latest version of an active release shown as obsolete

2022-04-25T14:22:12+00:00

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 (From yocto-docs rev: f16b633211b97b2cdf2c65d83c99cd3853d2bb5c) Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

docs: set_versions.py: fix latest release of a branch being shown twice in switchers.js

2022-04-25T14:22:12+00:00

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 (From yocto-docs rev: 36a088c8c99dd37f5ca07ec8f90f2c51ef8b36f2) Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

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

2022-04-19T11:37:42+00:00

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 (From yocto-docs rev: 6f40ef56054ecbd3d8b7310d748c1af78a689add) Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

set_versions/switchers: Drop versions shown to the active releases

2022-03-31T10:46:03+00:00

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

set_versions: Correct devbranch comparision

2022-03-23T12:38:30+00:00

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

set_versions: Handle dev branch in switchers correctly

2022-03-23T12:29:42+00:00

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