bitbake-user-manual: add note about the old syntax for OVERRIDES

Message ID 20220307183803.534661-1-michael.opdenacker@bootlin.com
State New
Headers show
Series bitbake-user-manual: add note about the old syntax for OVERRIDES | expand

Commit Message

Michael Opdenacker March 7, 2022, 6:38 p.m. UTC
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 .../bitbake-user-manual-metadata.rst                   | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Quentin Schulz March 10, 2022, 10:54 a.m. UTC | #1
Hi Michael,

On 3/7/22 19:38, Michael Opdenacker via lists.yoctoproject.org wrote:
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> Reported-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
> Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org>
> ---
>   .../bitbake-user-manual-metadata.rst                   | 10 ++++++++++
>   1 file changed, 10 insertions(+)
> 
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> index b90e5cf0..97114ed6 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> @@ -585,6 +585,16 @@ variable.
>   
>         EXTRA_OEMAKE:prepend:task-compile = "${PARALLEL_MAKE} "
>   
> +.. note::
> +
> +   Before BitBake 1.52 (Honister 3.4), the syntax for :term:`OVERRIDES`
> +   used ``_`` instead of ``:``, so you will still find a lot of documentation

We should mention that we're talking about external/third party 
documentation/tutorials and not ours :)

Cheers,
Quentin
Michael Opdenacker March 10, 2022, 3:14 p.m. UTC | #2
Hi Quentin

Thanks for the review.

On 3/10/22 11:54, Quentin Schulz wrote:
> We should mention that we're talking about external/third party
> documentation/tutorials and not ours :)


Oops, Richard already merged the change. Is it really worth it to make
another commit for such an update?
Cheers
Michael.

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
index b90e5cf0..97114ed6 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -585,6 +585,16 @@  variable.
 
       EXTRA_OEMAKE:prepend:task-compile = "${PARALLEL_MAKE} "
 
+.. note::
+
+   Before BitBake 1.52 (Honister 3.4), the syntax for :term:`OVERRIDES`
+   used ``_`` instead of ``:``, so you will still find a lot of documentation
+   using ``_append``, ``_prepend``, and ``_remove``, for example.
+
+   For details, see the
+   :yocto_docs:`Overrides Syntax Changes </migration-guides/migration-3.4.html#override-syntax-changes>`
+   section in the Yocto Project manual migration notes.
+
 Key Expansion
 -------------