summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorQuentin Schulz <quentin.schulz@cherry.de>2026-01-21 14:31:42 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2026-02-10 13:11:48 +0000
commitd38081ece2c2ffd2e0ff67f7adfb5bfd0b64f99d (patch)
tree04ad608a32ce8875f849d0e86c74448d6db4bbca /documentation
parent353491479086e8d3f209d5cce0019a29e143b064 (diff)
downloadpoky-d38081ece2c2ffd2e0ff67f7adfb5bfd0b64f99d.tar.gz
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 <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 72354c27000aba3ae583894ff6112a1a017e33d5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/sdk-manual/appendix-obtain.rst12
-rw-r--r--documentation/sdk-manual/extensible.rst4
-rw-r--r--documentation/sdk-manual/using.rst8
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:
61 61
62 For example, if your build host is a 64-bit x86 system and you need 62 For example, if your build host is a 64-bit x86 system and you need
63 an extended SDK for a 64-bit core2 QEMU target, go into the ``x86_64`` 63 an extended SDK for a 64-bit core2 QEMU target, go into the ``x86_64``
64 folder and download the following installer:: 64 folder and download the following installer:
65
66 .. code-block:: text
65 67
66 poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh 68 poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh
67 69
@@ -130,7 +132,9 @@ build the SDK installer. Follow these steps:
130 :term:`SDKMACHINE` value must be set for the architecture of the 132 :term:`SDKMACHINE` value must be set for the architecture of the
131 machine you are using to build the installer. If :term:`SDKMACHINE` 133 machine you are using to build the installer. If :term:`SDKMACHINE`
132 is not set appropriately, the build fails and provides an error 134 is not set appropriately, the build fails and provides an error
133 message similar to the following:: 135 message similar to the following:
136
137 .. code-block:: text
134 138
135 The extensible SDK can currently only be built for the same 139 The extensible SDK can currently only be built for the same
136 architecture as the machine being built on - SDK_ARCH 140 architecture as the machine being built on - SDK_ARCH
@@ -224,7 +228,9 @@ Follow these steps to extract the root filesystem:
224 228
225 For example, if you plan on using a BeagleBone device as your target 229 For example, if you plan on using a BeagleBone device as your target
226 hardware and your image is a ``core-image-sato-sdk`` image, you can 230 hardware and your image is a ``core-image-sato-sdk`` image, you can
227 download the following file:: 231 download the following file:
232
233 .. code-block:: text
228 234
229 core-image-sato-sdk-beaglebone-yocto.tar.bz2 235 core-image-sato-sdk-beaglebone-yocto.tar.bz2
230 236
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::
121 121
122For example, the following SDK installer is for a 64-bit 122For example, the following SDK installer is for a 64-bit
123development host system and a i586-tuned target architecture based off 123development host system and a i586-tuned target architecture based off
124the SDK for ``core-image-sato`` and using the current &DISTRO; snapshot:: 124the SDK for ``core-image-sato`` and using the current &DISTRO; snapshot:
125
126.. code-block:: text
125 127
126 poky-glibc-x86_64-core-image-sato-i586-toolchain-ext-&DISTRO;.sh 128 poky-glibc-x86_64-core-image-sato-i586-toolchain-ext-&DISTRO;.sh
127 129
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.
52 52
53The names of the tarball installer scripts are such that a string 53The names of the tarball installer scripts are such that a string
54representing the host system appears first in the filename and then is 54representing the host system appears first in the filename and then is
55immediately followed by a string representing the target architecture:: 55immediately followed by a string representing the target architecture:
56
57.. code-block:: text
56 58
57 poky-glibc-host_system-image_type-arch-toolchain-release_version.sh 59 poky-glibc-host_system-image_type-arch-toolchain-release_version.sh
58 60
@@ -75,7 +77,9 @@ immediately followed by a string representing the target architecture::
75 77
76For example, the following SDK installer is for a 64-bit 78For example, the following SDK installer is for a 64-bit
77development host system and a i586-tuned target architecture based off 79development host system and a i586-tuned target architecture based off
78the SDK for ``core-image-sato`` and using the current DISTRO snapshot:: 80the SDK for ``core-image-sato`` and using the current DISTRO snapshot:
81
82.. code-block:: text
79 83
80 poky-glibc-x86_64-core-image-sato-i586-toolchain-DISTRO.sh 84 poky-glibc-x86_64-core-image-sato-i586-toolchain-DISTRO.sh
81 85