From 0538c321c9ce7076c35d79e08746714dbe7782b0 Mon Sep 17 00:00:00 2001 From: rocky Date: Tue, 2 Apr 2019 20:35:29 -0400 Subject: [PATCH] More information on solctest. * Note useful options * Link to boost reference. --- docs/contributing.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index c0ac358b7..7d5762946 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -71,15 +71,15 @@ Running the compiler tests ========================== The ``./scripts/tests.sh`` script executes most Solidity tests and -runs ``aleth`` automatically if it is in the path, but does not download it, +runs ``aleth`` automatically if it is in the path. The script does not download it, so you need to install it first. Please read on for the details. -Solidity includes different types of tests, most of them bundled into the ``soltest`` -application. Some of them require the ``aleth`` client in testing mode, others require ``libz3``. +Solidity includes different types of tests, most of them bundled into the `C++ Boost Test Framework `_ application ``soltest``. +Some of them require the ``aleth`` client in testing mode, others require ``libz3``. To run a basic set of tests that require neither ``aleth`` nor ``libz3``, run ``./scripts/soltest.sh --no-ipc --no-smt``. This script runs ``./build/test/soltest`` -internally. +internally. ``./build/test/soltest --help`` has extensive help on all of the options available. See especially `run_test `_ to list specific unit tests, and `report-level `_ give a more detailed report. .. note :: @@ -415,4 +415,4 @@ Running Documentation Tests --------------------------- Make sure your contributions pass our documentation tests by running ``./scripts/docs.sh`` that installs dependencies -needed for documentation and checks for any problems such as broken links or syntax issues. \ No newline at end of file +needed for documentation and checks for any problems such as broken links or syntax issues.