Small improvements to pit documentation.

diff --git a/pit/CATALOG b/pit/CATALOG
index 8bde69a7159bfb62d23b650f54682a432bcbb16f..2e8a95effbf6e663b1847bdc37da9ded0a637e1e 100644 (file)
--- a/pit/CATALOG
+++ b/pit/CATALOG
@@ -12,6 +12,9 @@ programs; the programs in explib are expansion libraries written in C,
 which serve as examples of the C-INTERCAL to C interface as well as
 potentially being useful.
 
+Programs marked with + have associated .chk files and are part of the
+regression-test suite.
+
 Contents:
 
 from original manual:
@@ -20,7 +23,7 @@ from original manual:
   lib/syslib-orig.i    Standard library (original buggy version)
 
 by Jon Blow <jon@sampo.com>
-  tests/sink.i  Simple test program
+  tests/sink.i  + Simple test program, should sink into the Black Lagoon
   random.i      Random number program
   lib/plus.i    Increment .1
 
@@ -38,10 +41,10 @@ by Louis Howell <nazgul@netcom.com>
     glider
     gun         Input files for both Life programs
   bubble.i      Bubble sort
-  icat.i        Sends input to output
+  icat.i        + Sends input to output
   lib/lib2.i   New library routines: decrement, decrement and branch on 0,
                 add bit, 16-bit division with remainder, exponentiation
-  pi.i         Calculate pi
+  pi.i         + Calculate pi to a specified number of digits
   primes.i     Find prime numbers
   pow.i                Prints a list of nth powers using old exponentiation routine
   lib/syslib.i Corrected version of system library
@@ -52,21 +55,21 @@ by Louis Howell <nazgul@netcom.com>
   change.doc    Description of change.i
 
 by Matt Dimeo <mdimeo@brooktree.com>
-  beer.i        Print out the lyrics to "99 Bottles of Beer On The Wall"
+  beer.i        + Print out the lyrics to "99 Bottles of Beer On The Wall"
 
 by Stinglai Ka'abi <stinglai@bureau.World.GOV>:
   random2.i    Another random-number generator
 
 by Jacob Mandelson <jlm@cco.caltech.edu>
-  rot13.i      Prints ROT-13 of its input
+  rot13.i      + Prints ROT-13 of its input
 
 by Jan-Pieter Cornet <johnpc@xs4all.nl>
-  hail_mary.3i         Print 1,000,000 Hail Marys
-  tests/count.3i        Count from 1 to 10 in TriINTERCAL
+  hail_mary.3i         + Print 1,000,000 Hail Marys
+  tests/count.3i        + Count from 1 to 10 in TriINTERCAL
   tests/iogerunds.i    Demonstrate gerund abstention
 
 by Clemens Meier <clmeier@lili.uni-bielefeld.de>
-  rot13b.i      Another ROT-13 program
+  rot13b.i      + Another ROT-13 program
 
 By Brian Raiter <breadbox@muppetlabs.com>
   lib/numio.i      I/O routines
@@ -77,12 +80,12 @@ By Brian Raiter <breadbox@muppetlabs.com>
   lib/syslib.6i     Translations of the standard library to
   lib/syslib.7i     C-INTERCAL's other bases.
   lib/syslib3-7.doc Documentation for same
-  hello.i           The traditional hello world program
+  tests/hello.i     + The traditional hello world program
   ins.i             Intersections & Splats, a Mastermind-style game
   ins.doc           Documentation for I&S
   yapp.i            Prints an INTERCAL program that prints
   yapp.doc          Description of yapp.i
-  quine.i           Prints itself
+  quine.i           + Prints itself
   lib/floatlib.i    Floating-point routines
   lib/floatlib.doc  Documentation for the floating-point routines
   flonck.i          An RPN calculator
@@ -93,33 +96,25 @@ By Brian Raiter <breadbox@muppetlabs.com>
     tophat.fft      Sample input for FFT
 
 by Donald Knuth
-  tpk.i         Don Knuth's implementation of the TPK algorithm
-  tpk.doc       Don's note about the algorithm
+  tpk.i             Don Knuth's implementation of the TPK algorithm
+  tpk.doc           Don's note about the algorithm
 
 by Oerjan Johansen
-  unlambda.i    An Unlambda interpreter in INTERCAL
-  unlambda.doc  Better-commented version of the above
+  unlambda.i        An Unlambda interpreter in INTERCAL
+  unlambda.doc      Better-commented version of the above
 
 by Jeffrey Lee
-  interfunge.i  A Befunge-93 interpreter in INTERCAL
+  interfunge.i      A Befunge-93 interpreter in INTERCAL
 
 by Brendan Gregg
-  guess.i      Guessing game implementation in INTERCAL
+  guess.i          Guessing game implementation in INTERCAL
 
 The subdirectory tests contains some programs written only to test the
 compiler.
 
 by David Moews
-  tests/test1.i        Prints DO THIS TEST HAS BEEN SUCCESSFULLY COMPLETED
-  tests/test2.i        Reads in two numbers and multiplies their product
-
-David Moews wrote of the latter (test2.i):
-
-The following program reads in two numbers and then prints their product.
-It consists of a trivial calling program followed by a cleaned-up version
-of a portion of the INTERCAL subroutine library.  (Only a portion of
-the INTERCAL subroutine library is present in the posted manual, and
-that portion is full of typos.)
+  tests/test1.i            Prints DO THIS TEST HAS BEEN SUCCESSFULLY COMPLETED
+  tests/test2.i            Reads in two numbers and multiplies their product
 
 by Alex Smith
   tests/ais1.i       A very simple test program
@@ -128,7 +123,7 @@ by Alex Smith
   tests/onceagain.i   A single-threaded program testing ONCE and AGAIN
   tests/arrtest.i     A program to test some changes I made to the grammar
   tests/arrtest.doc   The history behind those changes
-  tests/permute.i     A permutation-printing program to test backtracking
+  tests/permute.i     + A permutation-printing program to test backtracking
   tests/permute.doc   Information about the permutation-printer
   tests/whileadd.i    Adds two input numbers with a single WHILE statement
   tests/ignorret.i    Testing interactions of IGNORE and RETRIEVE

diff --git a/pit/Makefile b/pit/Makefile
index d9f087b2ac597cc37adc3fe8744d372254856756..322304043a85e0f948a112e11b9df3537d11319c 100644 (file)
--- a/pit/Makefile
+++ b/pit/Makefile
@@ -1,6 +1,7 @@
 #
 # Torture-tester for the INTERCAL compiler
 #
+# Type 'make' to test-compile the pit programs and run a regression check
 
 ICK = ../ick -b
 
@@ -26,6 +27,7 @@ BASE2SOURCES = \
        ./life2.i \
        ./pi.i \
        ./pow.i \
+       ./quine \
        ./primes.i \
        ./random.i \
        ./random2.i \

diff --git a/pit/tests/test2.doc b/pit/tests/test2.doc
new file mode 100644 (file)
index 0000000..ff29c96
--- /dev/null
+++ b/pit/tests/test2.doc
@@ -0,0 +1,8 @@
+David Moews wrote this about test2.i:
+
+The following program reads in two numbers and then prints their product.
+It consists of a trivial calling program followed by a cleaned-up version
+of a portion of the INTERCAL subroutine library.  (Only a portion of
+the INTERCAL subroutine library is present in the posted manual, and
+that portion is full of typos.)
+