aboutsummaryrefslogtreecommitdiffstats
path: root/docs/contributing.rst
diff options
context:
space:
mode:
authorRobert Chung <robertchung97@gmail.com>2018-12-02 13:32:13 +0800
committerRobert Chung <robertchung97@gmail.com>2018-12-02 13:40:43 +0800
commit4a907faf44b5ca899a316c4646df97b351060423 (patch)
treee48c1a5964e83e4a3902ddc133a859685d7912f6 /docs/contributing.rst
parent757623e381aba24b81a2365cf19037d3d96bf945 (diff)
downloaddexon-solidity-4a907faf44b5ca899a316c4646df97b351060423.tar.gz
dexon-solidity-4a907faf44b5ca899a316c4646df97b351060423.tar.zst
dexon-solidity-4a907faf44b5ca899a316c4646df97b351060423.zip
Added information about debugging and examples on how to run subsets of tests.
Diffstat (limited to 'docs/contributing.rst')
-rw-r--r--docs/contributing.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 4ac93565..f9c4d9d9 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -98,6 +98,20 @@ To run a subset of tests, you can use filters:
``./scripts/soltest.sh -t TestSuite/TestName --ipcpath /tmp/testeth/geth.ipc``,
where ``TestName`` can be a wildcard ``*``.
+For example, here's an example test you might run;
+``./scripts/soltest.sh -t "yulOptimizerTests/disambiguator/*" --no-ipc --no-smt``.
+This will test all the tests for the disambiguator.
+
+If you want to debug using GDB, make sure you build differently than the "usual".
+For example, you could run the following command in your ``build`` folder:
+::
+
+ cmake -DCMAKE_BUILD_TYPE=Debug ..
+ make
+
+This will create symbols such that when you debug a test using the ``--debug`` flag, you will have acecess to functions and varialbes in which you can break or print with.
+
+
The script ``./scripts/tests.sh`` also runs commandline tests and compilation tests
in addition to those found in ``soltest``.