Skip to contentSkip to conversation

docs: sdk-manual: appendix-obtain: fix literal block content

PATCH In review [email protected] 2 participants 3 messages Jun 23, 2023 – Jul 17, 2023 1 message not in the archive

lore
Share & tools
lore

A message that is not in the archive (sent off-list or not yet received): [email protected]

#1 lore raw

PATCH v2 1/1 docs: sdk-manual: appendix-obtain: fix literal block content

From: Michael Opdenacker <[email protected]>

From: Quentin Schulz <[email protected]>

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 <[email protected]>

---

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(-)
documentation/sdk-manual/appendix-obtain.rst +4 -3
index ba844507d3..f40ea6d4ab 100644
@@ -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
Signature · 1 line
2.34.1
#2 lore raw

Hi Michael,

Quoted 6 lines · On 6/23/23 19:54, [email protected] wrote:

From: Michael Opdenacker <[email protected]>

From: Quentin Schulz <[email protected]>

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

Quoted 9 lines

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 <[email protected]>

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

Thanks, lgtm.

Cheers,
Quentin

#3 lore raw
Quoted 19 lines · Quentin Schulz via lists.yoctoproject.org

Hi Michael,

Quoted 6 lines · On 6/23/23 19:54, [email protected] wrote:

From: Michael Opdenacker <[email protected]>

From: Quentin Schulz <[email protected]>

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

Quoted 9 lines

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 <[email protected]>
Quoted 3 lines

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.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com