Document test comment format.
authorEric S. Raymond <esr@thyrsus.com>
Fri, 26 May 2017 04:40:35 +0000 (00:40 -0400)
committerEric S. Raymond <esr@thyrsus.com>
Fri, 26 May 2017 04:40:35 +0000 (00:40 -0400)
tests/README

index 94fbe2d0c50581a869c049a16c649ab7dae09801..a6451dc4bff9680ae060a2c7799a47c2744fc28e 100644 (file)
@@ -6,7 +6,9 @@ A .chk extension means it's expected output from a test
 In general, a file named foo.chk is the expected output from theb game log
 foo.log.  To add new tests, just drop log files in this directory.
 
-To see summary lines from all tests, 'make testlist'.  
+To see summary lines from all tests, 'make testlist'.  The summary lines
+are those led with ##; you should have one such descriptive line at the
+head of the file.
 
 To run the tests, "make regress".