[PATCH] [honister] conf: update for release 3.4

[PATCH] [honister] conf: update for release 3.4

[Quentin Schulz]

conf.py:
* set version to 3.4

switchers.js:
* add 3.4 release
* update 'dev' to 3.5

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---

Not tested + Assumed to be enough
No need to wait for the new release as the honister branch will be
integrated in the docs only when tagged but let's make sure we don't
forget to do this change before tagging a release.

 documentation/conf.py                    | 2 +-
 documentation/sphinx-static/switchers.js | 3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/documentation/conf.py b/documentation/conf.py
index 8e0847938..104b49ea0 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -16,7 +16,7 @@ import os
 import sys
 import datetime
 
-current_version = "dev"
+current_version = "3.4"
 
 # String used in sidebar
 version = 'Version: ' + current_version
diff --git a/documentation/sphinx-static/switchers.js b/documentation/sphinx-static/switchers.js
index 1e37b625a..6038dbb5a 100644
--- a/documentation/sphinx-static/switchers.js
+++ b/documentation/sphinx-static/switchers.js
@@ -2,7 +2,8 @@
   'use strict';
 
   var all_versions = {
-    'dev': 'dev (3.4)',
+    'dev': 'dev (3.5)',
+    '3.4': '3.4',
     '3.3.3': '3.3.3',
     '3.2.4': '3.2.4',
     '3.1.11': '3.1.11',
-- 
2.31.1

Re: [PATCH] [honister] conf: update for release 3.4

[Quentin Schulz]

Hi all,

I specifically sent this patch before we tagged the release to be sure
we don't have the same issue as on 3.3. But we do have the same issue
now that yocto-3.4 is tagged and this patch is not in...

Can we settle on a solution? I assume moving git tags is deemed to risky
which I can agree with but the issue(s) need to be resolved. Can we
patch the tagged release from within yocto-autobuilder-helper doc-building
process?

Cheers,
Quentin

On Thu, Oct 21, 2021 at 10:43:32AM +0200, Quentin Schulz wrote:
> conf.py:
> * set version to 3.4
> 
> switchers.js:
> * add 3.4 release
> * update 'dev' to 3.5
> 
> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
> ---
> 
> Not tested + Assumed to be enough
> No need to wait for the new release as the honister branch will be
> integrated in the docs only when tagged but let's make sure we don't
> forget to do this change before tagging a release.
> 
>  documentation/conf.py                    | 2 +-
>  documentation/sphinx-static/switchers.js | 3 ++-
>  2 files changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/documentation/conf.py b/documentation/conf.py
> index 8e0847938..104b49ea0 100644
> --- a/documentation/conf.py
> +++ b/documentation/conf.py
> @@ -16,7 +16,7 @@ import os
>  import sys
>  import datetime
>  
> -current_version = "dev"
> +current_version = "3.4"
>  
>  # String used in sidebar
>  version = 'Version: ' + current_version
> diff --git a/documentation/sphinx-static/switchers.js b/documentation/sphinx-static/switchers.js
> index 1e37b625a..6038dbb5a 100644
> --- a/documentation/sphinx-static/switchers.js
> +++ b/documentation/sphinx-static/switchers.js
> @@ -2,7 +2,8 @@
>    'use strict';
>  
>    var all_versions = {
> -    'dev': 'dev (3.4)',
> +    'dev': 'dev (3.5)',
> +    '3.4': '3.4',
>      '3.3.3': '3.3.3',
>      '3.2.4': '3.2.4',
>      '3.1.11': '3.1.11',
> -- 
> 2.31.1
> 

Re: [docs] [PATCH] [honister] conf: update for release 3.4

[Richard Purdie]

On Wed, 2021-10-27 at 12:40 +0200, Quentin Schulz wrote:
> I specifically sent this patch before we tagged the release to be sure
> we don't have the same issue as on 3.3. But we do have the same issue
> now that yocto-3.4 is tagged and this patch is not in...

Sorry, too many different moving pieces to track with release :(

Whilst it was sent before tagging, the release was already in QA and the
revisions used in QA are used in the final release tags as if we don't that
causes a different set of problems/concerns.

> Can we settle on a solution? I assume moving git tags is deemed to risky
> which I can agree with but the issue(s) need to be resolved. Can we
> patch the tagged release from within yocto-autobuilder-helper doc-building
> process?

To clear this up for now I will take patching in the doc building process with a
patch or sed command.

Cheers,

Richard

Re: [docs] [PATCH] [honister] conf: update for release 3.4

[Quentin Schulz]

Hi Richard,

On Wed, Oct 27, 2021 at 11:45:35AM +0100, Richard Purdie wrote:
> On Wed, 2021-10-27 at 12:40 +0200, Quentin Schulz wrote:
> > I specifically sent this patch before we tagged the release to be sure
> > we don't have the same issue as on 3.3. But we do have the same issue
> > now that yocto-3.4 is tagged and this patch is not in...
> 
> Sorry, too many different moving pieces to track with release :(
> 
> Whilst it was sent before tagging, the release was already in QA and the
> revisions used in QA are used in the final release tags as if we don't that
> causes a different set of problems/concerns.
> 

It's alright, just a bit sad that we could have done things better for
this release and missed the opportunity.

This however highlights an issue in the release process for the documentation.
Let's make sure we lower the probability of this issue to happen again
in next releases.
I guess it'd make sense to work on some helper script for releases/branch
maintainers so we don't forget some bits? I'll try to come up with
something :)

> > Can we settle on a solution? I assume moving git tags is deemed to risky
> > which I can agree with but the issue(s) need to be resolved. Can we
> > patch the tagged release from within yocto-autobuilder-helper doc-building
> > process?
> 
> To clear this up for now I will take patching in the doc building process with a
> patch or sed command.
> 

I'll prepare a patch for patchng the release in the
yocto-autobuilder-helper doc-building process and send that ASAP. If not
sent by the end of the week, please scream at me.

Cheers,
Quentin

Re: [docs] [PATCH] [honister] conf: update for release 3.4

[Quentin Schulz]

Hi all,

Just to make sure the discussion does not get mistaken as an agreement
on this patch being dropped, can we still merge this one patch in honister
branch please :) ? It still applies even though we missed the release tag.

Cheers,
Quentin

On Wed, Oct 27, 2021 at 12:52:43PM +0200, Quentin Schulz wrote:
> Hi Richard,
> 
> On Wed, Oct 27, 2021 at 11:45:35AM +0100, Richard Purdie wrote:
> > On Wed, 2021-10-27 at 12:40 +0200, Quentin Schulz wrote:
> > > I specifically sent this patch before we tagged the release to be sure
> > > we don't have the same issue as on 3.3. But we do have the same issue
> > > now that yocto-3.4 is tagged and this patch is not in...
> > 
> > Sorry, too many different moving pieces to track with release :(
> > 
> > Whilst it was sent before tagging, the release was already in QA and the
> > revisions used in QA are used in the final release tags as if we don't that
> > causes a different set of problems/concerns.
> > 
> 
> It's alright, just a bit sad that we could have done things better for
> this release and missed the opportunity.
> 
> This however highlights an issue in the release process for the documentation.
> Let's make sure we lower the probability of this issue to happen again
> in next releases.
> I guess it'd make sense to work on some helper script for releases/branch
> maintainers so we don't forget some bits? I'll try to come up with
> something :)
> 
> > > Can we settle on a solution? I assume moving git tags is deemed to risky
> > > which I can agree with but the issue(s) need to be resolved. Can we
> > > patch the tagged release from within yocto-autobuilder-helper doc-building
> > > process?
> > 
> > To clear this up for now I will take patching in the doc building process with a
> > patch or sed command.
> > 
> 
> I'll prepare a patch for patchng the release in the
> yocto-autobuilder-helper doc-building process and send that ASAP. If not
> sent by the end of the week, please scream at me.
> 
> Cheers,
> Quentin

> 
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#2050): https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_message_2050&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=U9q4K1YP08t9YtMVLPvDSS7TzYccgrrgJEMZs1MryCBQci7jrUIj7ztk7n19OOzo&s=Adx6-VwSObnDF3Q2C6RCQ_ww8XahPVCDYPZSS4mzBI4&e= 
> Mute This Topic: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_mt_86485182_6293953&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=U9q4K1YP08t9YtMVLPvDSS7TzYccgrrgJEMZs1MryCBQci7jrUIj7ztk7n19OOzo&s=BNdewZgB9JAQpu7SroEKuJbb4l1M8DVthR6VrgxRE0M&e= 
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_unsub&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=U9q4K1YP08t9YtMVLPvDSS7TzYccgrrgJEMZs1MryCBQci7jrUIj7ztk7n19OOzo&s=memvkvhhp_x3w4x-O1Aa5JLafiJEl57xGj2aPD_obnU&e=  [quentin.schulz@theobroma-systems.com]
> -=-=-=-=-=-=-=-=-=-=-=-
> 

Re: [docs] [PATCH] [honister] conf: update for release 3.4

[Michael Opdenacker]

Hi Quentin,

On 10/27/21 1:28 PM, Quentin Schulz wrote:
> Hi all,
>
> Just to make sure the discussion does not get mistaken as an agreement
> on this patch being dropped, can we still merge this one patch in honister
> branch please :) ? It still applies even though we missed the release tag.

I can take care of merging it in honister-next so that Richard can take
it in honister.

However, I also see that Hardknott
(http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/sphinx-static/switchers.js?h=hardknott)
and Dunfell
(http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/sphinx-static/switchers.js?h=dunfell)
should be updated too.

Did I understand correctly?

Cheers
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH] [honister] conf: update for release 3.4

