New unit

new help file

Copied from Perforce
 Change: 19024
 ServerID: perforce.ravenbrook.com

mps/qa/test/script/help/clib

@@ -0,0 +1,11 @@
+compile test libraries
+
+Usage: qa clib [-i MMQA_MPS_INCLUDE_DIR] [-v MMQA_INTERFACE_VERSION]
+
+'clib' recompiles the test libraries (as listed in testlib:manifest)
+You must run clib before running tests with 'try' or 'run', and you
+are advised to run it when switching from one memory manager to
+another.
+
+Compiled libraries are placed in the obj:<platform>: directory.
+

mps/qa/test/script/help/index

@@ -0,0 +1,9 @@
+list tests in a directory
+
+Usage: qa index [<directory>]
+
+'index' lists the tests in the directory specified, or the
+current directory if none is. For each test, the filename
+and test summary are displayed.
+
+

mps/qa/test/script/help/options

@@ -0,0 +1,28 @@
+display options and their current values
+
+Usage: qa options [<options>]
+
+'options' prints out a table of all options and flags used
+by the qa harness. Each may be specified by setting an
+environment variable (to "on" or "off" in the case of a flag)
+or as a command line option. The current values (i.e. resulting
+from defaults, environment variables and any options given
+to the 'options' command) are also shown.
+
+What the options mean:
+
+MMQA_MPS_INCLUDE_DIR
+ a directory where the MM header files may be found.
+
+MMQA_MPS_LINK_OBJ
+ the MM libraries (and any other necessary files, eg the
+ plinth) that must be linked.
+
+MMQA_INTERFACE_VERSION
+ the version of the MM interface to use. Default is
+ GR (grotesque), which should be correct for honeybee.3 and later.
+ Older interfaces were known as MO (modern) and OS (oldstyle).
+
+MMQA_LOG_DIR
+ the directory in which log files should be saved.
+

mps/qa/test/script/help/run

@@ -0,0 +1,11 @@
+run tests, reporting results and verdict
+
+Usage: qa try [<options>] <testfile> [<testfile> ...]
+
+'run' runs tests individually. The test libraries must previously
+have been compiled with 'clib'.
+
+'try' shows the test's output as it runs, then when it finishes,
+displays test information, results, and the verdict: PASS or FAIL.
+If you don't want these details, use 'try' instead of 'run'.
+

mps/qa/test/script/help/runset

@@ -0,0 +1,21 @@
+run tests from a test-set
+
+Usage: qa runset [<options>] <testsetfile>
+
+'runset' compiles the test libraries and then runs all the
+tests in a test-set.
+
+A test-set is a file containing a list of tests, one test
+per line. Blank lines or those beginning with % are ignored.
+Tests can be specified as absolute files, or relative to the
+current directory.
+
+'runset' runs all the tests, and saves three log files in the
+logs directory (see 'qa help options'):
+
+ summ.log -- summary log: one line per test, PASS or FAIL
+ res.log  -- results log: test specifications, results and verdict
+ full.log -- full log: specifications, results, verdict and transcript
+
+To run tests individually, use the 'try' or 'run' commands.
+