Skip to contentSkip to conversation

bitbake: bitbake-user-manual-metadata: fix missing option to 'echo' command in example

PATCH In review Robin Lintermann 2 participants 2 messages Jun 2

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 bitbake: bitbake-user-manual-metadata: fix missing option to 'echo' command in example

The original text reads:

| values. For these to have an effect, the value must be passed to some
| utility that interprets escape sequences, such as
| ``printf`` or ``echo -n``.

The '-n' option tells echo to not append a newline to the output. What's missing here is the '-e' option to "enable interpretation of backslash escapes".

---
 doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +1 -1
index 58975f4c8..3d32e8c1e 100644
@@ -128,7 +128,7 @@ Consider this additional example where the two assignments both assign
    BitBake does not interpret escape sequences like "\\n" in variable
    values. For these to have an effect, the value must be passed to some
    utility that interprets escape sequences, such as
-   ``printf`` or ``echo -n``.
+   ``printf`` or ``echo -ne``.
 
 Variable Expansion
 ------------------
Signature · 1 line
2.43.0
#1 lore raw
Quoted 11 lines

-----Original Message-----
From: [email protected] <[email protected]> On Behalf Of Robin Lintermann via lists.openembedded.org
Sent: den 2 juni 2026 16:29
To: [email protected]
Cc: Robin Lintermann <[email protected]>
Subject: [bitbake-devel] [scarthgap][PATCH] bitbake: bitbake-user-manual-metadata: fix missing option to 'echo' command in example

The original text reads:

| values. For these to have an effect, the value must be passed to some
| utility that interprets escape sequences, such as
| ``printf`` or ``echo -n``.

Umm, yes that's shown by git diff...

Quoted 15 lines

The '-n' option tells echo to not append a newline to the output. What's missing here is the '-e' option to "enable interpretation of backslash escapes".

---
 doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +0 -0
index 58975f4c8..3d32e8c1e 100644

doc/bitbake-user-manual/bitbake-user-manual-metadata.rst Consider this additional example where the two assignments both assign · line 131

Quoted 5 lines
doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +1 -1
@@ -128,7 +128,7 @@ Consider this additional example where the two assignments both assign
    BitBake does not interpret escape sequences like "\\n" in variable
    values. For these to have an effect, the value must be passed to some
    utility that interprets escape sequences, such as
-   ``printf`` or ``echo -n``.
+   ``printf`` or ``echo -ne``.

I would rather recommend to drop the suggestion to use echo as how it handles escape sequences is shell specific, where Bash, Zsh, and Dash all behave differently...

Quoted 5 lines
doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +0 -1
 Variable Expansion
 ------------------
--

2.43.0

//Peter