diff mbox series

README: improve explanation about running the testsuite

Message ID 20221205181308.14562-1-debrabander@gmail.com
State New
Headers show
Series README: improve explanation about running the testsuite | expand

Commit Message

Frank de Brabander Dec. 5, 2022, 6:13 p.m. UTC 
Explain how to run the testsuite clear enough so no external
documentation is required.

Signed-off-by: Frank de Brabander <debrabander@gmail.com>
---
 README | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/README b/README
index 7b4a2b76..af23c9af 100644
--- a/README
+++ b/README
@@ -39,10 +39,21 @@  Source code:
 
     https://git.openembedded.org/bitbake/
 
-Testing:
+Testing
+-------
 
 Bitbake has a testsuite located in lib/bb/tests/ whichs aim to try and prevent regressions.
 You can run this with "bitbake-selftest". In particular the fetcher is well covered since
 it has so many corner cases. The datastore has many tests too. Testing with the testsuite is
 recommended before submitting patches, particularly to the fetcher and datastore. We also
 appreciate new test cases and may require them for more obscure issues.
+
+To run the tests "zstd" and "git" must be installed. Git must be correctly configured, in
+particular the user.email and user.name values must be set.
+
+The assumption is made that this testsuite is run from an initialized OpenEmbedded build
+environment (i.e. `source oe-init-build-env` is used). If this is not the case, run the
+testsuite as follows:
+
+    export PATH=$(pwd)/bin:$PATH
+    bin/bitbake-selftest