[kaffe] CVS kaffe (dalibor): Added documentation on special comments in regression tests

[Kaffe CVS]

PatchSet 4016 
Date: 2003/09/03 14:53:09
Author: dalibor
Branch: HEAD
Tag: (none) 
Log:
Added documentation on special comments in regression tests

Taken from an e-mail by Edouard archived here: http://www.kaffe.org/pipermail/kaffe/2001-September/038974.html

Members: 
	ChangeLog:1.1612->1.1613 
	FAQ/FAQ.debugging:1.3->1.4 

Index: kaffe/ChangeLog
diff -u kaffe/ChangeLog:1.1612 kaffe/ChangeLog:1.1613
--- kaffe/ChangeLog:1.1612	Wed Sep  3 13:34:59 2003
+++ kaffe/ChangeLog	Wed Sep  3 14:53:09 2003
@@ -1,3 +1,9 @@
+2003-09-03  Dalibor Topic <robilad at kaffe.org>,
+	    Edouard G. Parmelan <egp at free.fr>
+
+	* FAQ/FAQ.debugging: Added Edouard's explanation of special
+	comments in regression tests.
+	
 2003-09-03  Dalibor Topic <robilad at kaffe.org>
 
 	* libraries/javalib/java/awt/BasicStroke.java:
Index: kaffe/FAQ/FAQ.debugging
diff -u kaffe/FAQ/FAQ.debugging:1.3 kaffe/FAQ/FAQ.debugging:1.4
--- kaffe/FAQ/FAQ.debugging:1.3	Fri Apr 25 21:35:33 2003
+++ kaffe/FAQ/FAQ.debugging	Wed Sep  3 14:53:11 2003
@@ -79,7 +79,7 @@
 the "correct" output is included in the comment, and the test script
 simply compares the output generated.  
 
-To add a new test, just add it to the list of tests in aMakefile.am,
+To add a new test, just add it to the list of tests in Makefile.am,
 regenerate the Makefile.in, re-configure, and run 'make check'.  (Ugh,
 the need to re-generate Makefile.in is awkward and lame.)
 
@@ -95,6 +95,35 @@
 	$ vi test/regression/OneOffHackTest.java
 	$ make check TESTS="OneOffHackTest.java"
 
+
+Special Comments in Regression Tests
+====================================
+
+Regression tests have special comments that tell the test driver
+script what to do with them. The special comments and their
+effects are:
+
+// Sources: SOURCES
+compile also these sources with current test case.
+
+// javac flags: FLAGS
+add some javac flags.  For exemple -nowarn remove warning lines
+and therefore don't let's think that javac fail.
+
+// Skip Run
+Compile only
+
+// java args: CLASSNAME [OPTIONS]
+Replace current classname by this classname and options.
+
+All lines enclose inside line
+/* Expected Output:
+and
+*/
+are compared to test-case's output.
+
+// Sort Output
+Sort output before compare it to Expected Output.
 
 Other Stuff
 ===========