* Re: [docs] [yocto] [ANNOUNCEMENT] Yocto Project 4.0 is Released [not found] ` <9d339a31-a732-3de3-53ee-45a1054d5c92@bootlin.com> @ 2022-04-27 7:51 ` Richard Purdie 2022-04-27 7:52 ` Michael Opdenacker 0 siblings, 1 reply; 6+ messages in thread From: Richard Purdie @ 2022-04-27 7:51 UTC (permalink / raw) To: michael.opdenacker, Lee Chee Yang; +Cc: YP docs mailing list On Wed, 2022-04-27 at 09:41 +0200, Michael Opdenacker via lists.yoctoproject.org wrote: > > Thanks for the great news! > Shouldn't we highlight in the documentation > (https://docs.yoctoproject.org/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone) > that this is our new Long Term Support release? > > This would help to spread the news. Please. Perhaps you could help us there? :) Cheers, Richard ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [docs] [yocto] [ANNOUNCEMENT] Yocto Project 4.0 is Released 2022-04-27 7:51 ` [docs] [yocto] [ANNOUNCEMENT] Yocto Project 4.0 is Released Richard Purdie @ 2022-04-27 7:52 ` Michael Opdenacker 0 siblings, 0 replies; 6+ messages in thread From: Michael Opdenacker @ 2022-04-27 7:52 UTC (permalink / raw) To: Richard Purdie, Lee Chee Yang; +Cc: YP docs mailing list On 4/27/22 09:51, Richard Purdie wrote: > On Wed, 2022-04-27 at 09:41 +0200, Michael Opdenacker via lists.yoctoproject.org > wrote: >> Thanks for the great news! >> Shouldn't we highlight in the documentation >> (https://docs.yoctoproject.org/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone) >> that this is our new Long Term Support release? >> >> This would help to spread the news. > Please. Perhaps you could help us there? :) Sure, I'll post a patch :) Thanks Michael. -- Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com ^ permalink raw reply [flat|nested] 6+ messages in thread
[parent not found: <90b05148-5215-584e-0080-24cd411b2ba8@sancloud.com>]
[parent not found: <CANPvuR=Sp+tuOAmFRzw207e_1+jNzOyR1AST9J=jh7_KgsOS2Q@mail.gmail.com>]
[parent not found: <9790963d-0e8d-c713-cc97-ab6f8ca4fef3@bootlin.com>]
* Re: [docs] [yocto] [ANNOUNCEMENT] Yocto Project 4.0 is Released [not found] ` <9790963d-0e8d-c713-cc97-ab6f8ca4fef3@bootlin.com> @ 2022-04-27 11:17 ` Nicolas Dechesne 2022-04-27 11:27 ` Nicolas Dechesne 0 siblings, 1 reply; 6+ messages in thread From: Nicolas Dechesne @ 2022-04-27 11:17 UTC (permalink / raw) To: michael.opdenacker Cc: Jose Quaresma, Paul Barker, Lee, Chee Yang, yocto, YP docs mailing list [-- Attachment #1: Type: text/plain, Size: 1500 bytes --] On Wed, Apr 27, 2022 at 10:59 AM Michael Opdenacker via lists.yoctoproject.org <michael.opdenacker= bootlin.com@lists.yoctoproject.org> wrote: > > On 4/27/22 10:18, Jose Quaresma wrote: > > > > > > In the HTML page it is fine, the &YOCTO_DOC_VERSION is 4.0 > > > https://docs.yoctoproject.org/4.0/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone > > > > In the dev version the &YOCTO_DOC_VERSION is not replaced by dev > > > https://docs.yoctoproject.org/dev/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone > > > That's *very weird* because the substitution happened in > https://docs.yoctoproject.org/dev/brief-yoctoprojectqs/index.html but > not in > > https://docs.yoctoproject.org/dev/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone > (same version). > > When I build the docs locally things look fine. Any ideas what could > cause this? > I can reproduce the issue when building locally. I am using Sphinx==4.4.0 > > Michael. > > -- > Michael Opdenacker, Bootlin > Embedded Linux and Kernel engineering > https://bootlin.com > > > -=-=-=-=-=-=-=-=-=-=-=- > Links: You receive all messages sent to this group. > View/Reply Online (#2876): > https://lists.yoctoproject.org/g/docs/message/2876 > Mute This Topic: https://lists.yoctoproject.org/mt/90726109/1279857 > Group Owner: docs+owner@lists.yoctoproject.org > Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [ > nicolas.dechesne@linaro.org] > -=-=-=-=-=-=-=-=-=-=-=- > > [-- Attachment #2: Type: text/html, Size: 3224 bytes --] ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [docs] [yocto] [ANNOUNCEMENT] Yocto Project 4.0 is Released 2022-04-27 11:17 ` Nicolas Dechesne @ 2022-04-27 11:27 ` Nicolas Dechesne 2022-04-27 11:56 ` Nicolas Dechesne 0 siblings, 1 reply; 6+ messages in thread From: Nicolas Dechesne @ 2022-04-27 11:27 UTC (permalink / raw) To: michael.opdenacker Cc: Jose Quaresma, Paul Barker, Lee, Chee Yang, yocto, YP docs mailing list [-- Attachment #1: Type: text/plain, Size: 1966 bytes --] On Wed, Apr 27, 2022 at 1:17 PM Nicolas Dechesne < nicolas.dechesne@linaro.org> wrote: > > > On Wed, Apr 27, 2022 at 10:59 AM Michael Opdenacker via > lists.yoctoproject.org <michael.opdenacker= > bootlin.com@lists.yoctoproject.org> wrote: > >> >> On 4/27/22 10:18, Jose Quaresma wrote: >> > >> > >> > In the HTML page it is fine, the &YOCTO_DOC_VERSION is 4.0 >> > >> https://docs.yoctoproject.org/4.0/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone >> > >> > In the dev version the &YOCTO_DOC_VERSION is not replaced by dev >> > >> https://docs.yoctoproject.org/dev/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone >> >> >> That's *very weird* because the substitution happened in >> https://docs.yoctoproject.org/dev/brief-yoctoprojectqs/index.html but >> not in >> >> https://docs.yoctoproject.org/dev/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone >> (same version). >> >> When I build the docs locally things look fine. Any ideas what could >> cause this? >> > > I can reproduce the issue when building locally. I am using Sphinx==4.4.0 > oh... It's because the file release-notes-4.0.rst is included with a ..include statement. The variable mapping is done with a custom Sphinx extension (yocto-vars.py) which is triggered for the 'source-read' event. So perhaps this event is not triggered when using an include statement.. let me check more on that.. > > >> >> Michael. >> >> -- >> Michael Opdenacker, Bootlin >> Embedded Linux and Kernel engineering >> https://bootlin.com >> >> >> -=-=-=-=-=-=-=-=-=-=-=- >> Links: You receive all messages sent to this group. >> View/Reply Online (#2876): >> https://lists.yoctoproject.org/g/docs/message/2876 >> Mute This Topic: https://lists.yoctoproject.org/mt/90726109/1279857 >> Group Owner: docs+owner@lists.yoctoproject.org >> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [ >> nicolas.dechesne@linaro.org] >> -=-=-=-=-=-=-=-=-=-=-=- >> >> [-- Attachment #2: Type: text/html, Size: 4199 bytes --] ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [docs] [yocto] [ANNOUNCEMENT] Yocto Project 4.0 is Released 2022-04-27 11:27 ` Nicolas Dechesne @ 2022-04-27 11:56 ` Nicolas Dechesne 2022-04-27 12:32 ` Michael Opdenacker 0 siblings, 1 reply; 6+ messages in thread From: Nicolas Dechesne @ 2022-04-27 11:56 UTC (permalink / raw) To: michael.opdenacker Cc: Jose Quaresma, Paul Barker, Lee, Chee Yang, yocto, YP docs mailing list [-- Attachment #1: Type: text/plain, Size: 4702 bytes --] On Wed, Apr 27, 2022 at 1:27 PM Nicolas Dechesne < nicolas.dechesne@linaro.org> wrote: > > > On Wed, Apr 27, 2022 at 1:17 PM Nicolas Dechesne < > nicolas.dechesne@linaro.org> wrote: > >> >> >> On Wed, Apr 27, 2022 at 10:59 AM Michael Opdenacker via >> lists.yoctoproject.org <michael.opdenacker= >> bootlin.com@lists.yoctoproject.org> wrote: >> >>> >>> On 4/27/22 10:18, Jose Quaresma wrote: >>> > >>> > >>> > In the HTML page it is fine, the &YOCTO_DOC_VERSION is 4.0 >>> > >>> https://docs.yoctoproject.org/4.0/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone >>> > >>> > In the dev version the &YOCTO_DOC_VERSION is not replaced by dev >>> > >>> https://docs.yoctoproject.org/dev/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone >>> >>> >>> That's *very weird* because the substitution happened in >>> https://docs.yoctoproject.org/dev/brief-yoctoprojectqs/index.html but >>> not in >>> >>> https://docs.yoctoproject.org/dev/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone >>> (same version). >>> >>> When I build the docs locally things look fine. Any ideas what could >>> cause this? >>> >> >> I can reproduce the issue when building locally. I am using Sphinx==4.4.0 >> > > oh... It's because the file release-notes-4.0.rst is included with a > ..include statement. The variable mapping is done with a custom Sphinx > extension (yocto-vars.py) which is triggered for the 'source-read' event. > So perhaps this event is not triggered when using an include statement.. > let me check more on that.. > yes, that seems correct. I don't think we should continue to use the include directive here. Since you try to make one section (for 3.4 and 4.0) with the migration and the release notes, I think something along these lines would work, maybe there is simpler.. diff --git a/documentation/migration-guides/index.rst b/documentation/migration-guides/index.rst index 20c6ab9d4..4597506d0 100644 --- a/documentation/migration-guides/index.rst +++ b/documentation/migration-guides/index.rst @@ -12,8 +12,8 @@ to move to one release of the Yocto Project from the previous one. .. toctree:: migration-general - migration-4.0 - migration-3.4 + release-4.0 + release-3.4 migration-3.3 migration-3.2 migration-3.1 diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index c22ea814d..d57c955eb 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst @@ -1,6 +1,3 @@ -Release 3.4 (honister) -====================== - Migration notes for 3.4 (honister) ---------------------------------- @@ -274,6 +271,3 @@ Miscellaneous examples in :term:`EXTRA_USERS_PARAMS`. -.. include:: release-notes-3.4.rst -.. include:: release-notes-3.4.1.rst -.. include:: release-notes-3.4.2.rst diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst index d737b9d43..a8e6b4c33 100644 --- a/documentation/migration-guides/migration-4.0.rst +++ b/documentation/migration-guides/migration-4.0.rst @@ -265,5 +265,3 @@ Miscellaneous changes when parsing recipes. Any code depending on the previous behaviour will no longer work - change any such code to explicitly use appropriate path variables instead. - -.. include:: release-notes-4.0.rst diff --git a/documentation/migration-guides/release-3.4.rst b/documentation/migration-guides/release-3.4.rst new file mode 100644 index 000000000..81476c4ad --- /dev/null +++ b/documentation/migration-guides/release-3.4.rst @@ -0,0 +1,10 @@ +Release 3.4 (honister) +====================== + +.. toctree:: + + migration-3.4 + release-notes-3.4 + release-notes-3.4.1 + release-notes-3.4.2 + diff --git a/documentation/migration-guides/release-4.0.rst b/documentation/migration-guides/release-4.0.rst new file mode 100644 index 000000000..7062f9d24 --- /dev/null +++ b/documentation/migration-guides/release-4.0.rst @@ -0,0 +1,7 @@ +Release 4.0 (kirkstone) +======================= + +.. toctree:: + + migration-4.0 + release-notes-4.0 > >> >>> >>> Michael. >>> >>> -- >>> Michael Opdenacker, Bootlin >>> Embedded Linux and Kernel engineering >>> https://bootlin.com >>> >>> >>> -=-=-=-=-=-=-=-=-=-=-=- >>> Links: You receive all messages sent to this group. >>> View/Reply Online (#2876): >>> https://lists.yoctoproject.org/g/docs/message/2876 >>> Mute This Topic: https://lists.yoctoproject.org/mt/90726109/1279857 >>> Group Owner: docs+owner@lists.yoctoproject.org >>> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [ >>> nicolas.dechesne@linaro.org] >>> -=-=-=-=-=-=-=-=-=-=-=- >>> >>> [-- Attachment #2: Type: text/html, Size: 7709 bytes --] ^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [docs] [yocto] [ANNOUNCEMENT] Yocto Project 4.0 is Released 2022-04-27 11:56 ` Nicolas Dechesne @ 2022-04-27 12:32 ` Michael Opdenacker 0 siblings, 0 replies; 6+ messages in thread From: Michael Opdenacker @ 2022-04-27 12:32 UTC (permalink / raw) To: Nicolas Dechesne Cc: Jose Quaresma, Paul Barker, Lee, Chee Yang, yocto, YP docs mailing list Hi Nico, On 4/27/22 13:56, Nicolas Dechesne wrote: > > yes, that seems correct. I don't think we should continue to use the > include directive here. Since you try to make one section (for 3.4 and > 4.0) with the migration and the release notes, I think something along > these lines would work, maybe there is simpler.. Good catch! Yes, this works for me. Let me re-send a full patch as a follow-up. Thanks Michael. -- Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com ^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2022-04-27 12:32 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
[not found] <DM5PR1101MB236176E376BD554365050E72B9FA9@DM5PR1101MB2361.namprd11.prod.outlook.com>
[not found] ` <9d339a31-a732-3de3-53ee-45a1054d5c92@bootlin.com>
2022-04-27 7:51 ` [docs] [yocto] [ANNOUNCEMENT] Yocto Project 4.0 is Released Richard Purdie
2022-04-27 7:52 ` Michael Opdenacker
[not found] ` <90b05148-5215-584e-0080-24cd411b2ba8@sancloud.com>
[not found] ` <CANPvuR=Sp+tuOAmFRzw207e_1+jNzOyR1AST9J=jh7_KgsOS2Q@mail.gmail.com>
[not found] ` <9790963d-0e8d-c713-cc97-ab6f8ca4fef3@bootlin.com>
2022-04-27 11:17 ` Nicolas Dechesne
2022-04-27 11:27 ` Nicolas Dechesne
2022-04-27 11:56 ` Nicolas Dechesne
2022-04-27 12:32 ` Michael Opdenacker
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).