From: Eric S. Raymond <esr@thyrsus.com>
Date: Tue, 21 Feb 2012 22:04:57 +0000 (-0500)
Subject: Fix a bug and document some procedures.
X-Git-Tag: 2.2~95
X-Git-Url: https://jxself.org/git/?p=super-star-trek.git;a=commitdiff_plain;h=3940e6e663a29090fb77fe639a8f49d1a3c999d1;hp=22fe003b558eef0e7ed6be42bb9207ab4567f55c

Fix a bug and document some procedures.
---

diff --git a/README b/README
index 2063e42..c7bfecf 100644
--- a/README
+++ b/README
@@ -5,6 +5,10 @@ strip-mine them for dilithium!  Encounter mysterious space thingies!
 This is the classic Super Star Trek game from the days of slow teletypes, 
 reloaded.
 
+The game logs user input to /tmp/sst-input.log. If you trip over a bug,
+please report it to the maintainers with the log enclosed - that enables
+us to reproduce it and rapidly fix the bug.
+
 If you enjoy this, check out other ancient games in the Retrocomputing Museum 
 at <http://www.catb.org/retro/>.
 
diff --git a/doc/HACKING b/doc/HACKING
index 93c0df6..46c3542 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -217,7 +217,12 @@ included in the distribution, 'replay', automatically reruns the
 last game you played.
 
 See the "test" directory for regression-test logs and checkfiles.
+Please run 'make check' every time you change this game to be sure
+you haven't broken anything.  
 
+When you fix a bug, add the log of the game that triggered it (and
+a checkfile) to the regression tests. This is how we improve the code
+coverage of the suite.
 
 NOTES ON THE PYTHON TRANSLATION:
 
diff --git a/sst.py b/sst.py
index 0b99af0..e1c447e 100755
--- a/sst.py
+++ b/sst.py
@@ -6400,6 +6400,7 @@ if __name__ == '__main__':
         if logfp:
             logfp.write("# seed %s\n" % seed)
             logfp.write("# options %s\n" % " ".join(arguments))
+            logfp.write("# SST2K version %s\n" % version)
             logfp.write("# recorded by %s@%s on %s\n" % \
                     (getpass.getuser(),socket.gethostname(),time.ctime()))
         random.seed(seed)
diff --git a/test/README b/test/README
index 57c32e7..59caed7 100644
--- a/test/README
+++ b/test/README
@@ -1,10 +1,10 @@
 This directory contains regression test pairs for SST.
 
-A regression test log is just a command capture from a game with a QUIT
-appended to tell it to exit.  The corresponding check file is just the
-output stimulated by the log.  All files with extension ".log" in this
-directory will be treated as test logs, with each corresponding checkfile
-having extension ".chk".
+A regression test log is just a command capture from a game or partial
+game, with a QUIT appended to tell it to exit a partial game.  The
+corresponding check file is just the output stimulated by the log.
+All files with extension ".log" in this directory will be treated as
+test logs, with each corresponding checkfile having extension ".chk".
 
 "make regress" checks that the output of the logfiles is stable. It
 will show context diffs when the actual output is different from the