Commit Graph

5997 Commits

Author SHA1 Message Date
Lee Chee Yang
4cc0e9438b migration-guides: add release-notes for 4.0.9
(From yocto-docs rev: 8388be749806bd0bf4fccf1005dae8f643aa4ef4)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-04-26 04:03:21 -10:00
Michael Opdenacker
2a15bb1af3 migration-guides: add 4.0.8 release notes
(From yocto-docs rev: 86d0b38a97941ad52b1af220c7b801a399d50e93)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-03-20 12:53:45 +00:00
Michael Opdenacker
f85edc197e dev-manual: common-tasks.rst: add link to FOSDEM 2023 video
(From yocto-docs rev: 16ecbe028f2b9cc021267817a5413054e070b563)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-23 12:18:34 +00:00
Steve Sakoman
511507f0ce system-requirements.rst: add Fedora 36 and AlmaLinux 8.7 to list of supported distros
(From yocto-docs rev: 0a1257860ed41d526856dc71b36e7f96155c0844)

Signed-off-by: Steve Sakoman <steve@sakoman.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-23 08:17:02 +00:00
Michael Opdenacker
fc5364a032 manuals: update patchwork instance URL
https://patchwork.openembedded.org/ has been since long discontinued
Also better to mention https://patchwork.yoctoproject.org/
than the patchwork home page.

