mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-08 05:09:24 +00:00
Code Issues Projects Releases Wiki Activity

sdk-manual: fix improper indent of general form of tarball installer scripts

Browse Source 
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.

Finally, replace the literal block (::) with a parsed-literal block so
we can highlight the placeholders appropriately.

(From yocto-docs rev: 0f0ce9012349f4bb18a0c209b77b45a125f2d387)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 04c883216158edafe6a4c4ddfb38f63ffb5d5c24)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Quentin Schulz
2026-01-21 14:31:44 +01:00
committed by Richard Purdie
parent 3056341eb5
commit aadcf56af2
2 changed files with 15 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/sdk-manual/extensible.rst
+8 -13
View File
@@ -100,26 +100,21 @@ The names of the tarball installer scripts are such that a string
representing the host system appears first in the filename and then is
immediately followed by a string representing the target architecture.
An extensible SDK has the string "-ext" as part of the name. Following
is the general form::
is the general form:
poky-glibc-host_system-image_type-arch-toolchain-ext-release_version.sh
.. parsed-literal::
Where:
host_system is a string representing your development system:
poky-glibc-*host_system*-*image_type*-*arch*-toolchain-ext-*release_version*.sh
i686 or x86_64.
Where:
image_type is the image for which the SDK was built:
- *host_system* is a string representing your development system: ``i686`` or ``x86_64``.
core-image-sato or core-image-minimal
- *image_type* is the image for which the SDK was built: ``core-image-sato`` or ``core-image-minimal``.
arch is a string representing the tuned target architecture:
- *arch* is a string representing the tuned target architecture: ``aarch64``, ``armv5e``, ``core2-64``, ``i586``, ``mips32r2``, ``mips64``, ``ppc7400``, or ``cortexa8hf-neon``.
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
documentation/sdk-manual/using.rst
+7 -14
View File
@@ -54,26 +54,19 @@ The names of the tarball installer scripts are such that a string
representing the host system appears first in the filename and then is
immediately followed by a string representing the target architecture:
.. code-block:: text
.. parsed-literal::
poky-glibc-host_system-image_type-arch-toolchain-release_version.sh
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