Common Test: Editorial changes 3

Reference Manual files from Pär Wennstad added

1 files changed, 155 insertions, 144 deletions

diff --git a/lib/common_test/doc/src/ct_run.xml b/lib/common_test/doc/src/ct_run.xml
index 5518bb039b..a1ad060366 100644
--- a/lib/common_test/doc/src/ct_run.xml
+++ b/lib/common_test/doc/src/ct_run.xml
@@ -33,179 +33,190 @@
     <file>ct_run.xml</file>
   </header>
   <com>ct_run</com>
-  <comsummary>Program used for starting Common Test from the
-    OS command line.
-  </comsummary>
+  <comsummary>Program used for starting <c>Common Test</c> from the
+    OS command line.</comsummary>
 
   <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
-    Test User's Guide for more information). The program accepts a number
-    of different start flags. Some flags trigger <c>ct_run</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>There is an interface function that corresponds to this program,
-    called <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso>, for starting Common Test from the Erlang
-    shell (or an Erlang program). Please see the <c>ct</c> man page for
-    details.</p>
+    and the <c>Common Test</c> application (for more information, see
+    section <seealso marker="install_chapter">Installation</seealso>
+    in the User's Guide). The program accepts different start flags.
+    Some flags trigger <c>ct_run</c> to start <c>Common Test</c> and
+    pass on data to it. Some flags start an Erlang node prepared for
+    running <c>Common Test</c> in a particular mode.</p>
+
+  <p>The interface function
+    <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso>,
+    corresponding to the <c>ct_run</c> program, is used for starting
+    <c>Common Test</c> from the Erlang shell (or an Erlang program).
+    For details, see the <seealso marker="ct"><c>ct</c></seealso>
+    manual page.</p>
 
   <p><c>ct_run</c> also accepts Erlang emulator flags. These are used
-    when <c>ct_run</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>With the optional flag:</p>
-  <pre>-erl_args</pre>
-  <p>it's possible to divide the options on the <c>ct_run</c> command line into
-    two groups, one that Common Test should process (those preceding <c>-erl_args</c>),
-    and one it should completely ignore and pass on directly to the emulator
-    (those following <c>-erl_args</c>). Options preceding <c>-erl_args</c> that Common Test
-    doesn't recognize, also get passed on to the emulator untouched.
-    By means of <c>-erl_args</c> the user may specify flags with the same name, but
+    when <c>ct_run</c> calls <c>erl</c> to start the Erlang node (this
+    makes it possible to add directories to the code server path,
+    change the cookie on the node, start more applications, and so on).</p>
+
+  <p>With the optional flag <c>-erl_args</c>, options on the <c>ct_run</c>
+    command line can be divided into two groups:</p>
+
+  <list type="bulleted">
+    <item>One group that <c>Common Test</c> is to process (those
+      preceding <c>-erl_args</c>).</item>
+    <item>One group that <c>Common Test</c> is to ignore and pass on
+      directly to the emulator (those following <c>-erl_args</c>).</item>
+  </list>
+
+  <p>Options preceding <c>-erl_args</c> that <c>Common Test</c>
+    does not recognize are also passed on to the emulator untouched.
+    By <c>-erl_args</c> the user can specify flags with the same name, but
     with different destinations, on the <c>ct_run</c> command line.</p>
-  <p>If <c>-pa</c> or <c>-pz</c> flags are specified in the Common Test group of options
-    (preceding <c>-erl_args</c>), relative directories will be converted to
-    absolute and re-inserted into the code path by Common Test (to avoid
-    problems loading user modules when Common Test changes working directory
-    during test runs). Common Test will however ignore <c>-pa</c> and <c>-pz</c> flags
-    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>
-  </description>
 
+  <p>If flags <c>-pa</c> or <c>-pz</c> are specified in the
+    <c>Common Test</c> group of options (preceding <c>-erl_args</c>),
+    relative directories are converted to absolute and reinserted into
+    the code path by <c>Common Test</c>. This is to avoid problems
+    loading user modules when <c>Common Test</c> changes working directory
+    during test runs. However, <c>Common Test</c> ignores flags <c>-pa</c>
+    and <c>-pz</c> following <c>-erl_args</c> on the command line. These
+    directories are added to the code path normally (that is, 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 <c>-help</c>, it prints all
+    valid start flags to <c>stdout</c>.</p>
+  </description>
 
   <section>
   <marker id="ct_run"></marker>
-    <title>Run tests from command line</title>
+    <title>Run Tests from Command Line</title>
     <pre>
-	ct_run -dir TestDir1 TestDir2 .. TestDirN |
-	  [-dir TestDir] -suite Suite1 Suite2 .. SuiteN
-	   [-group Groups1 Groups2 .. GroupsN] [-case Case1 Case2 .. CaseN]
-	 [-step [config | keep_inactive]]
-	 [-config ConfigFile1 ConfigFile2 .. ConfigFileN]
-	 [-userconfig CallbackModule1 ConfigString1 and CallbackModule2
-	  ConfigString2 and .. CallbackModuleN ConfigStringN]
-	 [-decrypt_key Key] | [-decrypt_file KeyFile]
-	 [-label Label]
-	 [-logdir LogDir]
-	 [-logopts LogOpts]
-	 [-verbosity GenVLevel | [Category1 VLevel1 and
-	  Category2 VLevel2 and .. CategoryN VLevelN]]
-	 [-silent_connections [ConnType1 ConnType2 .. ConnTypeN]]
-	 [-stylesheet CSSFile]
-	 [-cover CoverCfgFile]
-	 [-cover_stop Bool]
-	 [-event_handler EvHandler1 EvHandler2 .. EvHandlerN] |
-         [-event_handler_init EvHandler1 InitArg1 and
-	  EvHandler2 InitArg2 and .. EvHandlerN InitArgN]
-	 [-include InclDir1 InclDir2 .. InclDirN]
-	 [-no_auto_compile]
-	 [-abort_if_missing_suites]
-	 [-muliply_timetraps Multiplier]
-	 [-scale_timetraps]
-	 [-create_priv_dir auto_per_run | auto_per_tc | manual_per_tc]
-         [-repeat N] |
-         [-duration HHMMSS [-force_stop [skip_rest]]] |
-         [-until [YYMoMoDD]HHMMSS [-force_stop [skip_rest]]]
-	 [-basic_html]
-    	 [-ct_hooks CTHModule1 CTHOpts1 and CTHModule2 CTHOpts2 and ..
-	  CTHModuleN CTHOptsN]
-	 [-exit_status ignore_config]
-	 [-help]
-    </pre>
+ ct_run -dir TestDir1 TestDir2 .. TestDirN |
+  [-dir TestDir] -suite Suite1 Suite2 .. SuiteN
+  [-group Groups1 Groups2 .. GroupsN] [-case Case1 Case2 .. CaseN]
+  [-step [config | keep_inactive]]
+  [-config ConfigFile1 ConfigFile2 .. ConfigFileN]
+  [-userconfig CallbackModule1 ConfigString1 and CallbackModule2
+   ConfigString2 and .. CallbackModuleN ConfigStringN]
+  [-decrypt_key Key] | [-decrypt_file KeyFile]
+  [-label Label]
+  [-logdir LogDir]
+  [-logopts LogOpts]
+  [-verbosity GenVLevel | [Category1 VLevel1 and
+   Category2 VLevel2 and .. CategoryN VLevelN]]
+  [-silent_connections [ConnType1 ConnType2 .. ConnTypeN]]
+  [-stylesheet CSSFile]
+  [-cover CoverCfgFile]
+  [-cover_stop Bool]
+  [-event_handler EvHandler1 EvHandler2 .. EvHandlerN] |
+  [-event_handler_init EvHandler1 InitArg1 and
+   EvHandler2 InitArg2 and .. EvHandlerN InitArgN]
+  [-include InclDir1 InclDir2 .. InclDirN]
+  [-no_auto_compile]
+  [-abort_if_missing_suites]
+  [-muliply_timetraps Multiplier]
+  [-scale_timetraps]
+  [-create_priv_dir auto_per_run | auto_per_tc | manual_per_tc]
+  [-repeat N] |
+  [-duration HHMMSS [-force_stop [skip_rest]]] |
+  [-until [YYMoMoDD]HHMMSS [-force_stop [skip_rest]]]
+  [-basic_html]
+  [-ct_hooks CTHModule1 CTHOpts1 and CTHModule2 CTHOpts2 and ..
+   CTHModuleN CTHOptsN]
+  [-exit_status ignore_config]
+  [-help]</pre>
   </section>
+
   <section>
-    <title>Run tests using test specification</title>
+    <title>Run Tests using Test Specification</title>
     <pre>
-	ct_run -spec TestSpec1 TestSpec2 .. TestSpecN
-	 [-join_specs]
-	 [-config ConfigFile1 ConfigFile2 .. ConfigFileN]
-	 [-userconfig CallbackModule1 ConfigString1 and CallbackModule2
-          ConfigString2 and .. and CallbackModuleN ConfigStringN]
-	 [-decrypt_key Key] | [-decrypt_file KeyFile]
-	 [-label Label]
-	 [-logdir LogDir]
-	 [-logopts LogOpts]
-	 [-verbosity GenVLevel | [Category1 VLevel1 and
-	  Category2 VLevel2 and .. CategoryN VLevelN]]
-	 [-allow_user_terms]
-	 [-silent_connections [ConnType1 ConnType2 .. ConnTypeN]]
-	 [-stylesheet CSSFile]
-	 [-cover CoverCfgFile]
-	 [-cover_stop Bool]
-	 [-event_handler EvHandler1 EvHandler2 .. EvHandlerN] |
-         [-event_handler_init EvHandler1 InitArg1 and
-	  EvHandler2 InitArg2 and .. EvHandlerN InitArgN]
-	 [-include InclDir1 InclDir2 .. InclDirN]
-	 [-no_auto_compile]
-	 [-abort_if_missing_suites]
-	 [-muliply_timetraps Multiplier]
-	 [-scale_timetraps]
-	 [-create_priv_dir auto_per_run | auto_per_tc | manual_per_tc]
-         [-repeat N] |
-         [-duration HHMMSS [-force_stop [skip_rest]]] |
-         [-until [YYMoMoDD]HHMMSS [-force_stop [skip_rest]]]
-	 [-basic_html]
-    	 [-ct_hooks CTHModule1 CTHOpts1 and CTHModule2 CTHOpts2 and ..
-	  CTHModuleN CTHOptsN]
-	 [-exit_status ignore_config]
-    </pre>
+ ct_run -spec TestSpec1 TestSpec2 .. TestSpecN
+  [-join_specs]
+  [-config ConfigFile1 ConfigFile2 .. ConfigFileN]
+  [-userconfig CallbackModule1 ConfigString1 and CallbackModule2
+   ConfigString2 and .. and CallbackModuleN ConfigStringN]
+  [-decrypt_key Key] | [-decrypt_file KeyFile]
+  [-label Label]
+  [-logdir LogDir]
+  [-logopts LogOpts]
+  [-verbosity GenVLevel | [Category1 VLevel1 and
+   Category2 VLevel2 and .. CategoryN VLevelN]]
+  [-allow_user_terms]
+  [-silent_connections [ConnType1 ConnType2 .. ConnTypeN]]
+  [-stylesheet CSSFile]
+  [-cover CoverCfgFile]
+  [-cover_stop Bool]
+  [-event_handler EvHandler1 EvHandler2 .. EvHandlerN] |
+  [-event_handler_init EvHandler1 InitArg1 and
+   EvHandler2 InitArg2 and .. EvHandlerN InitArgN]
+  [-include InclDir1 InclDir2 .. InclDirN]
+  [-no_auto_compile]
+  [-abort_if_missing_suites]
+  [-muliply_timetraps Multiplier]
+  [-scale_timetraps]
+  [-create_priv_dir auto_per_run | auto_per_tc | manual_per_tc]
+  [-repeat N] |
+  [-duration HHMMSS [-force_stop [skip_rest]]] |
+  [-until [YYMoMoDD]HHMMSS [-force_stop [skip_rest]]]
+  [-basic_html]
+  [-ct_hooks CTHModule1 CTHOpts1 and CTHModule2 CTHOpts2 and ..
+   CTHModuleN CTHOptsN]
+  [-exit_status ignore_config]</pre>
   </section>
+
   <section>
-    <title>Run tests in web based GUI</title>
+    <title>Run Tests in Web-Based GUI</title>
     <pre>
-        ct_run -vts [-browser Browser]
-         [-dir TestDir1 TestDir2 .. TestDirN] |
-         [[dir TestDir] -suite Suite [[-group Group] [-case Case]]]
-	 [-config ConfigFile1 ConfigFile2 .. ConfigFileN]
-	 [-userconfig CallbackModule1 ConfigString1 and CallbackModule2
-          ConfigString2 and .. and CallbackModuleN ConfigStringN]
-	 [-logopts LogOpts]
-	 [-verbosity GenVLevel | [Category1 VLevel1 and
-	  Category2 VLevel2 and .. CategoryN VLevelN]]
-	 [-decrypt_key Key] | [-decrypt_file KeyFile]
-	 [-include InclDir1 InclDir2 .. InclDirN]
-	 [-no_auto_compile]
-	 [-abort_if_missing_suites]
-	 [-muliply_timetraps Multiplier]
-	 [-scale_timetraps]
-	 [-create_priv_dir auto_per_run | auto_per_tc | manual_per_tc]
-	 [-basic_html]</pre>
+ ct_run -vts [-browser Browser]
+  [-dir TestDir1 TestDir2 .. TestDirN] |
+  [[dir TestDir] -suite Suite [[-group Group] [-case Case]]]
+  [-config ConfigFile1 ConfigFile2 .. ConfigFileN]
+  [-userconfig CallbackModule1 ConfigString1 and CallbackModule2
+    ConfigString2 and .. and CallbackModuleN ConfigStringN]
+  [-logopts LogOpts]
+  [-verbosity GenVLevel | [Category1 VLevel1 and
+   Category2 VLevel2 and .. CategoryN VLevelN]]
+  [-decrypt_key Key] | [-decrypt_file KeyFile]
+  [-include InclDir1 InclDir2 .. InclDirN]
+  [-no_auto_compile]
+  [-abort_if_missing_suites]
+  [-muliply_timetraps Multiplier]
+  [-scale_timetraps]
+  [-create_priv_dir auto_per_run | auto_per_tc | manual_per_tc]
+  [-basic_html]</pre>
   </section>
+
   <section>
-    <title>Refresh the HTML index files</title>
+    <title>Refresh HTML Index Files</title>
     <pre>
-	ct_run -refresh_logs [-logdir LogDir] [-basic_html]</pre>
+ ct_run -refresh_logs [-logdir LogDir] [-basic_html]</pre>
   </section>
+
   <section>
-    <title>Run CT in interactive mode</title>
+    <title>Run Common Test in Interactive Mode</title>
     <pre>
-	ct_run -shell
-	 [-config ConfigFile1 ConfigFile2 ... ConfigFileN]
-	 [-userconfig CallbackModule1 ConfigString1 and CallbackModule2
-          ConfigString2 and .. and CallbackModuleN ConfigStringN]
-	 [-decrypt_key Key] | [-decrypt_file KeyFile]</pre>
+ ct_run -shell
+  [-config ConfigFile1 ConfigFile2 ... ConfigFileN]
+  [-userconfig CallbackModule1 ConfigString1 and CallbackModule2
+   ConfigString2 and .. and CallbackModuleN ConfigStringN]
+  [-decrypt_key Key] | [-decrypt_file KeyFile]</pre>
   </section>
+
   <section>
-    <title>Start a Common Test Master node</title>
+    <title>Start a Common Test Master Node</title>
     <pre>
-	ct_run -ctmaster</pre>
+ ct_run -ctmaster</pre>
   </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>For information about the start flags, see section
+      <seealso marker="run_test_chapter">Running Tests and Analyzing
+      Results</seealso> in the User's Guide.</p>
   </section>
 
 </comref>
+