update test-runner documentation
authorCraig Dowell <craigdo@ee.washington.edu>
Fri, 16 Apr 2010 15:18:04 -0700
changeset 6229 39392330340e
parent 6228 4a2c9eaedb7f
child 6230 7e8a5b802007
update test-runner documentation
doc/testing/testing-framework.texi
--- a/doc/testing/testing-framework.texi	Fri Apr 16 15:13:29 2010 -0700
+++ b/doc/testing/testing-framework.texi	Fri Apr 16 15:18:04 2010 -0700
@@ -489,6 +489,7 @@
   'build' finished successfully (0.353s)
   --assert:               Tell tests to segfault (like assert) if an error is detected
   --basedir=dir:          Set the base directory (where to find src) to ``dir''
+  --tempdir=dir:          Set the temporary directory (where to find data files) to ``dir''
   --constrain=test-type:  Constrain checks to test suites of type ``test-type''
   --help:                 Print this message
   --kinds:                List all of the available kinds of tests
@@ -560,14 +561,15 @@
 a @code{--tempdir}, so the test runner will figure one out for you if you don't
 provide one.  It first looks for environment variables named @code{TMP} and 
 @code{TEMP} and uses those.  If neither @code{TMP} nor @code{TEMP} are defined
-it picks @code{/tmp}.  The code then tacks on the time (hh.mm.ss} followed by
-a large randome number and creates a directory of that name to be used as the
+it picks @code{/tmp}.  The code then tacks on an identifier indicating what 
+created the directory (ns-3) then the time (hh.mm.ss} followed by a large random
+number.  The test runner creates a directory of that name to be used as the
 temporary directory.  Temporary files then go into a directory that will be
 named something like,
 
 @smallformat
 @verbatim
-  /tmp/10.25.37.61537845
+  /tmp/ns-3.10.25.37.61537845
 @end verbatim
 @end smallformat