diff mbox series

[v2] docs: update current releases

Message ID 20241025-update-switchers-v2-1-290a6c777a68@bootlin.com
State New
Headers show
Series [v2] docs: update current releases | expand

Commit Message

Antonin Godard Oct. 25, 2024, 2:07 p.m. UTC
Remove dunfell and nanbield which are not supported anymore.
Add styhead as an active release.
Set walnascar as the dev branch.

The switcher menu now contains:
- Unstable (dev)
- Styhead (5.1)
- Scarthgap (5.0.4)
- Kirkstone (4.0.22)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
@Quentin: adding Walnascar as the devbranch does the trick and adds
Styhead to the switchers menu. And indeed, walnascar _is_ the current
dev branch, not styhead.
---
Changes in v2:
- Add Walnascar as the devbranch, which adds Styhead to the switchers
  menu.
- Update poky.yaml.in.
- Link to v1: https://lore.kernel.org/r/20241025-update-switchers-v1-1-5e540ead879b@bootlin.com
---
 documentation/poky.yaml.in    | 12 ++++++------
 documentation/set_versions.py |  8 +++++---
 2 files changed, 11 insertions(+), 9 deletions(-)


---
base-commit: afeded9939777d88bf4cb9ebf7a61aadd476642d
change-id: 20241025-update-switchers-6d72cd2aadb6

Best regards,

Comments

Richard Purdie Oct. 25, 2024, 2:16 p.m. UTC | #1
On Fri, 2024-10-25 at 16:07 +0200, Antonin Godard via
lists.yoctoproject.org wrote:
> Remove dunfell and nanbield which are not supported anymore.
> Add styhead as an active release.
> Set walnascar as the dev branch.
> 
> The switcher menu now contains:
> - Unstable (dev)
> - Styhead (5.1)
> - Scarthgap (5.0.4)
> - Kirkstone (4.0.22)
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
> @Quentin: adding Walnascar as the devbranch does the trick and adds
> Styhead to the switchers menu. And indeed, walnascar _is_ the current
> dev branch, not styhead.

The patch looks good thanks. I just wanted to mention:

https://git.yoctoproject.org/yocto-autobuilder-helper/commit/?id=51d842b5e0b14e5439b5c89ec314886218a62ebf

i.e. we do have a script in helper which we're also doing some of this
in. I think that script goes on to generation a json file which powers
bits of the main website.

Could we try and converge things. The reason for adding this script was
to get the website code somewhere more accessible so we are slowly
making progress towards that...

Cheers,

Richard
Quentin Schulz Oct. 25, 2024, 2:20 p.m. UTC | #2
Hi Antonin,

On 10/25/24 4:07 PM, Antonin Godard wrote:
> Remove dunfell and nanbield which are not supported anymore.
> Add styhead as an active release.
> Set walnascar as the dev branch.
> 
> The switcher menu now contains:
> - Unstable (dev)
> - Styhead (5.1)
> - Scarthgap (5.0.4)
> - Kirkstone (4.0.22)
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
> @Quentin: adding Walnascar as the devbranch does the trick and adds
> Styhead to the switchers menu. And indeed, walnascar _is_ the current
> dev branch, not styhead.
> ---
> Changes in v2:
> - Add Walnascar as the devbranch, which adds Styhead to the switchers
>    menu.
> - Update poky.yaml.in.
> - Link to v1: https://lore.kernel.org/r/20241025-update-switchers-v1-1-5e540ead879b@bootlin.com
> ---
>   documentation/poky.yaml.in    | 12 ++++++------
>   documentation/set_versions.py |  8 +++++---
>   2 files changed, 11 insertions(+), 9 deletions(-)
> 
> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
> index 0c04b615eae07e722982ad8808b8d4ff228b5cb5..c770318f2be76cca3ea23a25d819ace46d157b4c 100644
> --- a/documentation/poky.yaml.in
> +++ b/documentation/poky.yaml.in

IIRC parts of this file are now autogenerated, c.f. the replacements 
dict in set_versions.py.

So it's likely unnecessary, but... it doesn't hurt :)

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin
Quentin Schulz Oct. 25, 2024, 2:24 p.m. UTC | #3
Hi Antonin, Richard,

