[Maxima-commits] CVS: maxima/doc/info Bugs.texi,1.12,1.13

[Raymond T. <rt...@us...>]

Update of /cvsroot/maxima/maxima/doc/info
In directory 23jxhf1.ch3.sourceforge.com:/tmp/cvs-serv16378/doc/info

Modified Files:
	Bugs.texi 
Log Message:
Change run_testsuite to use keyword arguments instead of optional
positional arguments.  Also allow symbols for the test names.

src/mload.lisp:
o INTERSECT-FILES: Allow symbols as well as strings for the test
  names. 
o Moved core of $run_testsuite to run-testsuite so we can use keyword
  arguments.
o $run_testsuite uses keyword arguments and parses them and passes
  them to run-testsuite.
o Moved lispify-maxima-keyword-options from quadpack.lisp to here so
  we have it early in the build.

src/numerical/slatec/quadpack.lisp:
o Moved lispify-maxima-keyword-options to src/mload.lisp.

doc/info/Bugs.texi:
o Document the new run_testsuite keyword options.


Index: Bugs.texi
===================================================================
RCS file: /cvsroot/maxima/maxima/doc/info/Bugs.texi,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -r1.12 -r1.13
--- Bugs.texi	28 Nov 2007 03:36:39 -0000	1.12
+++ Bugs.texi	21 Jan 2009 16:19:33 -0000	1.13
@@ -5,24 +5,31 @@
 
 @node Functions and Variables for Bug Detection and Reporting
 @section Functions and Variables for Bug Detection and Reporting
-@deffn {Function} run_testsuite ()
-@deffnx {Function} run_testsuite (@var{boolean})
-@deffnx {Function} run_testsuite (@var{boolean}, @var{boolean})
-@deffnx {Function} run_testsuite (@var{boolean}, @var{boolean}, @var{list})
+@deffn {Function} run_testsuite ([@var{options}])
 Run the Maxima test suite. Tests producing the desired answer are
 considered ``passes,'' as are tests that do not produce the desired
 answer, but are marked as known bugs.
 
-@code{run_testsuite ()} displays only tests that do not pass.
+@code{run_testsuite} takes the following optional keyword arguments
 
-@code{run_testsuite (true)} displays tests that are marked as known bugs, as
-well as failures.
+@table @var
+@item display_all
+Display all tests.  Normally, the tests are not displayed, unless the test fails.
+(Defaults to @code{false}).
+@item display_known_bugs
+Displays tests that are marked as known bugs.  (Default is @code{false}).
+@item tests
+This is a list of tests that should be run.  Each test can be
+specified by either a string or a symbol.  By default, all tests are
+run.  The complete set of tests is specified by @code{testsuite_files}.
+@end table
 
-@code{run_testsuite (true, true)} displays all tests.
+For example @code{run_testsuite(display_known_bugs = t, tests=[rtest5])}
+runs just test @code{rtest5} and displays the test that are marked as
+known bugs.
 
-If the optional third argument is given, a subset of the tests is run.
-The subset of the tests to run is given as a list of the names of the
-tests.  The complete set of tests is specified by @code{testsuite_files}.
+@code{run_testsuite(display_all = t, tests=["rtest1", rtest1a])} will
+run tests @code{rtest1} and @code{rtest2}, and displays each test.
 
 @code{run_testsuite} changes the Maxima environment.
 Typically a test script executes @code{kill} to establish a known environment