diff mbox series

[1/4] docs: sdk-manual: appendix-obtain: fix literal block content

Message ID 20230622-typos-202306-v1-1-68489d7f23f2@theobroma-systems.com
State New
Headers show
Series fix some doc typos | expand

Commit Message

Quentin Schulz June 22, 2023, 4:51 p.m. UTC
From: Quentin Schulz <quentin.schulz@theobroma-systems.com>

The literal block renders its content verbatim so a term role (`:term:`)
would appear as :term: string in there and `---` as --- string instead
of the expected hyphen.

While at it, surround the former-term roles with `` to highlight them.

Fixes: e319b3bf4eb6 ("manuals: add missing references to SDKMACHINE and SDK_ARCH")
Cc: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
 documentation/sdk-manual/appendix-obtain.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Michael Opdenacker June 22, 2023, 9:02 p.m. UTC | #1
Hi Quentin

On 22.06.23 at 18:51, Quentin Schulz wrote:
> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>
> The literal block renders its content verbatim so a term role (`:term:`)
> would appear as :term: string in there and `---` as --- string instead
> of the expected hyphen.
>
> While at it, surround the former-term roles with `` to highlight them.
>
> Fixes: e319b3bf4eb6 ("manuals: add missing references to SDKMACHINE and SDK_ARCH")
> Cc: Quentin Schulz <foss+yocto@0leil.net>
> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
> ---
>   documentation/sdk-manual/appendix-obtain.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst
> index ba844507d..e16017de7 100644
> --- a/documentation/sdk-manual/appendix-obtain.rst
> +++ b/documentation/sdk-manual/appendix-obtain.rst
> @@ -140,8 +140,8 @@ build the SDK installer. Follow these steps:
>         message similar to the following::
>   
>            The extensible SDK can currently only be built for the same
> -         architecture as the machine being built on --- :term:`SDK_ARCH`
> -         is set to ``i686`` (likely via setting :term:`SDKMACHINE`) which is
> +         architecture as the machine being built on --- ``SDK_ARCH``
> +         is set to ``i686`` (likely via setting ``SDKMACHINE`` which is
>            different from the architecture of the build machine (``x86_64``).


Thanks, but actually, we should return to what the message should be like:

- "-" instead of "---"

- "SDKMACHINE" instead of "``SDKMACHINE`` and the same for SDK_ARCH.

Originally, the message was:
"The extensible SDK can currently only be built for the same 
architecture as the machine being built on - SDK_ARCH is
  set to i686 (likely via setting SDKMACHINE) which is different from 
the architecture of the build machine (x86_64).
Unable to continue."

Would you have time to correct this? I can do it too :)

Cheers
Michael.
diff mbox series

Patch

diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst
index ba844507d..e16017de7 100644
--- a/documentation/sdk-manual/appendix-obtain.rst
+++ b/documentation/sdk-manual/appendix-obtain.rst
@@ -140,8 +140,8 @@  build the SDK installer. Follow these steps:
       message similar to the following::
 
          The extensible SDK can currently only be built for the same
-         architecture as the machine being built on --- :term:`SDK_ARCH`
-         is set to ``i686`` (likely via setting :term:`SDKMACHINE`) which is
+         architecture as the machine being built on --- ``SDK_ARCH``
+         is set to ``i686`` (likely via setting ``SDKMACHINE`` which is
          different from the architecture of the build machine (``x86_64``).