[Quentin Schulz]

Hi Michael,

On October 29, 2021 6:15:08 PM GMT+02:00, Michael Opdenacker <michael.opdenacker@bootlin.com> wrote:
>Hi Quentin,
>
>On 10/27/21 1:28 PM, Quentin Schulz wrote:
>> Hi all,
>>
>> Just to make sure the discussion does not get mistaken as an agreement
>> on this patch being dropped, can we still merge this one patch in honister
>> branch please :) ? It still applies even though we missed the release tag.
>
>I can take care of merging it in honister-next so that Richard can take
>it in honister.
>
>However, I also see that Hardknott
>(http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/sphinx-static/switchers.js?h=hardknott)
>and Dunfell
>(http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/sphinx-static/switchers.js?h=dunfell)
>should be updated too.
>
>Did I understand correctly?
>

Switchers.js does not need to be updated as only the one from the master branch is taken and copied to all other branches and tags by the autobuilder. But you just saw why we want to get this file out of the docs so maintainers don't have to care about this (and also, for EOL releases).

The documentation/conf.py seems up-to-date for those branches so I think nothing needs to be done aside from this patch in honister.

Cheers,
Quentin

Re: [docs] [PATCH] [honister] conf: update for release 3.4

[Quentin Schulz]

Hi all,

Gentle ping.

Cheers,
Quentin