diff mbox series

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

Message ID 20260602142909.984239-1-rl@karo-electronics.de
State New
Headers show
Series [scarthgap] bitbake: bitbake-user-manual-metadata: fix missing option to 'echo' command in example | expand

Commit Message

Robin Lintermann June 2, 2026, 2:29 p.m. UTC
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".

Signed-off-by: Robin Lintermann <rl@karo-electronics.de>
---
 doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Peter Kjellerstedt June 2, 2026, 7:03 p.m. UTC | #1
> -----Original Message-----
> From: bitbake-devel@lists.openembedded.org <bitbake-devel@lists.openembedded.org> On Behalf Of Robin Lintermann via lists.openembedded.org
> Sent: den 2 juni 2026 16:29
> To: bitbake-devel@lists.openembedded.org
> Cc: Robin Lintermann <rl@karo-electronics.de>
> 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...

> 
> 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".
> 
> Signed-off-by: Robin Lintermann <rl@karo-electronics.de>
> ---
>  doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> index 58975f4c8..3d32e8c1e 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> @@ -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...

> 
>  Variable Expansion
>  ------------------
> --
> 2.43.0

//Peter
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
index 58975f4c8..3d32e8c1e 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -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
 ------------------