summaryrefslogtreecommitdiff
path: root/lib/common_test/doc/src/run_test_chapter.xml
diff options
context:
space:
mode:
authorPeter Andersson <peppe@erlang.org>2015-06-09 00:51:56 +0200
committerPeter Andersson <peppe@erlang.org>2015-06-09 00:51:56 +0200
commita0a088704e17a9c9f9a0013f07aa90d880a7a50e (patch)
tree8744a249353345611a32f6eeba8b0b4d9f01a856 /lib/common_test/doc/src/run_test_chapter.xml
parentb4774c9d55a1606a1abc726e0f7ce563065284b3 (diff)
downloaderlang-a0a088704e17a9c9f9a0013f07aa90d880a7a50e.tar.gz
Change default start actions and update documentation
Diffstat (limited to 'lib/common_test/doc/src/run_test_chapter.xml')
-rw-r--r--lib/common_test/doc/src/run_test_chapter.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml
index df60e5f7f2..fc8d82c2c3 100644
--- a/lib/common_test/doc/src/run_test_chapter.xml
+++ b/lib/common_test/doc/src/run_test_chapter.xml
@@ -149,6 +149,7 @@
<p>Other flags that may be used with <c>ct_run</c>:</p>
<list>
+ <item><c><![CDATA[-help]]></c>, lists all available start flags.</item>
<item><c><![CDATA[-logdir <dir>]]></c>, specifies where the HTML log files are to be written.</item>
<item><c><![CDATA[-label <name_of_test_run>]]></c>, associates the test run with a name that gets printed
in the overview HTML log files.</item>
@@ -223,6 +224,9 @@
behaviour using start flag:</p>
<pre>-exit_status ignore_config</pre>
+ <note><p>Executing <c>ct_run</c> without start flags, is equal to the command:
+ <c>ct_run -dir ./</c></p></note>
+
<p>For more information about the <c>ct_run</c> program, see the
<seealso marker="ct_run">Reference Manual</seealso> and the
<seealso marker="install_chapter#general">Installation</seealso> chapter.
@@ -251,6 +255,10 @@
<c>{error,Reason}</c>, where the term <c>Reason</c> explains the
failure.</p>
+ <p>The default start option <c>{dir,Cwd}</c> (run all suites in the current
+ working directory) is used if the function is called with an empty
+ list of options.</p>
+
<section>
<title>Releasing the Erlang shell</title>
<p>During execution of tests, started with