(From yocto-docs rev: e7dcd04a1a4f6db42e7469226623016dccd2186d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-15 10:26:49 +00:00
Michael Opdenacker
e4e0dabc0d bsp-guide: fix broken git URLs and missing word
(From yocto-docs rev: 115793b87f922fe18b8e791f6cc09308a002eb29)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-15 10:26:49 +00:00
Michael Opdenacker
fd03545975 profile-manual: update WireShark hyperlinks
(From yocto-docs rev: c8de3cd057f3a72e8467a927edc5bd82183860f7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-15 10:26:49 +00:00
Lee Chee Yang
7045fbd1f4 migration-guides: add release-notes for 4.0.7
(From yocto-docs rev: 65b2f85ff25fbf9d55ddf4be28b285dcf1bbaff0)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Takayasu Ito <ito@lineo.co.jp>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-15 10:26:49 +00:00
Michael Opdenacker
1b1ca97a25 ref-manual: document SSTATE_EXCLUDEDEPS_SYSROOT
Backport from master:
https://git.yoctoproject.org/yocto-docs/commit/?id=b6690011c14ce4bf30571f045152a9d324ad5039

(From yocto-docs rev: 0b0509d14742ad1cd050a79164718e6e17020c65)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-15 10:26:49 +00:00
Michael Opdenacker
86e9630511 dev-manual: fix old override syntax
(From yocto-docs rev: 48bd2ea8efe446b3694a3795b8083fe8783777aa)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-10 11:04:02 +00:00
Michael Opdenacker
d3e3783973 manuals: document SPDX_PRETTY variable
Now that it has been backported to Kirkstone
https://git.yoctoproject.org/poky/commit/?h=kirkstone&id=99483cff5c358d847ceb077349321eb57d5143e4

(From yocto-docs rev: 5883e897c34f25401b358a597fb6e18d80f7f90b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-01-10 14:21:45 +00:00
Quentin Schulz
ebfc6bdba4 docs: kernel-dev: faq: update tip on how to not include kernel in image
Since commit f6d963fa6d ("kernel: make kernel-base recommend
kernel-image, not depend"), present in Kirkstone 4.0, one should
set RRECOMMENDS and not RDEPENDS to avoid including the kernel in the
image, so let's update the documentation to reflect that.

Reported-by: Konstantin Kletschke <konstantin.kletschke@inside-m2m.de>
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: b94956c7d416879f9e4c46102145ef478270c440)

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>
2023-01-06 17:33:45 +00:00
Quentin Schulz
cf42cc0ef0 docs: migration-4.0: specify variable name change for kernel inclusion in image recipe
Since commit f6d963fa6d ("kernel: make kernel-base recommend
kernel-image, not depend"), present in Kirkstone 4.0, one should
set RRECOMMENDS and not RDEPENDS to avoid including the kernel in the
image, so let's update the documentation to reflect that.

Reported-by: Konstantin Kletschke <konstantin.kletschke@inside-m2m.de>
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 775a3c7c56562fa8dd6a426008bce06ca1140e04)

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>
2023-01-06 17:33:45 +00:00
Michael Opdenacker
4641f83d93 manuals: add 4.0.5 and 4.0.6 release notes
(From yocto-docs rev: 61b2f039f09282a271abc1c41ea09765ea08a2cb)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-01-06 17:33:45 +00:00
Michael Opdenacker
c883909950 SPDX and CVE documentation updates
Backporting from master the ones that are applicable to kirkstone.

(From yocto-docs rev: c10d65ef3bbdf4fe3abc03e3aef3d4ca8c2ad87f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-07 15:04:15 +00:00
Mikko Rapeli
7a5685ad74 common-tasks.rst: fix oeqa runtime test path
It's "runtime/cases" in master and kirkstone.
If layer specific tests are in "runtime" directory,
they will not be found.

(From yocto-docs rev: 23dcf002eec5136427554112af8679fc2b98e61d)

Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:16:38 +00:00
Michael Opdenacker
eaf8ce9d39 dev-manual: fix reference to BitBake user manual
Fix a wrong reference no longer tolerated by Sphinx 5.x
(missing "bitbake:" prefix)

(From yocto-docs rev: 8c2f9f54e29781f4ee72e81eeaa12ceaa82dc2d3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-11 21:57:49 +01:00
Michael Opdenacker
c615d00a36 migration-guides: add 4.0.4 release notes
(From yocto-docs rev: df129c47f866b933af722b1214f3296a8cfe483b)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:51 +01:00
Michael Opdenacker
4837160315 poky.yaml.in: update version requirements
According to meta/classes/sanity.bbclass in Poky

(From yocto-docs rev: 2c6207606329c2b4ec56b7af538182ebf3c92792)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-05 08:47:28 +01:00
Steve Sakoman
32ca0ff8fa system-requirements.rst: Add Ubuntu 22.04 to list of supported distros
(From yocto-docs rev: f632dad24c39778f948014029e74db3c871d9d21)

Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-16 17:55:51 +01:00
Michael Opdenacker
e0c806a65c migration guides: add missing release notes
(From yocto-docs rev: 23d3687c4cf71e878619a7bd7b95a9df944ca76c)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-08-31 12:17:41 +01:00
Jon Mason
b051dc5d4f ref-manual: add numa to machine features
numa is an existing machine feature, add it to the list so that users
are aware of it.

(From yocto-docs rev: 7794a3449e1b92a57a551395a65e7083eefff227)

Signed-off-by: Jon Mason <jdmason@kudzu.us>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-08-31 12:17:41 +01:00
Michael Opdenacker
236f30b8a9 ref-manual: variables: remove sphinx directive from literal block
Literal blocks make sphinx take their text verbatim. This means that
directives cannot be used in literal blocks. This means :term:`S` was
printed as-is, without actually creating a link to the S variable
definition as would be expected outside of literal blocks.

Initially contributed to the master branch by Quentin Schulz.

(From yocto-docs rev: d9b3dcf65ef25c06f552482aba460dd16862bf96)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-07-20 15:52:51 +01:00
Michael Opdenacker
b373ad8405 docs: BB_HASHSERVE_UPSTREAM: update to new host
(From yocto-docs rev: f9a9c5cc721a79df7a39a6df8441739e3377fdc4)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-07-20 15:52:51 +01:00
Michael Opdenacker
c00f584817 manuals: switch to the sstate mirror shared between all versions
Following https://git.yoctoproject.org/poky/commit/?id=cf7d8894545b83f55420fa33f7848e1bfc6754ff

(From yocto-docs rev: 662294dccd028828d5c7e9fd8f5c8e14df53df4b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-28 23:58:39 +01:00
Michael Opdenacker
27de52e402 migration-guides: release-notes-4.0: mention LTS release
(From yocto-docs rev: 4ec9df3336a425719a9a35532504731ce56984ca)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-29 19:10:10 +01:00
Nicolas Dechesne
c77f0ce695 migration-guides: stop including documents with ".. include"
This prevented variables from being substituted through the
code in yocto-vars.py, at least in the files included this way.

Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
(From yocto-docs rev: ac4e4b167964dd4548fb3d90cf9c63580a70b6e3)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-29 19:10:10 +01:00
Michael Halstead
d53ac6e956 set_versions: update for 4.0 release
Uncomment langdale lines to bump the version.

(From yocto-docs rev: b4cf85ac951b1d09b8698effaf62ba052e772eac)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-26 10:56:52 +01:00
Michael Halstead
3fbc631a44 releases: update for yocto 4.0
Bump various versions and names.

(From yocto-docs rev: bfb8b2cf4a79f898cdc97c6be7f3b47a5a411d84)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-26 10:56:52 +01:00
Lee Chee Yang
c68b8e1770 migration-guides: release-notes-4.0: update 'Repositories / Downloads' section
(From yocto-docs rev: e814a998cc0a7c451a77df0304d0a69a27ac08ae)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Quentin Schulz
02dc699d23 docs: migration-guides: release-notes-4.0: replace kernel placeholder with correct recipe name
If I am not mistaken, the only kernel recipe to have a new PACKAGECONFIG
option is linux-yocto-dev, in commit 1bac831fba
"linux-yocto-dev: introduce dt-validation PACKAGECONFIG".

Therefore, let's replace (kernel) by the one kernel recipe that has this
change.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 1882954924cef9f17caad0f83973afe08f4db764)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Quentin Schulz
b43d659260 docs: migration-guides: release-notes-4.0: fix risc-v typo
It's RISC-V and not RiscV, c.f. https://riscv.org/ (yes, no dash in the
domain name...).

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 1a5fd51a50fe39d8095bb5a4f34d6b953e59c58f)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Quentin Schulz
3f5365d11a docs: migration-guides: migration-3.4: mention that hardcoded password are supported if hashed
Plaintext/clear passwords are not supported anymore but hashed passwords
still are. Mention that in the migration guide and point to the
appropriate location of documentation.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: f8b9697ec7bcc188db5ce9e5067bc82c023b79d9)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Quentin Schulz
8c7145a12d docs: ref-manual: variables: add hashed password example in EXTRA_USERS_PARAMS
Add examples for hashed hardcoded passwords from extrausers.bbclass so
that this feature is not hidden away.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 5db73c7c5668144ed4629f95378e44f0bd8c8256)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Quentin Schulz
4c2ea34b3e docs: conf.py: fix cve extlinks caption for sphinx <4.0
extlinks captions support using %s substitution but only from sphinx 4.0
onwards.
c.f. https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html#confval-extlinks

Weirdly enough, on older sphinx versions, the caption is just a prefix
to the actual text passed to the extlink. Therefore, in that specific
case, CVE- or CVE-%s are identical in meaning for sphinx >=4.0 and since
only CVE- caption works on sphinx <4.0, let's go with CVE- caption
prefix.

Fixes: b311070d866cf "manuals: add 3.4 and 3.4.1 release notes after migration information"
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: c9922076f5c1285d9cfd6aff8ce5b6635d88222f)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Paul Eggleton
5cad452c85 ref-manual: add ZSTD_THREADS
ZSTD_THREADS is new for kirkstone.

