summary refs log tree commit diff stats
path: root/doc/contributing.rst
diff options
context:
space:
mode:
authorFederico Ceratto <federico.ceratto@gmail.com>2019-01-25 10:29:46 +0000
committerAndreas Rumpf <rumpf_a@web.de>2019-01-25 11:29:46 +0100
commit87fce94d65296c8aab3b8103c3b7cf48c097e1d2 (patch)
treeb0f127078798801a8311f5c7d3651a093045e30e /doc/contributing.rst
parent70c7348d3e502fa718fb56848fca8df608a085f7 (diff)
downloadNim-87fce94d65296c8aab3b8103c3b7cf48c097e1d2.tar.gz
Add "cmd" description, minor improvements (#10436)
Diffstat (limited to 'doc/contributing.rst')
-rw-r--r--doc/contributing.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/contributing.rst b/doc/contributing.rst
index c67db081d..b89102a3b 100644
--- a/doc/contributing.rst
+++ b/doc/contributing.rst
@@ -71,9 +71,10 @@ to create a file for import into another test only, use the prefix ``m``.
 At the beginning of every test is the expected behavior of the test.
 Possible keys are:
 
-- output: The expected output, most likely via ``echo``
+- cmd: A compilation command template e.g. "nim $target --threads:on $options $file"
+- output: The expected output (stdout + stderr), most likely via ``echo``
 - exitcode: Exit code of the test (via ``exit(number)``)
-- errormsg: The expected error message
+- errormsg: The expected compiler error message
 - file: The file the errormsg was produced at
 - line: The line the errormsg was produced at