diff mbox series

[master-next] migration-5.1: add the recommended pattern for S/UNPACKDIR definition

Message ID 20240528175207.369758-1-yoann.congal@smile.fr
State New
Headers show
Series [master-next] migration-5.1: add the recommended pattern for S/UNPACKDIR definition | expand

Commit Message

Yoann Congal May 28, 2024, 5:52 p.m. UTC
Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
---
 documentation/migration-guides/migration-5.1.rst | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

Comments

Michael Opdenacker May 29, 2024, 7:14 p.m. UTC | #1
Hi Yoann

On 5/28/24 at 19:52, Yoann Congal via lists.yoctoproject.org wrote:
> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
> ---
>   documentation/migration-guides/migration-5.1.rst | 11 ++++++++---
>   1 file changed, 8 insertions(+), 3 deletions(-)
>
> diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst
> index c1cc711a4..b43fecc2d 100644
> --- a/documentation/migration-guides/migration-5.1.rst
> +++ b/documentation/migration-guides/migration-5.1.rst
> @@ -59,9 +59,14 @@ Previously, :term:`S` was always created but after the recent changes it is no
>   longer the case. This means the check in ``do_unpack_qa`` triggers where
>   :term:`S` is not created by a recipe while it didn't happen before. This can
>   require to add an :term:`S` definition to a recipe that only uses
> -``file://`` :term:`SRC_URI` entries. Building C files from :term:`UNPACKDIR`
> -without setting :term:`S` to point at it does not work as the debug prefix
> -mapping doesn't handle that.
> +``file://`` :term:`SRC_URI` entries. To be consistent, the following pattern is
> +recommended::
> +
> +    S = "${WORKDIR}/sources"
> +    UNPACKDIR = "${S}"
> +
> +Building C files from :term:`UNPACKDIR` without setting :term:`S` to point at
> +it does not work as the debug prefix mapping doesn't handle that.
>   
>   ``devtool``  and ``recipetool`` have been updated to handle this and their
>   support for ``S = WORKDIR`` and ``oe-local-files`` has been removed.


Many thanks for this update!
Merged into master-next.
Cheers
Michael.
diff mbox series

Patch

diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst
index c1cc711a4..b43fecc2d 100644
--- a/documentation/migration-guides/migration-5.1.rst
+++ b/documentation/migration-guides/migration-5.1.rst
@@ -59,9 +59,14 @@  Previously, :term:`S` was always created but after the recent changes it is no
 longer the case. This means the check in ``do_unpack_qa`` triggers where
 :term:`S` is not created by a recipe while it didn't happen before. This can
 require to add an :term:`S` definition to a recipe that only uses
-``file://`` :term:`SRC_URI` entries. Building C files from :term:`UNPACKDIR`
-without setting :term:`S` to point at it does not work as the debug prefix
-mapping doesn't handle that.
+``file://`` :term:`SRC_URI` entries. To be consistent, the following pattern is
+recommended::
+
+    S = "${WORKDIR}/sources"
+    UNPACKDIR = "${S}"
+
+Building C files from :term:`UNPACKDIR` without setting :term:`S` to point at
+it does not work as the debug prefix mapping doesn't handle that.
 
 ``devtool``  and ``recipetool`` have been updated to handle this and their
 support for ``S = WORKDIR`` and ``oe-local-files`` has been removed.