Skip to contentSkip to conversation

kirkstone: ref-manual: variables: remove sphinx directive from literal block

PATCH New [email protected] 1 participant 1 message Jul 19, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kirkstone: ref-manual: variables: remove sphinx directive from literal block

From: Michael Opdenacker <[email protected]>

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.

Initially contributed to the master branch by Quentin Schulz.

---
 documentation/ref-manual/variables.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
documentation/ref-manual/variables.rst +1 -1
index f8808cc052..47462233c9 100644
@@ -7609,7 +7609,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/>`__.
Signature · 1 line
2.34.1