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

[Quentin Schulz <quentin.schulz@cherry.de>]

Hi Yoann,

On 10/2/24 10:57 AM, Yoann Congal wrote:
> 
> 
> Le 01/10/2024 à 11:40, Quentin Schulz a écrit :
>> 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).
>>
>>> +   environment variable containing a path that configures bitbake logs. In
>>> +   autobuilder, it is set as:
>>> +   ``BB_LOGCONFIG="${BUILDDIR}/../bitbake/contrib/autobuilderlog.json"``.
>>> +   Note the relative path starting from the build directory to outside of it.
>>> +   This path is not changed by selftest anymore.
>>> +
>>> +   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?
> 
> 
>> On a side note,
> I've tried to make it clearer, I'll answer your questions inline maybe we'll find a better wording?
> 
>> I still wouldn't really know which variables I need to look after
> 
> That can be any environment variable containing the build directory path but relatively pointing to outside of the build dir (like $BUILD_DIR/../bitbake)
> 
>> or what happens if I don't (is there an explicit error, are there side effects, if so, how do they show up?).
> 
> It depends on how this variable is used.
> 
> Ultimately, there was a bug (https://bugzilla.yoctoproject.org/show_bug.cgi?id=15241 but the bug is more global than just BB_LOGCONFIG) and the workarounds that users may have been used are not needed anymore or broken.
> 

Note: I don't want this discussion to prevent merging this patch in time 
for Styhead release, we can always improve later.

Are those environment variables necessarily in the **shell** environment 
or are we also talking about variables that could be defined in bitbake 
conf files for example?

If they are shell environment variables, I believe (hope?) selftest/oeqa 
can only access them if they are part of the BB_ENV_PASSTHROUGH and 
BB_ENV_PASSTHROUGH_ADDITIONS variables? If that is the case, then we can 
simply tell people to look for relative paths in all variables listed in 
BB_ENV_PASSTHROUGH (via bitbake-getvar for example)?

Cheers,
Quentin