(From yocto-docs rev: b970936b89bebb184c82be3a9514a9eba7c04f9b)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Richard Purdie
47fab8caa8 ref-manual: Add XZ_THREADS and XZ_MEMLIMIT
XZ_THREADS and XZ_MEMLIMIT were introduced in dunfell.

[RP improved an original patch from Paul]
(From yocto-docs rev: 96defb66b775093b5270bd1ebad0461c2bba1e5b)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Paul Eggleton
eee7bbc16a migration-guides: add release notes for 4.0
Generated from commits in the kirkstone branch, as well as a few entries
from the migration guide.

(Note that the "Repositories / Downloads" section still needs to be
filled in.)

(From yocto-docs rev: 0c66638e61d3e16ac8d4b7ebc4ec6fb35625bf4f)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Paul Eggleton
97bfd780ad migration-guides: complete migration guide for 4.0
* Make some corrections to preliminary set of entries
* Move out entries that were more appropriate for the release notes
  (i.e. that are more additions rather than changes that require the
  user to make changes)
* Add new entries based on commits in the kirkstone branch

(From yocto-docs rev: bea2da80e7c5338dc5abefe95ce27b80ed4ee98a)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Paul Eggleton
445d91575d ref-manual: add empty-dirs QA check and QA_EMPTY_DIRS*
This check is new in kirkstone.

