Merge pull request #5562 from Altrum/debugDocs

Updated docs on information about debugging and how to run commands.

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``.