summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChandan Singh <chandan@chandansingh.net>2020-08-04 21:10:26 +0000
committerbst-marge-bot <marge-bot@buildstream.build>2020-08-10 07:19:18 +0000
commit7dffdec0163983e0534e2e4d5f1bf97c543c3346 (patch)
treea0585794e606f03329b868e15bc0dd79283810b3 /doc
parent4f5e799091fef702134dcfdc45a8e8aa80bb14bf (diff)
downloadbuildstream-7dffdec0163983e0534e2e4d5f1bf97c543c3346.tar.gz
doc/using_the_testsuite: Link to instructions for runtime dependencies
Running the test suite requires one to install BuildStream's runtime dependencies as well, out of which BuildBox is the tricky one. We already have instructions on how to do that, so we just need to point to it from the hacking docs. Closes #1115.
Diffstat (limited to 'doc')
-rw-r--r--doc/source/hacking/using_the_testsuite.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/source/hacking/using_the_testsuite.rst b/doc/source/hacking/using_the_testsuite.rst
index 720c910c4..487e3caf4 100644
--- a/doc/source/hacking/using_the_testsuite.rst
+++ b/doc/source/hacking/using_the_testsuite.rst
@@ -33,6 +33,16 @@ For Debian-based systems::
apt install gcc python3-dev
+Installing runtime dependencies
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+To be able to run BuildStream as part of the test suite, BuildStream's runtime
+dependencies must also be installed. Instructions on how to do so can be found
+in :ref:`install-dependencies`.
+
+If you are not interested in running the integration tests, you can skip the
+installation of ``buildbox-run``.
+
+
Running tests
~~~~~~~~~~~~~
To run the tests, simply navigate to the toplevel directory of your BuildStream