From 593d303ced57022747ce4debc94dd26b1f9b2b5c Mon Sep 17 00:00:00 2001 From: chriseth Date: Mon, 1 Oct 2018 12:54:04 +0200 Subject: [PATCH] fixup! fixup! [DOCS] Update contributing. --- docs/contributing.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index c065893b8..95a0f69dc 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -83,10 +83,10 @@ To run a basic set of tests that neither require ``aleth`` nor ``libz3``, run internally. The option ``--no-smt`` disables the tests that require ``libz3`` and -``--no-ipc`` disables those that requir ``aleth``. +``--no-ipc`` disables those that require ``aleth``. If you want to run the ipc tests (those test the semantics of the generated code), -you need to install `aleth `_ and run it in testing mode: ``aleth --test -d /tmp/testeth``. +you need to install `aleth `_ and run it in testing mode: ``aleth --test -d /tmp/testeth`` (make sure to rename it). Then you run the actual tests: ``./scripts/soltest.sh --ipcpath /tmp/testeth/geth.ipc``. @@ -109,7 +109,8 @@ Writing and running syntax tests Syntax tests check that the compiler generates the correct error messages for invalid code and properly accepts valid code. -They are stored in individual files. These files must contain annotations, stating the expected result(s) of the respective test. +They are stored in individual files inside ``tests/libsolidity/syntaxTests``. +These files must contain annotations, stating the expected result(s) of the respective test. The test suite will compile and check them against the given expectations. Example: ``./test/libsolidity/syntaxTests/double_stateVariable_declaration.sol``