All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] README: improve explanation about running the testsuite
@ 2022-12-05 18:13 Frank de Brabander
  0 siblings, 0 replies; only message in thread
From: Frank de Brabander @ 2022-12-05 18:13 UTC (permalink / raw)
  To: bitbake-devel; +Cc: Frank de Brabander

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 --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
-- 
2.20.1



^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2022-12-05 18:13 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-12-05 18:13 [PATCH] README: improve explanation about running the testsuite Frank de Brabander

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.