From patchwork Wed Jan 14 12:56:23 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 78683 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id AC981D2A013 for ; Wed, 14 Jan 2026 12:56:54 +0000 (UTC) Received: from smtp-bc09.mail.infomaniak.ch (smtp-bc09.mail.infomaniak.ch [45.157.188.9]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.9271.1768395408634635130 for ; Wed, 14 Jan 2026 04:56:49 -0800 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: 0leil.net, ip: 45.157.188.9, mailfrom: foss+yocto@0leil.net) Received: from smtp-4-0001.mail.infomaniak.ch (smtp-4-0001.mail.infomaniak.ch [10.7.10.108]) by smtp-4-3000.mail.infomaniak.ch (Postfix) with ESMTPS id 4drmMz09NBzTLQ; Wed, 14 Jan 2026 13:56:47 +0100 (CET) Received: from unknown by smtp-4-0001.mail.infomaniak.ch (Postfix) with ESMTPA id 4drmMy4pvMzQ4l; Wed, 14 Jan 2026 13:56:46 +0100 (CET) From: Quentin Schulz Date: Wed, 14 Jan 2026 13:56:23 +0100 Subject: [PATCH 3/9] sdk-manual: fix improper indent of general form of tarball installer script MIME-Version: 1.0 Message-Id: <20260114-code-block-misc-20260114-v1-3-174a6e5dba69@cherry.de> References: <20260114-code-block-misc-20260114-v1-0-174a6e5dba69@cherry.de> In-Reply-To: <20260114-code-block-misc-20260114-v1-0-174a6e5dba69@cherry.de> To: docs@lists.yoctoproject.org Cc: Quentin Schulz X-Mailer: b4 0.14.3 X-Infomaniak-Routing: alpha List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Wed, 14 Jan 2026 12:56:54 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/8549 From: Quentin Schulz 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 --- documentation/sdk-manual/extensible.rst | 17 +++++------------ documentation/sdk-manual/using.rst | 17 +++++------------ 2 files changed, 10 insertions(+), 24 deletions(-) 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