[PATCH v2] docs: sdk-manual: appendix-obtain: fix literal block content

[PATCH v2] docs: sdk-manual: appendix-obtain: fix literal block content

[michael.opdenacker]

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

From: Quentin Schulz <quentin.schulz@theobroma-systems.com>

Restore the error message as it is supposed to be issued.

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.

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>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>

---

Changes in V2:
- Replace "---" by "-"
- Restore the variables names without any quotes as in the
  real error message.
- Add back "Unable to continue" which is also missing.
---
 documentation/sdk-manual/appendix-obtain.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst
index ba844507d3..f40ea6d4ab 100644
--- a/documentation/sdk-manual/appendix-obtain.rst
+++ b/documentation/sdk-manual/appendix-obtain.rst
@@ -140,9 +140,10 @@ 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
-         different from the architecture of the build machine (``x86_64``).
+         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.
 
 
 #. *Build the SDK Installer:* To build the SDK installer for a standard
-- 
2.34.1

Re: [PATCH v2] docs: sdk-manual: appendix-obtain: fix literal block content

[Quentin Schulz]

Hi Michael,

On 6/23/23 19:54, michael.opdenacker@bootlin.com wrote:
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
> 
> Restore the error message as it is supposed to be issued.
> 
> 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.
> 
> 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>
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 

It'll teach me to send a patch in a hurry before taking a day off :)

Thanks, lgtm.

Cheers,
Quentin

Re: [docs] [PATCH v2] docs: sdk-manual: appendix-obtain: fix literal block content

[Michael Opdenacker]

On 26.06.23 at 08:43, Quentin Schulz via lists.yoctoproject.org wrote:
> Hi Michael,
>
> On 6/23/23 19:54, michael.opdenacker@bootlin.com wrote:
>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>
>> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>>
>> Restore the error message as it is supposed to be issued.
>>
>> 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.
>>
>> 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>
>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>
>
> It'll teach me to send a patch in a hurry before taking a day off :)
>
> Thanks, lgtm.


Thanks Quentin. That's better than not sending the patch anyway!
Merged into master-next.

Cheers
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com