On 10/25/24 4:16 PM, Richard Purdie wrote:
> On Fri, 2024-10-25 at 16:07 +0200, Antonin Godard via
> lists.yoctoproject.org wrote:
>> Remove dunfell and nanbield which are not supported anymore.
>> Add styhead as an active release.
>> Set walnascar as the dev branch.
>>
>> The switcher menu now contains:
>> - Unstable (dev)
>> - Styhead (5.1)
>> - Scarthgap (5.0.4)
>> - Kirkstone (4.0.22)
>>
>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>> ---
>> @Quentin: adding Walnascar as the devbranch does the trick and adds
>> Styhead to the switchers menu. And indeed, walnascar _is_ the current
>> dev branch, not styhead.
> 
> The patch looks good thanks. I just wanted to mention:
> 
> https://git.yoctoproject.org/yocto-autobuilder-helper/commit/?id=51d842b5e0b14e5439b5c89ec314886218a62ebf
> 
> i.e. we do have a script in helper which we're also doing some of this
> in. I think that script goes on to generation a json file which powers
> bits of the main website.
> 
> Could we try and converge things. The reason for adding this script was
> to get the website code somewhere more accessible so we are slowly
> making progress towards that...
> 

We should be able to build the docs with only code from yocto-docs git 
repo and without network access.

One of the issues we have in the docs is that there are releases without 
tags in yocto-docs but we still have some migration 
manuals/documentation for those, c.f. missing_tags in the script.

Less duplication across multiple repos to build is a good thing though :)

Cheers,
Quentin

> Cheers,
> 
> Richard
Richard Purdie Oct. 25, 2024, 2:28 p.m. UTC | #4
On Fri, 2024-10-25 at 16:24 +0200, Quentin Schulz wrote:
> Hi Antonin, Richard,
> 
> On 10/25/24 4:16 PM, Richard Purdie wrote:
> > On Fri, 2024-10-25 at 16:07 +0200, Antonin Godard via
> > lists.yoctoproject.org wrote:
> > > Remove dunfell and nanbield which are not supported anymore.
> > > Add styhead as an active release.
> > > Set walnascar as the dev branch.
> > > 
> > > The switcher menu now contains:
> > > - Unstable (dev)
> > > - Styhead (5.1)
> > > - Scarthgap (5.0.4)
> > > - Kirkstone (4.0.22)
> > > 
> > > Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> > > ---
> > > @Quentin: adding Walnascar as the devbranch does the trick and adds
> > > Styhead to the switchers menu. And indeed, walnascar _is_ the current
> > > dev branch, not styhead.
> > 
> > The patch looks good thanks. I just wanted to mention:
> > 
> > https://git.yoctoproject.org/yocto-autobuilder-helper/commit/?id=51d842b5e0b14e5439b5c89ec314886218a62ebf
> > 
> > i.e. we do have a script in helper which we're also doing some of this
> > in. I think that script goes on to generation a json file which powers
> > bits of the main website.
> > 
> > Could we try and converge things. The reason for adding this script was
> > to get the website code somewhere more accessible so we are slowly
> > making progress towards that...
> > 
> 
> We should be able to build the docs with only code from yocto-docs git 
> repo and without network access.
> 
> One of the issues we have in the docs is that there are releases without 
> tags in yocto-docs but we still have some migration 
> manuals/documentation for those, c.f. missing_tags in the script.

We should probably add those. I can't remember what was blocking us on
doing that...

> 
> Less duplication across multiple repos to build is a good thing though :)

One possibility is an additional make target for docs which does get
the release info from elsewhere and updates things. The autobuilder
docs build could run that but if you were offline, you wouldn't...

Cheers,

Richard
Antonin Godard Oct. 25, 2024, 2:33 p.m. UTC | #5
Hi Quentin,

On Fri Oct 25, 2024 at 4:20 PM CEST, Quentin Schulz wrote:
> Hi Antonin,
>
> On 10/25/24 4:07 PM, Antonin Godard wrote:
>> Remove dunfell and nanbield which are not supported anymore.
>> Add styhead as an active release.
>> Set walnascar as the dev branch.
>>
>> The switcher menu now contains:
>> - Unstable (dev)
>> - Styhead (5.1)
>> - Scarthgap (5.0.4)
>> - Kirkstone (4.0.22)
>>
>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>> ---
>> @Quentin: adding Walnascar as the devbranch does the trick and adds
>> Styhead to the switchers menu. And indeed, walnascar _is_ the current
>> dev branch, not styhead.
>> ---
>> Changes in v2:
>> - Add Walnascar as the devbranch, which adds Styhead to the switchers
>>    menu.
>> - Update poky.yaml.in.
>> - Link to v1: https://lore.kernel.org/r/20241025-update-switchers-v1-1-5e540ead879b@bootlin.com
>> ---
>>   documentation/poky.yaml.in    | 12 ++++++------
>>   documentation/set_versions.py |  8 +++++---
>>   2 files changed, 11 insertions(+), 9 deletions(-)
>>
>> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
>> index 0c04b615eae07e722982ad8808b8d4ff228b5cb5..c770318f2be76cca3ea23a25d819ace46d157b4c 100644
>> --- a/documentation/poky.yaml.in
>> +++ b/documentation/poky.yaml.in
>
> IIRC parts of this file are now autogenerated, c.f. the replacements
> dict in set_versions.py.
>
> So it's likely unnecessary, but... it doesn't hurt :)
>
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
>
> Thanks!
> Quentin

