Skip to contentSkip to conversation

migration-guides: stop including documents with ".. include"

PATCH In review [email protected] 3 participants 5 messages Apr 27, 2022 – Jul 18, 2022 1 message not in the archive

lore
Share & tools
lore
#1 lore raw

PATCH 1/1 migration-guides: stop including documents with ".. include"

In reply to a message not in the archive

From: Michael Opdenacker <[email protected]>

This prevented variables from being substituted through the code in yocto-vars.py, at least in the files included this way.

---
 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
documentation/migration-guides/index.rst +2 -2
index 20c6ab9d4e..4597506d05 100644
@@ -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
documentation/migration-guides/migration-3.4.rst +0 -6
index c22ea814d6..d57c955eb4 100644
@@ -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
documentation/migration-guides/migration-4.0.rst +0 -2
index d737b9d431..a8e6b4c331 100644
@@ -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
documentation/migration-guides/release-3.4.rst new file +10 -0
new file mode 100644
index 0000000000..81476c4adb
@@ -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
+
documentation/migration-guides/release-4.0.rst new file +7 -0
new file mode 100644
index 0000000000..7062f9d241
@@ -0,0 +1,7 @@
+Release 4.0 (kirkstone)
+=======================
+
+.. toctree::
+
+   migration-4.0
+   release-notes-4.0
Signature · 1 line
2.25.1
#2 lore raw

Hi Michael,

Quoted 2 lines · Michael Opdenacker via lists.yoctoproject.org

From: Michael Opdenacker <[email protected]>

Technically incorrect, it's Nicolas who's the author :)

git commit --author="Nicolas Dechesne <[email protected]>"

is the line to specify an author.

Quoted 3 lines

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

Quoted 95 lines
---
  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

documentation/migration-guides/index.rst +2 -2
index 20c6ab9d4e..4597506d05 100644
@@ -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
documentation/migration-guides/migration-3.4.rst +0 -6
index c22ea814d6..d57c955eb4 100644
@@ -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
documentation/migration-guides/migration-4.0.rst +0 -2
index d737b9d431..a8e6b4c331 100644
@@ -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
documentation/migration-guides/release-3.4.rst new file +10 -0
new file mode 100644
index 0000000000..81476c4adb
@@ -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
+
documentation/migration-guides/release-4.0.rst new file +7 -1
new file mode 100644
index 0000000000..7062f9d241
@@ -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: [email protected]
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= [[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-

#3 lore raw
Quoted 10 lines · Quentin Schulz

Hi Michael,

Quoted 2 lines · Michael Opdenacker via lists.yoctoproject.org

From: Michael Opdenacker <[email protected]>

Technically incorrect, it's Nicolas who's the author :)

git commit --author="Nicolas Dechesne <[email protected]>"

heh.. I don't mind either way.. I could have sent a proper patch too, i quickly sent it to share with everyone..

Quoted 7 lines

is the line to specify an author.

Quoted 3 lines

This prevented variables from being substituted through the code in yocto-vars.py, at least in the files included this way.

Quoted 9 lines

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..

Quoted 114 lines

I think a proper bug report should be filed to Sphinx though.

Cheers,
Quentin

Quoted 9 lines
---
  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(-)

Review

Quoted 4 lines

create mode 100644 documentation/migration-guides/release-3.4.rst create mode 100644 documentation/migration-guides/release-4.0.rst

(quoted diff) +0 -0

b/documentation/migration-guides/index.rst

documentation/migration-guides/index.rst to move to one release of the Yocto Project from the

Quoted 4 lines

index 20c6ab9d4e..4597506d05 100644

documentation/migration-guides/index.rst +0 -0
@@ -12,8 +12,8 @@ to move to one release of the Yocto Project from the

previous one.

Review

Quoted 11 lines
documentation/migration-guides/index.rst +2 -2
  .. toctree::
 
     migration-general
-   migration-4.0
-   migration-3.4
+   release-4.0
+   release-3.4
     migration-3.3
     migration-3.2
     migration-3.1
(quoted diff) +0 -0

b/documentation/migration-guides/migration-3.4.rst

Review

Quoted 18 lines

index c22ea814d6..d57c955eb4 100644

documentation/migration-guides/migration-3.4.rst +0 -6
@@ -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
(quoted diff) +0 -0

b/documentation/migration-guides/migration-4.0.rst

documentation/migration-guides/migration-4.0.rst Miscellaneous changes · line 265

Quoted 5 lines

index d737b9d431..a8e6b4c331 100644

documentation/migration-guides/migration-4.0.rst +0 -0
@@ -265,5 +265,3 @@ Miscellaneous changes
    when parsing recipes. Any code depending on the previous behaviour

will no longer

documentation/migration-guides/migration-4.0.rst Miscellaneous changes · line 266

Quoted 1 line
documentation/migration-guides/migration-4.0.rst +0 -0
    work - change any such code to explicitly use appropriate path

variables instead.

Review

Quoted 4 lines
documentation/migration-guides/migration-4.0.rst +0 -2
-
-.. include:: release-notes-4.0.rst
(quoted diff) +0 -0

b/documentation/migration-guides/release-3.4.rst

Review

Quoted 16 lines

new file mode 100644
index 0000000000..81476c4adb

documentation/migration-guides/release-3.4.rst new file +10 -0
@@ -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
+
(quoted diff) +0 -0

b/documentation/migration-guides/release-4.0.rst

Quoted 16 lines

new file mode 100644
index 0000000000..7062f9d241

documentation/migration-guides/release-4.0.rst new file +7 -1
@@ -0,0 +1,7 @@
+Release 4.0 (kirkstone)
+=======================
+
+.. toctree::
+
+   migration-4.0
+   release-notes-4.0
 
 
 
-=-=-=-=-=-=-=-=-=-=-=-
Quoted 2 lines

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=

Quoted 1 line

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=

Quoted 2 lines

Group Owner: [email protected]
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=
[[email protected]]

Quoted 2 lines

-=-=-=-=-=-=-=-=-=-=-=-

#4 lore raw
Quoted 12 lines · Nicolas Dechesne

On Wed, Apr 27, 2022 at 2:51 PM Quentin Schulz
<[email protected]> wrote:

Hi Michael,

On 4/27/22 14:33, Michael Opdenacker via lists.yoctoproject.org
<http://lists.yoctoproject.org> wrote:
> From: Michael Opdenacker <[email protected]> >

Quoted 7 lines

Technically incorrect, it's Nicolas who's the author :)

git commit --author="Nicolas Dechesne <[email protected]>"

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.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#5 lore raw
In reply to Quentin Schulz
Quoted 12 lines · Quentin Schulz

Hi Michael,

Quoted 2 lines · Michael Opdenacker via lists.yoctoproject.org

From: Michael Opdenacker <[email protected]>

Technically incorrect, it's Nicolas who's the author :)

git commit --author="Nicolas Dechesne <[email protected]>"

is the line to specify an author.

Quoted 8 lines
Quoted 3 lines

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://urldefense.proofpoint.com/v2/url?u=https-3A__www.sphinx-2Ddoc.org_en_master_extdev_appapi.html-23event-2Dhtml-2Dpage-2Dcontext&d=DwICaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=e6PKnMnOMqKi4BV3-hST9a-fE11stVJHZpZN9uR5tqNa5vi1rMiE0ejzbI6SanFy&s=_JSWno2Y5lWBPelMgJ6iAVroNBXBmbcZViWJNAGJxRQ&e= 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.

FYI, just filed a bug report: https://github.com/sphinx-doc/sphinx/issues/10678 (better late than never :) )

Cheers,
Quentin