From 10ce846e13604bb328040b15f26f6b79072f898c Mon Sep 17 00:00:00 2001 From: Quentin Schulz Date: Wed, 21 Jan 2026 14:31:51 +0100 Subject: [PATCH] sdk-manual: appendix-obtain: use parsed-literal block for naming convention of the installer scripts It's easier on the eye to use a parsed-literal block for highlighting things that must be changed than simply stating the word, so this makes use of a parsed-literal block instead of a simple inline code-block and also highlight in italic which words are placeholders. Also make the explanation below the literal-block use the same highlighting (italic). (From yocto-docs rev: 648b3c3e80a3916917763e3892a5e8c8d8a72162) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit 41ee642c33cc2e7435e6037bf49fe7495ffa6133) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/sdk-manual/appendix-obtain.rst | 28 +++++++++++++------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst index 7fbb72d547..34a3f5bbba 100644 --- a/documentation/sdk-manual/appendix-obtain.rst +++ b/documentation/sdk-manual/appendix-obtain.rst @@ -40,15 +40,20 @@ Follow these steps to locate and hand-install the toolchain: hardware, and image type. The installer files (``*.sh``) follow this naming convention: - ``poky-glibc-host_system-core-image-type-arch-toolchain[-ext]-release.sh``: - - ``host_system``: string representing your development system: ``i686`` or ``x86_64`` + .. parsed-literal:: - - ``type``: string representing the image: ``sato`` or ``minimal`` + poky-glibc-*host_system*-core-image-*type*-*arch*-toolchain[-ext]-*release*.sh - - ``arch``: string representing the target architecture such as ``cortexa57-qemuarm64`` + With: - - ``release``: version of the Yocto Project. + - *host_system*: string representing your development system: ``i686`` or ``x86_64`` + + - *type*: string representing the image: ``sato`` or ``minimal`` + + - *arch*: string representing the target architecture such as ``cortexa57-qemuarm64`` + + - *release*: version of the Yocto Project. .. note:: The standard SDK installer does not have the ``-ext`` string as @@ -223,14 +228,19 @@ Follow these steps to extract the root filesystem: also contain flattened root filesystem image files (``*.ext4``), which you can use with QEMU directly. - The pre-built root filesystem image files follow the - ``core-image-profile-machine.tar.bz2`` naming convention: + The pre-built root filesystem image files follow this naming convention: - - ``profile``: filesystem image's profile, such as ``minimal``, + .. parsed-literal:: + + core-image-*profile*-*machine*.tar.bz2 + + With: + + - *profile*: filesystem image's profile, such as ``minimal``, ``minimal-dev`` or ``sato``. For information on these types of image profiles, see the "Images" chapter in the Yocto Project Reference Manual. - - ``machine``: same string as the name of the parent download directory. + - *machine*: same string as the name of the parent download directory. The root filesystems provided by the Yocto Project are based off of the