Thank you!
Antonin

--
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
Quentin Schulz Oct. 25, 2024, 2:37 p.m. UTC | #6
Hi Richard,

On 10/25/24 4:28 PM, Richard Purdie wrote:
> On Fri, 2024-10-25 at 16:24 +0200, Quentin Schulz wrote:
>> Hi Antonin, Richard,
>>
>> On 10/25/24 4:16 PM, Richard Purdie wrote:
>>> On Fri, 2024-10-25 at 16:07 +0200, Antonin Godard via
>>> lists.yoctoproject.org wrote:
>>>> Remove dunfell and nanbield which are not supported anymore.
>>>> Add styhead as an active release.
>>>> Set walnascar as the dev branch.
>>>>
>>>> The switcher menu now contains:
>>>> - Unstable (dev)
>>>> - Styhead (5.1)
>>>> - Scarthgap (5.0.4)
>>>> - Kirkstone (4.0.22)
>>>>
>>>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>>>> ---
>>>> @Quentin: adding Walnascar as the devbranch does the trick and adds
>>>> Styhead to the switchers menu. And indeed, walnascar _is_ the current
>>>> dev branch, not styhead.
>>>
>>> The patch looks good thanks. I just wanted to mention:
>>>
>>> https://git.yoctoproject.org/yocto-autobuilder-helper/commit/?id=51d842b5e0b14e5439b5c89ec314886218a62ebf
>>>
>>> i.e. we do have a script in helper which we're also doing some of this
>>> in. I think that script goes on to generation a json file which powers
>>> bits of the main website.
>>>
>>> Could we try and converge things. The reason for adding this script was
>>> to get the website code somewhere more accessible so we are slowly
>>> making progress towards that...
>>>
>>
>> We should be able to build the docs with only code from yocto-docs git
>> repo and without network access.
>>
>> One of the issues we have in the docs is that there are releases without
>> tags in yocto-docs but we still have some migration
>> manuals/documentation for those, c.f. missing_tags in the script.
> 
> We should probably add those. I can't remember what was blocking us on
> doing that...
> 

Someone having the time and courage to figure out which commit is to be 
tagged for each forgotten release and then tagging it :)

Cheers,
Quentin
Richard Purdie Oct. 25, 2024, 4:46 p.m. UTC | #7
On Fri, 2024-10-25 at 16:37 +0200, Quentin Schulz wrote:
> Hi Richard,
> 
> On 10/25/24 4:28 PM, Richard Purdie wrote:
> > On Fri, 2024-10-25 at 16:24 +0200, Quentin Schulz wrote:
> > > Hi Antonin, Richard,
> > > 
> > > On 10/25/24 4:16 PM, Richard Purdie wrote:
> > > > On Fri, 2024-10-25 at 16:07 +0200, Antonin Godard via
> > > > lists.yoctoproject.org wrote:
> > > > > Remove dunfell and nanbield which are not supported anymore.
> > > > > Add styhead as an active release.
> > > > > Set walnascar as the dev branch.
> > > > > 
> > > > > The switcher menu now contains:
> > > > > - Unstable (dev)
> > > > > - Styhead (5.1)
> > > > > - Scarthgap (5.0.4)
> > > > > - Kirkstone (4.0.22)
> > > > > 
> > > > > Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> > > > > ---
> > > > > @Quentin: adding Walnascar as the devbranch does the trick
> > > > > and adds
> > > > > Styhead to the switchers menu. And indeed, walnascar _is_ the
> > > > > current
> > > > > dev branch, not styhead.
> > > > 
> > > > The patch looks good thanks. I just wanted to mention:
> > > > 
> > > > https://git.yoctoproject.org/yocto-autobuilder-helper/commit/?id=51d842b5e0b14e5439b5c89ec314886218a62ebf
> > > > 
> > > > i.e. we do have a script in helper which we're also doing some
> > > > of this
> > > > in. I think that script goes on to generation a json file which
> > > > powers
> > > > bits of the main website.
> > > > 
> > > > Could we try and converge things. The reason for adding this
> > > > script was
> > > > to get the website code somewhere more accessible so we are
> > > > slowly
> > > > making progress towards that...
> > > > 
> > > 
> > > We should be able to build the docs with only code from yocto-
> > > docs git
> > > repo and without network access.
> > > 
> > > One of the issues we have in the docs is that there are releases
> > > without
> > > tags in yocto-docs but we still have some migration
> > > manuals/documentation for those, c.f. missing_tags in the script.
> > 
> > We should probably add those. I can't remember what was blocking us
> > on
> > doing that...
> > 
> 
> Someone having the time and courage to figure out which commit is to
> be tagged for each forgotten release and then tagging it :)

