aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorFrank de Brabander <debrabander@gmail.com>2022-12-05 19:13:08 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-12-05 22:36:47 +0000
commit51cf7cf12d23b757aa49f428a256fb3d3c865f6d (patch)
tree70523fe72e7c9a14baa4bfde610656f1f7711996 /README
parentb4a8e5071dbcba2217b79e83e08b275ffcbc0eef (diff)
downloadbitbake-contrib-51cf7cf12d23b757aa49f428a256fb3d3c865f6d.tar.gz
README: Improve explanation about running the testsuite
Explain how to run the testsuite clear enough so no external documentation is required. Signed-off-by: Frank de Brabander <debrabander@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'README')
-rw-r--r--README13
1 files changed, 12 insertions, 1 deletions
diff --git a/README b/README
index 7b4a2b76c..af23c9af2 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