diff mbox series

doc: improve BitBake README testing instructions

Message ID 20250818163337.3440-1-mohamedaymanworkspace2@gmail.com
State New
Headers show
Series doc: improve BitBake README testing instructions | expand

Commit Message

Mohamed Ayman Aug. 18, 2025, 4:33 p.m. UTC 
Clarified the testing section by:
- Adding context on setting PATH before running selftests
- Documenting how to install pytest using pip
- Providing an example command for running pytest on lib/bb/tests

These additions make it easier for new contributors to run the
testsuite and ensure consistent testing practices.

Signed-off-by: Mohamed Ayman <mohamedaymanworkspace2@gmail.com>
---
 bitbake/README | 7 +++++++
 1 file changed, 7 insertions(+)
diff mbox series

Patch

diff --git a/bitbake/README b/bitbake/README
index e9f4c858ee..938eec47ce 100644
--- a/bitbake/README
+++ b/bitbake/README
@@ -54,10 +54,17 @@  The assumption is made that this testsuite is run from an initialized OpenEmbedd
 environment (i.e. `source oe-init-build-env` is used). If this is not the case, run the
 testsuite as follows:
 
+# ensure local tools are on PATH and run the selftest script
     export PATH=$(pwd)/bin:$PATH
     bin/bitbake-selftest
 
 The testsuite can alternatively be executed using pytest, e.g. obtained from PyPI (in this
 case, the PATH is configured automatically):
 
+# install pytest into a virtualenv or pipx (recommended)
+python -m pip install --user pytest
+
+# run tests (example)
+python -m pytest lib/bb/tests -q
+
     pytest