From 2d7ba88ebbb59a473dbcefd0f9dee1f1b816935e Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Tue, 8 Jun 2010 14:44:05 +0200
Subject: Misc documentation updates

---
 lib/common_test/doc/src/run_test_chapter.xml | 31 +++++++++++++++++++++-------
 1 file changed, 24 insertions(+), 7 deletions(-)

(limited to 'lib/common_test/doc/src/run_test_chapter.xml')

diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml
index 7fd3174e71..54e9a3174c 100644
--- a/lib/common_test/doc/src/run_test_chapter.xml
+++ b/lib/common_test/doc/src/run_test_chapter.xml
@@ -97,8 +97,12 @@
       the <c><![CDATA[{auto_compile,false}]]></c> option with 
       <c><![CDATA[ct:run_test/1]]></c>. With automatic compilation
       disabled, the user is responsible for compiling the test suite modules 
-      (and any help modules) before the test run. Common Test will only verify 
-      that the specified test suites exist before starting the tests.</p> 
+      (and any help modules) before the test run. If the modules can not be loaded
+      from the local file system during startup of Common Test, the user needs to
+      pre-load the modules before starting the test. Common Test will only verify
+      that the specified test suites exist (i.e. that they are, or can be, loaded).
+      This is useful e.g. if the test suites are transferred and loaded as binaries via
+      RPC from a remote node.</p>
   </section>
 
   <section>
@@ -139,8 +143,14 @@
 	<seealso marker="cover_chapter#cover">Code Coverage Analysis</seealso>).</item>
       <item><c><![CDATA[-event_handler <event_handlers>]]></c>, to install 
         <seealso marker="event_handler_chapter#event_handling">event handlers</seealso>.</item>
+      <item><c><![CDATA[-event_handler_init <event_handlers>]]></c>, to install
+        <seealso marker="event_handler_chapter#event_handling">event handlers</seealso> including start arguments.</item>
       <item><c><![CDATA[-include]]></c>, specifies include directories (see above).</item>
       <item><c><![CDATA[-no_auto_compile]]></c>, disables the automatic test suite compilation feature (see above).</item>
+      <item><c><![CDATA[-multiply_timetraps <n>]]></c>, extends <seealso marker="write_test_chapter#timetraps">timetrap
+	  timeout</seealso> values.</item>
+      <item><c><![CDATA[-scale_timetraps <bool>]]></c>, enables automatic <seealso marker="write_test_chapter#timetraps">timetrap
+	  timeout</seealso> scaling.</item>
       <item><c><![CDATA[-repeat <n>]]></c>, tells Common Test to repeat the tests n times (see below).</item> 
       <item><c><![CDATA[-duration <time>]]></c>, tells Common Test to repeat the tests for duration of time (see below).</item> 
       <item><c><![CDATA[-until <stop_time>]]></c>, tells Common Test to repeat the tests until stop_time (see below).</item> 
@@ -243,11 +253,12 @@
       call <c>ct:start_interactive/0</c> to start Common Test. If you use
       the <c>run_test</c> program, you may start the Erlang shell and Common Test
       in the same go by using the <c>-shell</c> and, optionally, the <c>-config</c>
-      flag:
+      and/or <c>-userconfig</c> flag. Examples:
     </p>
     <list>
       <item><c>run_test -shell</c></item>
-      <item><c><![CDATA[run_test -shell -config <configfilename>]]></c></item>
+      <item><c><![CDATA[run_test -shell -config cfg/db.cfg]]></c></item>
+      <item><c><![CDATA[run_test -shell -userconfig db_login testuser x523qZ]]></c></item>
     </list>
     
     <p>If no config file is given with the <c>run_test</c> command,
@@ -272,7 +283,8 @@
        2> ct_telnet:open(unix_telnet).
        {ok,&lt;0.105.0&gt;}
        4> ct_telnet:cmd(unix_telnet, "ls .").
-       {ok,["ls .","file1  ...",...]}</pre>
+       {ok,["ls .","file1  ...",...]}
+    </pre>
     
     <p>Everything that Common Test normally prints in the test case logs,
       will in the interactive mode be written to a log named
@@ -362,10 +374,13 @@
       chapter.</p>
       <p>Config terms:</p>
     <pre>
+      {node, NodeAlias, Node}.
+
       {init, InitOptions}.
       {init, [NodeAlias], InitOptions}.
 
-      {node, NodeAlias, Node}.
+      {multiply_timetraps, N}.
+      {scale_timetraps, Bool}.
  
       {cover, CoverSpecFile}.
       {cover, NodeRef, CoverSpecFile}.
@@ -405,11 +420,13 @@
     </pre>
       <p>Types:</p>
     <pre>
-      InitOptions   = term()
       NodeAlias     = atom()
+      InitOptions   = term()
       Node          = node()
       NodeRef       = NodeAlias | Node | master
       NodeRefs      = all_nodes | [NodeRef] | NodeRef
+      N             = integer()
+      Bool          = true | false
       CoverSpecFile = string()
       IncludeDirs   = string() | [string()]
       ConfigFiles   = string() | [string()]
-- 
cgit v1.2.3