diff mbox series

[6/6] migration-guides/migration-5.1.rst: correct S/UNPACKDIR patterns for file-only recipes

Message ID 20250623124257.1544615-6-alex.kanavin@gmail.com
State Under Review
Headers show
Series [1/6] overview-manual: correct value of UNPACKDIR and put S under it | expand

Commit Message

Alexander Kanavin June 23, 2025, 12:42 p.m. UTC
From: Alexander Kanavin <alex@linutronix.de>

It is not necessary to set both; just setting S to UNPACKDIR is enough.

This has already been done across oe-core master, and correct advice
should be given for those who need to adjust recipes during migration.

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
---
 documentation/migration-guides/migration-5.1.rst | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

Comments

Antonin Godard June 24, 2025, 7:43 a.m. UTC | #1
Hi Alex,

On Mon Jun 23, 2025 at 2:42 PM CEST, Alexander Kanavin via lists.yoctoproject.org wrote:
> From: Alexander Kanavin <alex@linutronix.de>
>
> It is not necessary to set both; just setting S to UNPACKDIR is enough.
>
> This has already been done across oe-core master, and correct advice
> should be given for those who need to adjust recipes during migration.
>
> Signed-off-by: Alexander Kanavin <alex@linutronix.de>
> ---
>  documentation/migration-guides/migration-5.1.rst | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
>
> diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst
> index c9bb38699b4..94b527bdcb3 100644
> --- a/documentation/migration-guides/migration-5.1.rst
> +++ b/documentation/migration-guides/migration-5.1.rst
> @@ -20,8 +20,7 @@ S = ${WORKDIR} no longer supported
>  If a recipe has :term:`S` set to be :term:`WORKDIR`, this is no longer
>  supported, and an error will be issued. The recipe should be changed to::
>  
> -    S = "${WORKDIR}/sources"
> -    UNPACKDIR = "${S}"
> +    S = "${UNPACKDIR}"
>  
>  Any :term:`WORKDIR` references where files from :term:`SRC_URI` are referenced
>  should be changed to :term:`S`. These are commonly in :ref:`ref-tasks-compile`,
> @@ -62,8 +61,7 @@ require to add an :term:`S` definition to a recipe that only uses
>  ``file://`` :term:`SRC_URI` entries. To be consistent, the following pattern is
>  recommended::
>  
> -    S = "${WORKDIR}/sources"
> -    UNPACKDIR = "${S}"
> +    S = "${UNPACKDIR}"
>  
>  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.

The series looks great, thanks.

I think we could also mention it in migration-5.3.rst, and also mention that S =
"${WORKDIR}/git" should now be removed?

Could you send a follow-up patch?

Antonin
Alexander Kanavin June 24, 2025, 9:13 a.m. UTC | #2
On Tue, 24 Jun 2025 at 09:43, Antonin Godard <antonin.godard@bootlin.com> wrote:

> The series looks great, thanks.
>
> I think we could also mention it in migration-5.3.rst, and also mention that S =
> "${WORKDIR}/git" should now be removed?
>
> Could you send a follow-up patch?

I just sent that; the content should be accurate, but the formatting
probably isn't perfect.

Alex
Antonin Godard June 24, 2025, 9:38 a.m. UTC | #3
On Tue Jun 24, 2025 at 11:13 AM CEST, Alexander Kanavin wrote:
> On Tue, 24 Jun 2025 at 09:43, Antonin Godard <antonin.godard@bootlin.com> wrote:
>
>> The series looks great, thanks.
>>
>> I think we could also mention it in migration-5.3.rst, and also mention that S =
>> "${WORKDIR}/git" should now be removed?
>>
>> Could you send a follow-up patch?
>
> I just sent that; the content should be accurate, but the formatting
> probably isn't perfect.

Thanks a lot. I'll send a patch to document BB_GIT_DEFAULT_DESTSUFFIX in bitbake
and yocto-docs. I'll also re-send your patch (who depends on it) to fix the
formatting issues.

Antonin
diff mbox series

Patch

diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst
index c9bb38699b4..94b527bdcb3 100644
--- a/documentation/migration-guides/migration-5.1.rst
+++ b/documentation/migration-guides/migration-5.1.rst
@@ -20,8 +20,7 @@  S = ${WORKDIR} no longer supported
 If a recipe has :term:`S` set to be :term:`WORKDIR`, this is no longer
 supported, and an error will be issued. The recipe should be changed to::
 
-    S = "${WORKDIR}/sources"
-    UNPACKDIR = "${S}"
+    S = "${UNPACKDIR}"
 
 Any :term:`WORKDIR` references where files from :term:`SRC_URI` are referenced
 should be changed to :term:`S`. These are commonly in :ref:`ref-tasks-compile`,
@@ -62,8 +61,7 @@  require to add an :term:`S` definition to a recipe that only uses
 ``file://`` :term:`SRC_URI` entries. To be consistent, the following pattern is
 recommended::
 
-    S = "${WORKDIR}/sources"
-    UNPACKDIR = "${S}"
+    S = "${UNPACKDIR}"
 
 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.