[1/4] migration/release-notes-5.1: document oeqa/selftest envvars change

From: Yoann Congal <yoann.congal@smile.fr>

This covers the Poky commit:
61186bc98a5 (oeqa/selftest: Only rewrite envvars paths that absolutely point to builddir, 2024-09-10)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
---
 documentation/migration-guides/migration-5.1.rst     | 5 +++++
 documentation/migration-guides/release-notes-5.1.rst | 2 ++
 2 files changed, 7 insertions(+)

Hi Yoann,

On 9/25/24 3:20 PM, Yoann Congal via lists.yoctoproject.org wrote:
> From: Yoann Congal <yoann.congal@smile.fr>
> 
> This covers the Poky commit:
> 61186bc98a5 (oeqa/selftest: Only rewrite envvars paths that absolutely point to builddir, 2024-09-10)
> 
> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
> ---
>   documentation/migration-guides/migration-5.1.rst     | 5 +++++
>   documentation/migration-guides/release-notes-5.1.rst | 2 ++
>   2 files changed, 7 insertions(+)
> 
> diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst
> index b43fecc2d..14329c6a8 100644
> --- a/documentation/migration-guides/migration-5.1.rst
> +++ b/documentation/migration-guides/migration-5.1.rst
> @@ -141,3 +141,8 @@ QEMU changes
>   Miscellaneous changes
>   ~~~~~~~~~~~~~~~~~~~~~
>   
> +   -  oeqa/selftest now only rewrite environnement variable paths that

Maybe it should be "rewrites" here? Not sure though.

> +     absolutely point to builddir. Environnement variables containing relative
> +     paths from tested build directory to outside of the original build
> +     directory may need update as they won't be changed by selftest.

s/environnement/environment/ for all matches in that paragraph.

I'm not sure what I'm supposed to do with this information, it's very 
vague. It's part of the migration manual so I think it would benefit 
from being a bit more explicit, are there some precise examples we can 
provide. If it's a finite list of variables to watch for, it's even 
better. Otherwise a few examples would be useful? What do you think?

Cheers,
Quentin

Le 26/09/2024 à 14:48, Quentin Schulz a écrit :
> Hi Yoann,
> 
> On 9/25/24 3:20 PM, Yoann Congal via lists.yoctoproject.org wrote:
>> From: Yoann Congal <yoann.congal@smile.fr>
>>
>> This covers the Poky commit:
>> 61186bc98a5 (oeqa/selftest: Only rewrite envvars paths that absolutely point to builddir, 2024-09-10)
>>
>> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
>> ---
>>   documentation/migration-guides/migration-5.1.rst     | 5 +++++
>>   documentation/migration-guides/release-notes-5.1.rst | 2 ++
>>   2 files changed, 7 insertions(+)
>>
>> diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst
>> index b43fecc2d..14329c6a8 100644
>> --- a/documentation/migration-guides/migration-5.1.rst
>> +++ b/documentation/migration-guides/migration-5.1.rst
>> @@ -141,3 +141,8 @@ QEMU changes
>>   Miscellaneous changes
>>   ~~~~~~~~~~~~~~~~~~~~~
>>   +   -  oeqa/selftest now only rewrite environnement variable paths that
> 
> Maybe it should be "rewrites" here? Not sure though.
> 
>> +     absolutely point to builddir. Environnement variables containing relative
>> +     paths from tested build directory to outside of the original build
>> +     directory may need update as they won't be changed by selftest.
> 
> s/environnement/environment/ for all matches in that paragraph.
> 
> I'm not sure what I'm supposed to do with this information, it's very vague. It's part of the migration manual so I think it would benefit from being a bit more explicit, are there some precise examples we can provide. If it's a finite list of variables to watch for, it's even better. Otherwise a few examples would be useful? What do you think?

You are right, it was not really clear... I've sent a v2 with more examples.

Thanks!

> 
> Cheers,
> Quentin