af9bf61a54c059e72c807ca8061a57d6fe74c5fa yocto-3.1
bd140f0f9988fbd55f428a8ba7a54ae68716a33a yocto-3.1.1
17cc71a8f76e7b3245c9008646bb3961ad85261a yocto-3.1.2
26c5549580e108c40aa7c95860d12c675596820c yocto-2.5.3
65207b6afa6df7d82cd3482d61f10b308da6fac7 yocto-1.7
29a30b9ace435ad0c6260e026033ac1a86314d73 yocto-1.7.1
326a8009ca0bef0a4686510bb521010d8f58ac81 yocto-1.6
dd281ed7ce0cdfc30b87dc6b48077a55cfe09929 yocto-1.6.1
812bf8e2c91c4dd14a2245509ea7008a24e90835 yocto-1.6.2
228887f330f05037524e8982394a07cfd03d660b yocto-1.5
2e0cf7319ec72e8ccbf93b4a6602f3ab20259588 yocto-1.5.2
e61b251da0d8225f7497b2b7a0a8c8d1510a429b yocto-1.5.3
34d5133e8b97a8debb2458733a2b15ad3f0988d0 yocto-1.5.4
4470f32879ea9ad21c1d4821de6a8aa5740bbc6b yocto-1.4.4
3eb430258ba1106dedb584abbbb4fb4aeb2f09cc yocto-1.2
f0c7f750c3eccd4401e14f7415340e9675052d4d yocto-1.1
753e3eb80b1fa6148e12f9eb93d23f4613b6be05 yocto-1.1.1
fc4cb441031bca79f09203f9268f0528078fb652 yocto-1.1.2
8b6416db1e04af83ecdf57522240ac859d5d8031 yocto-1.0

It isn't so bad. In poky, "git checkout yocto-XXX", then git log
documentation/ and see what the docs revision was.

Around 1.0 it gets messy as the docs repo wasn't separate!

I didn't find them all but this should clean things up a bit. I've
asked Michael if he can add the tags.

Cheers,

Richard
diff mbox series

Patch

diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index 0c04b615eae07e722982ad8808b8d4ff228b5cb5..c770318f2be76cca3ea23a25d819ace46d157b4c 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -1,10 +1,10 @@ 
-DISTRO : "5.0"
-DISTRO_NAME_NO_CAP : "scarthgap"
-DISTRO_NAME : "Scarthgap"
-DISTRO_NAME_NO_CAP_MINUS_ONE : "nanbield"
+DISTRO : "5.1"
+DISTRO_NAME_NO_CAP : "styhead"
+DISTRO_NAME : "Styhead"
+DISTRO_NAME_NO_CAP_MINUS_ONE : "scarthgap"
 DISTRO_NAME_NO_CAP_LTS : "scarthgap"
-YOCTO_DOC_VERSION : "5.0"
-DISTRO_REL_TAG : "yocto-5.0"
+YOCTO_DOC_VERSION : "5.1"
+DISTRO_REL_TAG : "yocto-5.1"
 DOCCONF_VERSION : "dev"
 BITBAKE_SERIES : ""
 YOCTO_DL_URL : "https://downloads.yoctoproject.org"
diff --git a/documentation/set_versions.py b/documentation/set_versions.py
index dec078083441263cb1350532b2749f5ee222d555..376337e7b544829e7f65cb5dcacda635980ee28d 100755
--- a/documentation/set_versions.py
+++ b/documentation/set_versions.py
@@ -26,9 +26,9 @@  ourversion = None
 if len(sys.argv) == 2:
     ourversion = sys.argv[1]
 
-activereleases = ["scarthgap", "nanbield", "kirkstone", "dunfell"]
-devbranch = "styhead"
-ltsseries = ["scarthgap", "kirkstone", "dunfell"]
+activereleases = ["styhead", "scarthgap", "kirkstone"]
+devbranch = "walnascar"
+ltsseries = ["scarthgap", "kirkstone"]
 
 # used by run-docs-builds to get the default page
 if ourversion == "getlatest":
@@ -36,6 +36,7 @@  if ourversion == "getlatest":
     sys.exit(0)
 
 release_series = collections.OrderedDict()
+release_series["walnascar"] = "5.2"
 release_series["styhead"] = "5.1"
 release_series["scarthgap"] = "5.0"
 release_series["nanbield"] = "4.3"
@@ -69,6 +70,7 @@  release_series["laverne"] = "0.9"
 
 
 bitbake_mapping = {
+    "walnascar" : "2.12",
     "styhead" : "2.10",
     "scarthgap" : "2.8",
     "nanbield" : "2.6",