* [PATCH] docs: ref-manual: variables: remove sphinx directive from literal block
@ 2022-07-07 13:33 Quentin Schulz
2022-07-19 13:02 ` [docs] " Quentin Schulz
2022-07-19 17:50 ` Michael Opdenacker
0 siblings, 2 replies; 3+ messages in thread
From: Quentin Schulz @ 2022-07-07 13:33 UTC (permalink / raw)
To: docs; +Cc: Quentin Schulz, Quentin Schulz
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/>`__.
--
2.36.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [docs] [PATCH] docs: ref-manual: variables: remove sphinx directive from literal block
2022-07-07 13:33 [PATCH] docs: ref-manual: variables: remove sphinx directive from literal block Quentin Schulz
@ 2022-07-19 13:02 ` Quentin Schulz
2022-07-19 17:50 ` Michael Opdenacker
1 sibling, 0 replies; 3+ messages in thread
From: Quentin Schulz @ 2022-07-19 13:02 UTC (permalink / raw)
To: docs; +Cc: Quentin Schulz
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]
> -=-=-=-=-=-=-=-=-=-=-=-
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [docs] [PATCH] docs: ref-manual: variables: remove sphinx directive from literal block
2022-07-07 13:33 [PATCH] docs: ref-manual: variables: remove sphinx directive from literal block Quentin Schulz
2022-07-19 13:02 ` [docs] " Quentin Schulz
@ 2022-07-19 17:50 ` Michael Opdenacker
1 sibling, 0 replies; 3+ messages in thread
From: Michael Opdenacker @ 2022-07-19 17:50 UTC (permalink / raw)
To: Quentin Schulz, docs; +Cc: Quentin Schulz, Quentin Schulz
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.
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-07-19 17:51 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-07-07 13:33 [PATCH] docs: ref-manual: variables: remove sphinx directive from literal block Quentin Schulz
2022-07-19 13:02 ` [docs] " Quentin Schulz
2022-07-19 17:50 ` Michael Opdenacker
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.