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

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(-)

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

Hi Antonin,

On 1/20/26 4:33 PM, Antonin Godard wrote:
> 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.
> 

Well... For the first one, I'm not so sure as it is pointing at 
something in the code-block, so emphasis rather than monospace font 
seems more appropriate here. We should probably use double-tick quotes 
for the possible values though I agree. I'm wondering if this isn't a 
good place to experiment with parsed-literal blocks.

Cheers,
Quentin