Message ID | 20220707133317.1202686-1-foss+yocto@0leil.net |
---|---|
State | New |
Headers | show |
Series | docs: ref-manual: variables: remove sphinx directive from literal block | expand |
Michael, I see you're being active again so pinging on this one so it does not get missed :) Cheers, Quentin On 7/7/22 15:33, Quentin Schulz wrote: > From: Quentin Schulz <quentin.schulz@theobroma-systems.com> > > Literal blocks make sphinx take their text verbatim. This means that > directives cannot be used in literal blocks. This means :term:`S` was > printed as-is, without actually creating a link to the S variable > definition as would be expected outside of literal blocks. > > Cc: Quentin Schulz <foss+yocto@0leil.net> > Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> > --- > documentation/ref-manual/variables.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst > index c4b2119f2..dbb7a4628 100644 > --- a/documentation/ref-manual/variables.rst > +++ b/documentation/ref-manual/variables.rst > @@ -7660,7 +7660,7 @@ system and gives an overview of their function and contents. > :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the > :term:`SYSTEMD_BOOT_CFG` as follows:: > > - SYSTEMD_BOOT_CFG ?= "${:term:`S`}/loader.conf" > + SYSTEMD_BOOT_CFG ?= "${S}/loader.conf" > > For information on Systemd-boot, see the `Systemd-boot > documentation <https://urldefense.proofpoint.com/v2/url?u=https-3A__www.freedesktop.org_wiki_Software_systemd_systemd-2Dboot_&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=-WnObifONJTQG6gPXN4yQJt-q2jucv7LUK4MWCH47bGkKnfvKA-E_60a64_S-BBn&s=G2yqi_HANVsx7VddtaRLxM9pWdReEqcPY4i-a49RQSM&e= >`__. > > > > -=-=-=-=-=-=-=-=-=-=-=- > Links: You receive all messages sent to this group. > View/Reply Online (#3053): https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_message_3053&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=-WnObifONJTQG6gPXN4yQJt-q2jucv7LUK4MWCH47bGkKnfvKA-E_60a64_S-BBn&s=1o0IcdjncqOzjO1W7q4onKC4LUV-SVTFHM3q7mW8OoU&e= > Mute This Topic: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_mt_92228284_6293953&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=-WnObifONJTQG6gPXN4yQJt-q2jucv7LUK4MWCH47bGkKnfvKA-E_60a64_S-BBn&s=1xRjxcjduk4X5G6Icz9Eu6tucn1NDdl-Mmr2T1ScjMw&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=-WnObifONJTQG6gPXN4yQJt-q2jucv7LUK4MWCH47bGkKnfvKA-E_60a64_S-BBn&s=yx9TaufiGxGlpJcPYeN4zxhvIrrYMFzbAlOtILo0I1Q&e= [quentin.schulz@theobroma-systems.com] > -=-=-=-=-=-=-=-=-=-=-=- >
Hey Quentin Thanks for the patch! On 7/7/22 15:33, Quentin Schulz wrote: > From: Quentin Schulz <quentin.schulz@theobroma-systems.com> > > Literal blocks make sphinx take their text verbatim. This means that > directives cannot be used in literal blocks. This means :term:`S` was > printed as-is, without actually creating a link to the S variable > definition as would be expected outside of literal blocks. > > Cc: Quentin Schulz <foss+yocto@0leil.net> > Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> > --- > documentation/ref-manual/variables.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst > index c4b2119f2..dbb7a4628 100644 > --- a/documentation/ref-manual/variables.rst > +++ b/documentation/ref-manual/variables.rst > @@ -7660,7 +7660,7 @@ system and gives an overview of their function and contents. > :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the > :term:`SYSTEMD_BOOT_CFG` as follows:: > > - SYSTEMD_BOOT_CFG ?= "${:term:`S`}/loader.conf" > + SYSTEMD_BOOT_CFG ?= "${S}/loader.conf" > > For information on Systemd-boot, see the `Systemd-boot > documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. Good catch! Using the mega-manual, I double checked that this was the only instance of this issue. Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> ... and merged into master-next. Thanks again! Cheers Michael.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index c4b2119f2..dbb7a4628 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -7660,7 +7660,7 @@ system and gives an overview of their function and contents. :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the :term:`SYSTEMD_BOOT_CFG` as follows:: - SYSTEMD_BOOT_CFG ?= "${:term:`S`}/loader.conf" + SYSTEMD_BOOT_CFG ?= "${S}/loader.conf" For information on Systemd-boot, see the `Systemd-boot documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.