All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Antonin Godard" <antonin.godard@bootlin.com>
To: "Quentin Schulz" <foss@0leil.net>, <docs@lists.yoctoproject.org>
Cc: "Quentin Schulz" <quentin.schulz@cherry.de>
Subject: Re: [docs] [PATCH 3/9] sdk-manual: fix improper indent of general form of tarball installer script
Date: Tue, 20 Jan 2026 16:33:07 +0100	[thread overview]
Message-ID: <DFTIXPMPMPHD.1GCI7XBA3UQ3D@bootlin.com> (raw)
In-Reply-To: <20260114-code-block-misc-20260114-v1-3-174a6e5dba69@cherry.de>

Hi,

On Wed Jan 14, 2026 at 1:56 PM CET, Quentin Schulz wrote:
> 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 --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`.

Shouldn't those (and the following) be enclosed with double ticks? ``host_system``,
etc.

Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com



  reply	other threads:[~2026-01-20 15:33 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-14 12:56 [PATCH 0/9] sdk-manual: fix code-blocks, migrate one PNG to SVG, remove unused PNG Quentin Schulz
2026-01-14 12:56 ` [PATCH 1/9] sdk-manual: fix incorrect highlight language for text code-blocks Quentin Schulz
2026-01-14 12:56 ` [PATCH 2/9] sdk-manual: fix incorrect highlight language for console code-blocks Quentin Schulz
2026-01-14 12:56 ` [PATCH 3/9] sdk-manual: fix improper indent of general form of tarball installer script Quentin Schulz
2026-01-20 15:33   ` Antonin Godard [this message]
2026-01-20 15:57     ` [docs] " Quentin Schulz
2026-01-14 12:56 ` [PATCH 4/9] sdk-manual: working-projects: properly highlight code code-blocks Quentin Schulz
2026-01-14 12:56 ` [PATCH 5/9] sdk-manual: appending-customizing: use none lexer for BitBake code blocks Quentin Schulz
2026-01-14 12:56 ` [PATCH 6/9] sdk-manual: appendix-obtain: replace directory structure PNG with a code-block Quentin Schulz
2026-01-20 15:37   ` [docs] " Antonin Godard
2026-01-20 15:55     ` Quentin Schulz
2026-01-21 10:18       ` Antonin Godard
2026-01-14 12:56 ` [PATCH 7/9] sdk-manual: appendix-obtain: replace eSDK " Quentin Schulz
2026-01-14 12:56 ` [PATCH 8/9] sdk-manual: replace sdk-environment PNG with SVG Quentin Schulz
2026-01-14 12:56 ` [PATCH 9/9] sdk-manual: delete sdk-title PNG Quentin Schulz
2026-02-10 13:06 ` [PATCH 0/9] sdk-manual: fix code-blocks, migrate one PNG to SVG, remove unused PNG Antonin Godard

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=DFTIXPMPMPHD.1GCI7XBA3UQ3D@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=foss@0leil.net \
    --cc=quentin.schulz@cherry.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.