diff mbox series

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

Message ID 20241001172238.2872529-2-yoann.congal@smile.fr
State Superseded
Headers show
Series Document my team's commits for 5.1 | expand

Commit Message

Yoann Congal Oct. 1, 2024, 5:22 p.m. UTC 
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>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
---
v1->v2: Reviews from Quentin Schulz:
* environnement -> environment
* oeqa/selftest now only rewrite*s*
* Add exemples for the selftest change
v2->v3:
* Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
* Reviews from Quentin Schulz:
  * BB_LOGCONFIG -> :term:``BB_LOGCONFIG`` + removed ad-hoc definition
  * selftest -> `oe-selftest` (to avoid confusion with bitbake-selftest)
---
 documentation/migration-guides/migration-5.1.rst   | 14 ++++++++++++++
 .../migration-guides/release-notes-5.1.rst         |  2 ++
 2 files changed, 16 insertions(+)

Comments

Antonin Godard Oct. 2, 2024, 7:15 a.m. UTC | #1 
Hi Yoann,

> +   For example (taken from :yocto_ab:`autobuilder <>` environment):
> +   :term:``BB_LOGCONFIG`` is set as:

When referring to terms, you should use single-tick, not double,
otherwise it's not parsed correctly and it doesn't create a reference
(treated as code instead).

Cheers,
Antonin
Yoann Congal Oct. 2, 2024, 8:58 a.m. UTC | #2 
Le 02/10/2024 à 09:15, Antonin Godard a écrit :
> Hi Yoann,
> 
>> +   For example (taken from :yocto_ab:`autobuilder <>` environment):
>> +   :term:``BB_LOGCONFIG`` is set as:
> 
> When referring to terms, you should use single-tick, not double,
> otherwise it's not parsed correctly and it doesn't create a reference
> (treated as code instead).

d'oh! v4 sent :)

> 
> Cheers,
> Antonin
diff mbox series

Patch

diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst
index b43fecc2d..f4bb8df0c 100644
--- a/documentation/migration-guides/migration-5.1.rst
+++ b/documentation/migration-guides/migration-5.1.rst
@@ -141,3 +141,17 @@  QEMU changes
 Miscellaneous changes
 ~~~~~~~~~~~~~~~~~~~~~
 
+-  `oe-selftest` now only rewrites environment variable paths that absolutely
+   point to builddir (i.e ``X=$BUILDDIR/conf/`` is still rewritten to point to
+   the `oe-selftest` ``conf/`` directory but not ``Y=$BUILDDIR/../bitbake/`` which
+   still point to the ``bitbake/`` directory)
+
+   For example (taken from :yocto_ab:`autobuilder <>` environment):
+   :term:``BB_LOGCONFIG`` 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 `oe-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 `oe-selftest`.
diff --git a/documentation/migration-guides/release-notes-5.1.rst b/documentation/migration-guides/release-notes-5.1.rst
index 32cb2de2b..c2600b07f 100644
--- a/documentation/migration-guides/release-notes-5.1.rst
+++ b/documentation/migration-guides/release-notes-5.1.rst
@@ -26,6 +26,8 @@  New Features / Enhancements in 5.1
 
 -  Testing:
 
+   -  oeqa/selftest: Only rewrite envvars paths that absolutely point to builddir
+
 -  Utility script changes:
 
 -  BitBake improvements: