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

["Antonin Godard" <antonin.godard@bootlin.com>]

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

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com