From 5cf552a62742c6ddc974ba5491188576d512254e Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Mon, 24 May 2010 17:38:19 +0200
Subject: Add run_test program for Common Test

Common Test may now be started with the program run_test instead of the legacy shell script with the same name.

Minor updates have also been made to the Webtool application.
---
 lib/common_test/doc/src/run_test.xml | 59 ++++++++++++++++++------------------
 1 file changed, 29 insertions(+), 30 deletions(-)

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

diff --git a/lib/common_test/doc/src/run_test.xml b/lib/common_test/doc/src/run_test.xml
index 451d3c5737..49538a7483 100644
--- a/lib/common_test/doc/src/run_test.xml
+++ b/lib/common_test/doc/src/run_test.xml
@@ -21,7 +21,7 @@
     
     </legalnotice>
 
-    <title>The run_test shell script</title>
+    <title>The run_test program</title>
     <prepared>Peter Andersson</prepared>
     <responsible>Peter Andersson</responsible>
     <docno></docno>
@@ -31,38 +31,39 @@
     <rev>PA2</rev>
     <file>run_test.xml</file>
   </header>
-  <com>run_test</com> 
-  <comsummary>Shell script used for starting
-  Common Test from the Unix command line.
+  <com>run_test</com>
+  <comsummary>Program used for starting Common Test from the
+    OS command line.
   </comsummary>
 
   <description>
-  <p>The <c>run_test</c> script is automatically generated as Common
-  Test is installed (please see the Installation chapter in the Common
-  Test User's Guide for more information). The script accepts a number 
-  of different start flags. Some flags trigger <c>run_test</c>
-  to start the Common Test application and pass on data to it. Some
-  flags start an Erlang node prepared for running Common Test in a
-  particular mode.</p>
-  <p><c>run_test</c> also accepts Erlang emulator
-  flags. These are used when <c>run_test</c> calls <c>erl</c> to
-  start the Erlang node (making it possible to e.g. add directories to
-  the code server path, change the cookie on the node, start
-  additional applications, etc).</p>
+  <p>The <c>run_test</c> program is automatically installed with Erlang/OTP
+    and Common Test (please see the Installation chapter in the Common
+    Test User's Guide for more information). The program accepts a number
+    of different start flags. Some flags trigger <c>run_test</c>
+    to start the Common Test application and pass on data to it. Some
+    flags start an Erlang node prepared for running Common Test in a
+    particular mode.</p>
+
+  <p><c>run_test</c> also accepts Erlang emulator flags. These are used
+    when <c>run_test</c> calls <c>erl</c> to start the Erlang node
+    (making it possible to e.g. add directories to the code server path,
+    change the cookie on the node, start additional applications, etc).</p>
+
   <p>If <c>run_test</c> is called without parameters, it prints all valid
-  start flags to stdout.</p>
+    start flags to stdout.</p>
   </description>
 
   <section>
     <title>Run tests from command line</title>
     <pre>
-    	run_test [-dir TestDir1 TestDir2 .. TestDirN] |	
-	[-suite Suite1 Suite2 .. SuiteN 
+	run_test [-dir TestDir1 TestDir2 .. TestDirN] |
+	[-suite Suite1 Suite2 .. SuiteN
 	 [[-group Group1 Group2 .. GroupN] [-case Case1 Case2 .. CaseN]]]
 	[-step [config | keep_inactive]]
 	[-config ConfigFile1 ConfigFile2 .. ConfigFileN]
 	[-userconfig CallbackModule1 ConfigString1 and CallbackModule2
-    ConfigString2 and .. and CallbackModuleN ConfigStringN]
+         ConfigString2 and .. and CallbackModuleN ConfigStringN]
 	[-decrypt_key Key] | [-decrypt_file KeyFile]
 	[-logdir LogDir]
 	[-silent_connections [ConnType1 ConnType2 .. ConnTypeN]]
@@ -82,7 +83,7 @@
 	run_test -spec TestSpec1 TestSpec2 .. TestSpecN
 	[-config ConfigFile1 ConfigFile2 .. ConfigFileN]
 	[-userconfig CallbackModule1 ConfigString1 and CallbackModule2
-    ConfigString2 and .. and CallbackModuleN ConfigStringN]
+         ConfigString2 and .. and CallbackModuleN ConfigStringN]
 	[-decrypt_key Key] | [-decrypt_file KeyFile]
 	[-logdir LogDir]
 	[-allow_user_terms]
@@ -103,7 +104,7 @@
         run_test -vts [-browser Browser]
 	[-config ConfigFile1 ConfigFile2 .. ConfigFileN]
 	[-userconfig CallbackModule1 ConfigString1 and CallbackModule2
-    ConfigString2 and .. and CallbackModuleN ConfigStringN]
+         ConfigString2 and .. and CallbackModuleN ConfigStringN]
 	[-decrypt_key Key] | [-decrypt_file KeyFile]
         [-dir TestDir1 TestDir2 .. TestDirN] |
         [-suite Suite [[-group Group] [-case Case]]]
@@ -119,10 +120,10 @@
   <section>
     <title>Run CT in interactive mode</title>
     <pre>
-	run_test -shell 
+	run_test -shell
 	[-config ConfigFile1 ConfigFile2 ... ConfigFileN]
 	[-userconfig CallbackModule1 ConfigString1 and CallbackModule2
-     ConfigString2 and .. and CallbackModuleN ConfigStringN]
+         ConfigString2 and .. and CallbackModuleN ConfigStringN]
 	[-decrypt_key Key] | [-decrypt_file KeyFile]</pre>
   </section>
   <section>
@@ -137,12 +138,10 @@
   </section>
 
   <section>
-  <title>See also</title>
-  <p>Please read the <seealso marker="run_test_chapter">Running Test Suites</seealso>
-  chapter in the Common Test User's Guide for information about the meaning of the
-  different start flags.</p>
+    <title>See also</title>
+    <p>Please read the <seealso marker="run_test_chapter">Running Test Suites</seealso>
+      chapter in the Common Test User's Guide for information about the meaning of the
+      different start flags.</p>
   </section>
 
 </comref>
-
-
-- 
cgit v1.2.3