Message ID | 20220427123341.228526-1-michael.opdenacker@bootlin.com |
---|---|
State | New |
Headers | show |
Series | migration-guides: stop including documents with ".. include" | expand |
Hi Michael, On 4/27/22 14:33, Michael Opdenacker via lists.yoctoproject.org wrote: > From: Michael Opdenacker <michael.opdenacker@bootlin.com> > Technically incorrect, it's Nicolas who's the author :) git commit --author="Nicolas Dechesne <nicolas.dechesne@linaro.org>" is the line to specify an author. > This prevented variables from being substituted through the > code in yocto-vars.py, at least in the files included this way. > I checked and the file actually gets passed to subst_vars_replace function and the output of that is correct. However, it does not make it to the output of the file where it is included. I cannot explain why without digging deep into Sphinx code. I think we might be able to use https://www.sphinx-doc.org/en/master/extdev/appapi.html#event-html-page-context instead, but haven't looked into it yet and does not seem like a clean way to do it (patching the html after rendering). I think a proper bug report should be filed to Sphinx though. Cheers, Quentin > Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> > Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> > --- > documentation/migration-guides/index.rst | 4 ++-- > documentation/migration-guides/migration-3.4.rst | 6 ------ > documentation/migration-guides/migration-4.0.rst | 2 -- > documentation/migration-guides/release-3.4.rst | 10 ++++++++++ > documentation/migration-guides/release-4.0.rst | 7 +++++++ > 5 files changed, 19 insertions(+), 10 deletions(-) > create mode 100644 documentation/migration-guides/release-3.4.rst > create mode 100644 documentation/migration-guides/release-4.0.rst > > diff --git a/documentation/migration-guides/index.rst b/documentation/migration-guides/index.rst > index 20c6ab9d4e..4597506d05 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 c22ea814d6..d57c955eb4 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 d737b9d431..a8e6b4c331 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 0000000000..81476c4adb > --- /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 0000000000..7062f9d241 > --- /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 > > > > -=-=-=-=-=-=-=-=-=-=-=- > Links: You receive all messages sent to this group. > View/Reply Online (#2888): https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_message_2888&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=J4eIkh9QTwUi1NxoblYJOF6xn9h0aaqhTVBvprxNSQEJ_stG384-Hja2686EHoKk&s=4QOct9PCl-tLB0LFUEZolfPU69tOIaZpx8auklwp1TQ&e= > Mute This Topic: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_mt_90729285_6293953&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=J4eIkh9QTwUi1NxoblYJOF6xn9h0aaqhTVBvprxNSQEJ_stG384-Hja2686EHoKk&s=GygZULWf1tp9XuuuPTuK82vj9HWlK1kPSccs2NdIx_Q&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=J4eIkh9QTwUi1NxoblYJOF6xn9h0aaqhTVBvprxNSQEJ_stG384-Hja2686EHoKk&s=WGN6DdGkiKQXm_ekuEMgilEOs3D4YAU7uIcJZYjTnjk&e= [quentin.schulz@theobroma-systems.com] > -=-=-=-=-=-=-=-=-=-=-=- >
On Wed, Apr 27, 2022 at 2:51 PM Quentin Schulz < quentin.schulz@theobroma-systems.com> wrote: > Hi Michael, > > On 4/27/22 14:33, Michael Opdenacker via lists.yoctoproject.org wrote: > > From: Michael Opdenacker <michael.opdenacker@bootlin.com> > > > > Technically incorrect, it's Nicolas who's the author :) > > git commit --author="Nicolas Dechesne <nicolas.dechesne@linaro.org>" > heh.. I don't mind either way.. I could have sent a proper patch too, i quickly sent it to share with everyone.. > > is the line to specify an author. > > > This prevented variables from being substituted through the > > code in yocto-vars.py, at least in the files included this way. > > > > I checked and the file actually gets passed to subst_vars_replace > function and the output of that is correct. However, it does not make it > to the output of the file where it is included. I cannot explain why > without digging deep into Sphinx code. I think we might be able to use > > https://www.sphinx-doc.org/en/master/extdev/appapi.html#event-html-page-context > instead, but haven't looked into it yet and does not seem like a clean > way to do it (patching the html after rendering). > yeah, i read about that too.. and found https://github.com/sphinx-doc/sphinx/issues/837 which I couldn't make much sense.. > > I think a proper bug report should be filed to Sphinx though. > > Cheers, > Quentin > > > Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> > > Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> > > --- > > documentation/migration-guides/index.rst | 4 ++-- > > documentation/migration-guides/migration-3.4.rst | 6 ------ > > documentation/migration-guides/migration-4.0.rst | 2 -- > > documentation/migration-guides/release-3.4.rst | 10 ++++++++++ > > documentation/migration-guides/release-4.0.rst | 7 +++++++ > > 5 files changed, 19 insertions(+), 10 deletions(-) > > create mode 100644 documentation/migration-guides/release-3.4.rst > > create mode 100644 documentation/migration-guides/release-4.0.rst > > > > diff --git a/documentation/migration-guides/index.rst > b/documentation/migration-guides/index.rst > > index 20c6ab9d4e..4597506d05 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 c22ea814d6..d57c955eb4 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 d737b9d431..a8e6b4c331 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 0000000000..81476c4adb > > --- /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 0000000000..7062f9d241 > > --- /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 > > > > > > > > -=-=-=-=-=-=-=-=-=-=-=- > > Links: You receive all messages sent to this group. > > View/Reply Online (#2888): > https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_message_2888&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=J4eIkh9QTwUi1NxoblYJOF6xn9h0aaqhTVBvprxNSQEJ_stG384-Hja2686EHoKk&s=4QOct9PCl-tLB0LFUEZolfPU69tOIaZpx8auklwp1TQ&e= > > Mute This Topic: > https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_mt_90729285_6293953&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=J4eIkh9QTwUi1NxoblYJOF6xn9h0aaqhTVBvprxNSQEJ_stG384-Hja2686EHoKk&s=GygZULWf1tp9XuuuPTuK82vj9HWlK1kPSccs2NdIx_Q&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=J4eIkh9QTwUi1NxoblYJOF6xn9h0aaqhTVBvprxNSQEJ_stG384-Hja2686EHoKk&s=WGN6DdGkiKQXm_ekuEMgilEOs3D4YAU7uIcJZYjTnjk&e= > [quentin.schulz@theobroma-systems.com] > > -=-=-=-=-=-=-=-=-=-=-=- > > >
On 4/27/22 15:16, Nicolas Dechesne wrote: > > > On Wed, Apr 27, 2022 at 2:51 PM Quentin Schulz > <quentin.schulz@theobroma-systems.com> wrote: > > Hi Michael, > > On 4/27/22 14:33, Michael Opdenacker via lists.yoctoproject.org > <http://lists.yoctoproject.org> wrote: > > From: Michael Opdenacker <michael.opdenacker@bootlin.com> > > > > Technically incorrect, it's Nicolas who's the author :) > > git commit --author="Nicolas Dechesne <nicolas.dechesne@linaro.org>" > > > heh.. I don't mind either way.. I could have sent a proper patch too, > i quickly sent it to share with everyone.. My bad. I didn't update my patch, but in my latest version, Nico is the author, and I'm just a reviewer. Cheers Michael.
diff --git a/documentation/migration-guides/index.rst b/documentation/migration-guides/index.rst index 20c6ab9d4e..4597506d05 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 c22ea814d6..d57c955eb4 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 d737b9d431..a8e6b4c331 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 0000000000..81476c4adb --- /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 0000000000..7062f9d241 --- /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