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

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

Hi Quentin,

On 01/10/2024 11:40, Quentin Schulz via lists.yoctoproject.org wrote:
> Hi Yoann,
> 
> On 9/28/24 12:00 AM, 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>
>> ---
>> v1->v2: Reviews from Quentin Schulz:
>> * environnement -> environment
>> * oeqa/selftest now only rewrite*s*
>> * Add exemples for the selftest change
>> ---
>>   documentation/migration-guides/migration-5.1.rst  | 15 +++++++++++++++
>>   .../migration-guides/release-notes-5.1.rst        |  2 ++
>>   2 files changed, 17 insertions(+)
>>
>> diff --git a/documentation/migration-guides/migration-5.1.rst 
>> b/documentation/migration-guides/migration-5.1.rst
>> index b43fecc2d..4625ff0e1 100644
>> --- a/documentation/migration-guides/migration-5.1.rst
>> +++ b/documentation/migration-guides/migration-5.1.rst
>> @@ -141,3 +141,18 @@ QEMU changes
>>   Miscellaneous changes
>>   ~~~~~~~~~~~~~~~~~~~~~
>> +-  oeqa/selftest now only rewrites environment variable paths that 
>> absolutely
>> +   point to builddir (i.e ``X=$BUILDDIR/conf/`` is still rewritten to 
>> point to
>> +   the selftest ``conf/`` directory but not 
>> ``Y=$BUILDDIR/../bitbake/`` which
>> +   still point to the ``bitbake/`` directory)
>> +
>> +   For example (taken from autobuilder environment): ``BB_LOGCONFIG`` 
>> is an
> 
> nit: could use :term:`BB_LOGCONFIG` here since we have it defined in the 
> reference manual? We could probably even avoid explaining what it means 
> here (not necessarily though).

Good catch, you can indeed use :term:`BB_LOGCONFIG` and avoid explaining
its purpose.

>> +   Environment variables containing relative paths from tested build 
>> directory
>> +   to outside of the original build directory may need to be updated 
>> as they
>> +   won't be changed by selftest.
> 
> selftest should be single-tick-quoted as defined as standard in the git 
> repo, c.f. 
> https://git.yoctoproject.org/yocto-docs/tree/documentation/standards.md
> 
> This was done by Michael but he's not the maintainer anymore so I guess 
> whoever replaces him may have a different opinion, in which case 
> extending or replacing it would be most welcome, is that you Antonin

Indeed, I am slowly replacing Michael in this role and getting familiar
with the documentation details. I'm also writing the release note for
the next release at the moment (will send a series of patch this week
hopefully).

Thanks for your reviews, they also help. As for selftest, I haven't seen
it referenced with single-tick quotes elsewhere, unless you meant double
ticks for code?

> On a side note, I still wouldn't really know which variables I need to 
> look after or what happens if I don't (is there an explicit error, are 
> there side effects, if so, how do they show up?). But admittedly, I have 
> zero experience with oeqa or selftest so people in the know probably 
> know what this is talking about? In any case, I guess we can revisit 
> this later on, it's not written in stone, and better have something than 
> nothing :)

Agree with you, and having no experience as well on oeqa and selftest,
it's hard for me to also making a proper judgment.

Cheers,
Antoni