Merge remote branch 'origin/peppe/common_test/documentation_r15b02.2'…

… into maint * origin/peppe/common_test/documentation_r15b02.2: Update the documentation for R15B02 OTP-10050 OTP-10069 OTP-10072 OTP-10087 OTP-9865 OTP-10049 OTP-10089 OTP-10145 OTP-9896 OTP-10135 OTP-10067 OTP-9625 OTP-10127 OTP-10172 OTP-10248 OTP-9625 OTP-10086 OTP-10248
erlang · Aug 30, 2012 · 5c47519 · 5c47519
2 parents 94f6c68 + 02e8dc9
commit 5c47519
Show file tree

Hide file tree

Showing 7 changed files with 624 additions and 318 deletions.
diff --git a/lib/common_test/doc/src/config_file_chapter.xml b/lib/common_test/doc/src/config_file_chapter.xml
@@ -29,6 +29,8 @@
     <file>config_file_chapter.xml</file>
   </header>
 
+    <marker id="top"></marker>
+
   <section>
     <title>General</title>
 

diff --git a/lib/common_test/doc/src/ct_master_chapter.xml b/lib/common_test/doc/src/ct_master_chapter.xml
@@ -124,7 +124,8 @@
     <p><c>NodeRef = NodeAlias | node() | master</c></p>
 
     <p>A <c>NodeAlias</c> (<c>atom()</c>) is used in a test specification as a 
-    reference to a node name (so the actual node name only needs to be declared once). 
+    reference to a node name (so the actual node name only needs to be declared once,
+      which can of course also be achieved using constants). 
     The alias is declared with a <c>node</c> term:</p>
 
     <p><c>{node, NodeAlias, NodeName}</c></p>
@@ -141,30 +142,32 @@
     CT Master:</p>
 
     <pre>
-      {node, node1, ct_node@host_x}.
+      {define, 'Top', "/home/test"}.
-      {node, node2, ct_node@host_y}.
+      {define, 'T1', "'Top'/t1"}.
-
+      {define, 'T2', "'Top'/t2"}.
-      {logdir, master, "/home/test/master_logs"}.
+      {define, 'T3', "'Top'/t3"}.
-      {logdir, "/home/test/logs"}.
+      {define, 'CfgFile', "config.cfg"}.
+      {define, 'Node', ct_node}.
+
+      {node, node1, 'Node@host_x'}.
+      {node, node2, 'Node@host_y'}.
+
+      {logdir, master, "'Top'/master_logs"}.
+      {logdir, "'Top'/logs"}.
 
-      {config, node1, "/home/test/t1/cfg/config.cfg"}.
+      {config, node1, "'T1'/'CfgFile'"}.
-      {config, node2, "/home/test/t2/cfg/config.cfg"}.
+      {config, node2, "'T2'/'CfgFile'"}.
-      {config, "/home/test/t3/cfg/config.cfg"}.
+      {config, "'T3'/'CfgFile'"}.
 
-      {alias, t1, "/home/test/t1"}.
+      {suites, node1, 'T1', all}.
-      {alias, t2, "/home/test/t2"}.
+      {skip_suites, node1, 'T1', [t1B_SUITE,t1D_SUITE], "Not implemented"}.
-      {alias, t3, "/home/test/t3"}.
+      {skip_cases, node1, 'T1', t1A_SUITE, [test3,test4], "Irrelevant"}.
+      {skip_cases, node1, 'T1', t1C_SUITE, [test1], "Ignore"}.
 
-      {suites, node1, t1, all}.
+      {suites, node2, 'T2', [t2B_SUITE,t2C_SUITE]}.
-      {skip_suites, node1, t1, [t1B_SUITE,t1D_SUITE], "Not implemented"}.
+      {cases, node2, 'T2', t2A_SUITE, [test4,test1,test7]}.
-      {skip_cases, node1, t1, t1A_SUITE, [test3,test4], "Irrelevant"}.
-      {skip_cases, node1, t1, t1C_SUITE, [test1], "Ignore"}.
 
-      {suites, node2, t2, [t2B_SUITE,t2C_SUITE]}.
+      {skip_suites, 'T3', all, "Not implemented"}.</pre>
-      {cases, node2, t2, t2A_SUITE, [test4,test1,test7]}.
-
-      {skip_suites, t3, all, "Not implemented"}.
-    </pre>
 
     <p>This example specifies the same tests as the original example. But 
     now if started with a call to <c>ct_master:run(TestSpecName)</c>, the 
@@ -190,10 +193,6 @@
     name as the Common Test node in question (typically <c>ct@somehost</c> if started
     with the <c>ct_run</c> program), will be performed. Tests without explicit
     node association will always be performed too of course!</p>
-
-    <note><p>It is recommended that absolute paths are used for log directories,
-    config files and test directory aliases in the test specifications so that
-    current working directory settings are not important.</p></note>
   </section>
 
   <section>

diff --git a/lib/common_test/doc/src/ct_run.xml b/lib/common_test/doc/src/ct_run.xml
@@ -36,6 +36,8 @@
     OS command line.
   </comsummary>
 
+  <marker id="top"></marker>
+
   <description>
   <p>The <c>ct_run</c> program is automatically installed with Erlang/OTP
     and Common Test (please see the Installation chapter in the Common
@@ -72,6 +74,10 @@
     following <c>-erl_args</c> on the command line. These directories are added
     to the code path normally (i.e. on specified form)</p>
 
+  <p>Exit status is set before the program ends. Value <c>0</c> indicates a successful
+    test result, <c>1</c> indicates one or more failed or auto-skipped test cases, and
+    <c>2</c> indicates test execution failure.</p>
+
   <p>If <c>ct_run</c> is called with option:</p>
     <pre>-help</pre>
     <p>it prints all valid start flags to stdout.</p>
@@ -112,6 +118,7 @@
 	[-basic_html]
     	[-ct_hooks CTHModule1 CTHOpts1 and CTHModule2 CTHOpts2 and ..
 	 CTHModuleN CTHOptsN]
+	[-exit_status ignore_config]
     </pre>
   </section>
   <section>
@@ -145,6 +152,7 @@
 	[-basic_html]
     	[-ct_hooks CTHModule1 CTHOpts1 and CTHModule2 CTHOpts2 and ..
 	 CTHModuleN CTHOptsN]
+	[-exit_status ignore_config]
     </pre>
   </section>
   <section>