aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormordax <maya@mordax.io>2018-10-10 08:25:30 +0800
committerchriseth <chris@ethereum.org>2018-10-15 17:37:02 +0800
commitf60251f3b415552fb914f7980bdc677897d9153b (patch)
tree22a6e5075cad37c4d1c38116722569d75185c702
parent5a921c4d6a70c9ad13acbf80a74dbfe838369b56 (diff)
downloaddexon-solidity-f60251f3b415552fb914f7980bdc677897d9153b.tar.gz
dexon-solidity-f60251f3b415552fb914f7980bdc677897d9153b.tar.zst
dexon-solidity-f60251f3b415552fb914f7980bdc677897d9153b.zip
Add extra documentation for running compiler tests on Windows
-rw-r--r--docs/contributing.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 361570a0..32696520 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -82,6 +82,11 @@ To run a basic set of tests that neither require ``aleth`` nor ``libz3``, run
``./scripts/soltest.sh --no-ipc --no-smt``. This script will run ``build/test/soltest``
internally.
+.. note ::
+
+ Those working in a Windows environment wanting to run the above basic sets without aleth or libz3 in Git Bash, you would have to do: ``./build/test/RelWithDebInfo/soltest.exe -- --no-ipc --no-smt``.
+ If you're running this in plain Command Prompt, use ``.\build\test\RelWithDebInfo\soltest.exe -- --no-ipc --no-smt``.
+
The option ``--no-smt`` disables the tests that require ``libz3`` and
``--no-ipc`` disables those that require ``aleth``.