(From yocto-docs rev: baa483e75538013be3261f8c115b8a5364b24c60)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Paul Eggleton
9e75211b3a ref-manual: add KERNEL_DEBUG_TIMESTAMPS
New variable in kirkstone.

(From yocto-docs rev: 2c5d4938a09fd35f9e86f682cde89d4693762725)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Paul Eggleton
b3f040b4a5 ref-manual: add mention of vendor filtering to CVE_PRODUCT
Mention the vendor filtering functionality - prompted by OE-Core
revision 45d1a0bea0c628f84a00d641a4d323491988106f.

(From yocto-docs rev: 13ff5a49f14a26772b4775d9ecd08627e6becd4d)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Paul Eggleton
8da3055567 ref-manual: mention wildcarding support in INCOMPATIBLE_LICENSE
Add this since the INCOMPATIBLE_LICENSE wildcard support has changed in
the 4.0 release.

(From yocto-docs rev: c7946863e5a9d62a49131b92cc9549da9b799bbd)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Paul Eggleton
ad8d1e6228 ref-manual: add a note about hard-coded passwords
It seems prudent to point out that hard-coding passwords in the manner
detailed in the example is not a good idea in production. This type of
mistake has unfortunately been made by many device vendors (outside of
the Yocto Project context) leading to security vulnerabilities.

(From yocto-docs rev: 1d07dba9423ae0a841eccb58c297e31b63c3965d)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Paul Eggleton
b80972f3ad migration-3.4: add missing entry on EXTRA_USERS_PARAMS
We missed noting this in 3.4 but I noticed the documentation was
recently updated, so note the removal.

(From yocto-docs rev: f661e62d6faf48dbb6c6fd9a61a6448ec339d2bf)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Quentin Schulz
273fe4b6af docs: sphinx-static: switchers.js.in: do not mark branches as outdated
Branches can never be outdated so let's check the release is not a
branch (branches end with .999).

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 4755961bbb5f674a7532b91cca20ea44a1e22ae7)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Quentin Schulz
3947a5f18b docs: sphinx-static: switchers.js.in: fix broken switcher for branches
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>
2022-04-25 15:22:12 +01:00
Quentin Schulz
4b8010810a docs: sphinx-static: switchers.js.in: rename all_versions to switcher_versions
This array only contains versions that can be selected through the
dropdown menu for switching between supported versions.

Therefore, let's rename it to switcher_versions to make its usecase
clearer.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 5c3d67751bf3f572a0788d3a4734b80e3453d084)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Quentin Schulz
8096431d58 docs: set_versions.py: mark as obsolete only branches and old tags from 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>
2022-04-25 15:22:12 +01:00
Quentin Schulz
ea99def6bf docs: update Bitbake objects.inv location for master branch
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>
2022-04-25 15:22:12 +01:00