diff mbox series

[3/9] sdk-manual: fix improper indent of general form of tarball installer script

Message ID 20260114-code-block-misc-20260114-v1-3-174a6e5dba69@cherry.de
State New
Headers show
Series sdk-manual: fix code-blocks, migrate one PNG to SVG, remove unused PNG | expand

Commit Message

Quentin Schulz Jan. 14, 2026, 12:56 p.m. UTC 
From: Quentin Schulz <quentin.schulz@cherry.de>

poky-glibc-host_system-image_type-arch-toolchain-ext-release_version.sh
is in a code-block and thus requires to be indented (it is). Sphinx
knows a block has ended when the indentation of the next line is smaller
than in the block, otherwise it's all in the same block.

The explanation of the replaceable parts in the tarball installer script
filename should be text and not part of the block, so let's do that.

While at it, reformat by putting each replaceable part in a bullet list,
highlight the replaceable part or what it can replaced with as well as
putting the replacement on the same line instead of making it a quote by
having them indented in the bullet list.

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
 documentation/sdk-manual/extensible.rst | 17 +++++------------
 documentation/sdk-manual/using.rst      | 17 +++++------------
 2 files changed, 10 insertions(+), 24 deletions(-)
diff mbox series

Patch

diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
index 808e076e6..c3b0c57d0 100644
--- a/documentation/sdk-manual/extensible.rst
+++ b/documentation/sdk-manual/extensible.rst
@@ -104,22 +104,15 @@  is the general form::
 
    poky-glibc-host_system-image_type-arch-toolchain-ext-release_version.sh
 
-   Where:
-       host_system is a string representing your development system:
+Where:
 
-                  i686 or x86_64.
+-  `host_system` is a string representing your development system: `i686` or `x86_64`.
 
-       image_type is the image for which the SDK was built:
+-  `image_type` is the image for which the SDK was built: `core-image-sato` or `core-image-minimal`.
 
-                  core-image-sato or core-image-minimal
+-  `arch` is a string representing the tuned target architecture: `aarch64`, `armv5e`, `core2-64`, `i586`, `mips32r2`, `mips64`, `ppc7400`, or `cortexa8hf-neon`.
 
-       arch is a string representing the tuned target architecture:
-
-                  aarch64, armv5e, core2-64, i586, mips32r2, mips64, ppc7400, or cortexa8hf-neon
-
-       release_version is a string representing the release number of the Yocto Project:
-
-                  &DISTRO;, &DISTRO;+snapshot
+-  `release_version` is a string representing the release number of the Yocto Project: `&DISTRO;`, `&DISTRO;+snapshot`.
 
 For example, the following SDK installer is for a 64-bit
 development host system and a i586-tuned target architecture based off
diff --git a/documentation/sdk-manual/using.rst b/documentation/sdk-manual/using.rst
index 28f9e33b0..05da7acbf 100644
--- a/documentation/sdk-manual/using.rst
+++ b/documentation/sdk-manual/using.rst
@@ -58,22 +58,15 @@  immediately followed by a string representing the target architecture:
 
    poky-glibc-host_system-image_type-arch-toolchain-release_version.sh
 
-   Where:
-       host_system is a string representing your development system:
+Where:
 
-                  i686 or x86_64.
+-  `host_system` is a string representing your development system: `i686` or `x86_64`.
 
-       image_type is the image for which the SDK was built:
+-  `image_type` is the image for which the SDK was built: `core-image-minimal` or `core-image-sato`.
 
-                  core-image-minimal or core-image-sato.
+-  `arch` is a string representing the tuned target architecture: `aarch64`, `armv5e`, `core2-64`, `i586`, `mips32r2`, `mips64`, `ppc7400`, or `cortexa8hf-neon`.
 
-       arch is a string representing the tuned target architecture:
-
-                  aarch64, armv5e, core2-64, i586, mips32r2, mips64, ppc7400, or cortexa8hf-neon.
-
-       release_version is a string representing the release number of the Yocto Project:
-
-                  &DISTRO;, &DISTRO;+snapshot
+-  `release_version` is a string representing the release number of the Yocto Project: `&DISTRO;`, `&DISTRO;+snapshot`.
 
 For example, the following SDK installer is for a 64-bit
 development host system and a i586-tuned target architecture based off