From d38081ece2c2ffd2e0ff67f7adfb5bfd0b64f99d Mon Sep 17 00:00:00 2001 From: Quentin Schulz Date: Wed, 21 Jan 2026 14:31:42 +0100 Subject: [PATCH] sdk-manual: fix incorrect highlight language for text code-blocks When unspecified in conf.py via the highlight_language variable (and highlight variable for code-blocks), the lexer used for literal blocks is "default" which tries to highlight the block as Python code. These blocks aren't Python but either simply the console output or a file name (which we should probably just double tick-quote instead), so let's render those blocks with the "text" lexer. (From yocto-docs rev: ff5a0859620327e4eada0082b20ad62b032d8d5f) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit 72354c27000aba3ae583894ff6112a1a017e33d5) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/sdk-manual/appendix-obtain.rst | 12 +++++++++--- documentation/sdk-manual/extensible.rst | 4 +++- documentation/sdk-manual/using.rst | 8 ++++++-- 3 files changed, 18 insertions(+), 6 deletions(-) diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst index a42cbc31bb..94c5552e5f 100644 --- a/documentation/sdk-manual/appendix-obtain.rst +++ b/documentation/sdk-manual/appendix-obtain.rst @@ -61,7 +61,9 @@ Follow these steps to locate and hand-install the toolchain: For example, if your build host is a 64-bit x86 system and you need an extended SDK for a 64-bit core2 QEMU target, go into the ``x86_64`` - folder and download the following installer:: + folder and download the following installer: + + .. code-block:: text poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh @@ -130,7 +132,9 @@ build the SDK installer. Follow these steps: :term:`SDKMACHINE` value must be set for the architecture of the machine you are using to build the installer. If :term:`SDKMACHINE` is not set appropriately, the build fails and provides an error - message similar to the following:: + message similar to the following: + + .. code-block:: text The extensible SDK can currently only be built for the same architecture as the machine being built on - SDK_ARCH @@ -224,7 +228,9 @@ Follow these steps to extract the root filesystem: For example, if you plan on using a BeagleBone device as your target hardware and your image is a ``core-image-sato-sdk`` image, you can - download the following file:: + download the following file: + + .. code-block:: text core-image-sato-sdk-beaglebone-yocto.tar.bz2 diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst index ab4956f466..a55d779a36 100644 --- a/documentation/sdk-manual/extensible.rst +++ b/documentation/sdk-manual/extensible.rst @@ -121,7 +121,9 @@ is the general form:: For example, the following SDK installer is for a 64-bit development host system and a i586-tuned target architecture based off -the SDK for ``core-image-sato`` and using the current &DISTRO; snapshot:: +the SDK for ``core-image-sato`` and using the current &DISTRO; snapshot: + +.. code-block:: text poky-glibc-x86_64-core-image-sato-i586-toolchain-ext-&DISTRO;.sh diff --git a/documentation/sdk-manual/using.rst b/documentation/sdk-manual/using.rst index bfb306abf5..eced4a5c50 100644 --- a/documentation/sdk-manual/using.rst +++ b/documentation/sdk-manual/using.rst @@ -52,7 +52,9 @@ libraries appropriate for developing against the corresponding image. The names of the tarball installer scripts are such that a string representing the host system appears first in the filename and then is -immediately followed by a string representing the target architecture:: +immediately followed by a string representing the target architecture: + +.. code-block:: text poky-glibc-host_system-image_type-arch-toolchain-release_version.sh @@ -75,7 +77,9 @@ immediately followed by a string representing the target architecture:: For example, the following SDK installer is for a 64-bit development host system and a i586-tuned target architecture based off -the SDK for ``core-image-sato`` and using the current DISTRO snapshot:: +the SDK for ``core-image-sato`` and using the current DISTRO snapshot: + +.. code-block:: text poky-glibc-x86_64-core-image-sato-i586-toolchain-DISTRO.sh