diff mbox series

[v2] bitbake: user-manual: inform about spaces in :remove

Message ID 20220929122133.261961-1-johan.korsnes@remarkable.no
State New
Headers show
Series [v2] bitbake: user-manual: inform about spaces in :remove | expand

Commit Message

Johan Korsnes Sept. 29, 2022, 12:21 p.m. UTC
Inform the reader that there should be no need for spaces in the value
when using removal override `:remove`.

Considering why spaces are used in the other override operators, it
might seem obvious that they aren't needed for the removal operator.
But, it seems like I'm not the first to be confused about this.

Cc: Richard Purdie <richard.purdie@linuxfoundation.org>
Cc: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Cc: Ross Burton <ross.burton@arm.com>
Cc: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Johan Korsnes <johan.korsnes@remarkable.no>

---
v1->v2
 * better wording :)
---
 .../doc/bitbake-user-manual/bitbake-user-manual-metadata.rst   | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Michael Opdenacker Oct. 3, 2022, 5:22 p.m. UTC | #1
On 29.09.22 14:21, Johan Korsnes wrote:
> Inform the reader that there should be no need for spaces in the value
> when using removal override `:remove`.
>
> Considering why spaces are used in the other override operators, it
> might seem obvious that they aren't needed for the removal operator.
> But, it seems like I'm not the first to be confused about this.
>
> Cc: Richard Purdie <richard.purdie@linuxfoundation.org>
> Cc: Quentin Schulz <quentin.schulz@theobroma-systems.com>
> Cc: Ross Burton <ross.burton@arm.com>
> Cc: Nicolas Dechesne <nicolas.dechesne@linaro.org>
> Signed-off-by: Johan Korsnes <johan.korsnes@remarkable.no>
>
> ---
> v1->v2
>   * better wording :)
> ---
>   .../doc/bitbake-user-manual/bitbake-user-manual-metadata.rst   | 3 ++-
>   1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> index 337821612c..bc27eb1b6b 100644
> --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> @@ -330,7 +330,8 @@ Removal (Override Style Syntax)
>   
>   You can remove values from lists using the removal override style
>   syntax. Specifying a value for removal causes all occurrences of that
> -value to be removed from the variable.
> +value to be removed from the variable. Unlike ":append" and ":prepend",
> +there is no need to add a leading or trailing space to the value.
>   
>   When you use this syntax, BitBake expects one or more strings.
>   Surrounding spaces and spacing are preserved. Here is an example::


Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Thanks!
Michael.
diff mbox series

Patch

diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
index 337821612c..bc27eb1b6b 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -330,7 +330,8 @@  Removal (Override Style Syntax)
 
 You can remove values from lists using the removal override style
 syntax. Specifying a value for removal causes all occurrences of that
-value to be removed from the variable.
+value to be removed from the variable. Unlike ":append" and ":prepend",
+there is no need to add a leading or trailing space to the value.
 
 When you use this syntax, BitBake expects one or more strings.
 Surrounding spaces and spacing are preserved. Here is an example::