Fix a bug and document some procedures.

[super-star-trek.git] / doc / HACKING

diff --git a/doc/HACKING b/doc/HACKING
index b68603120c56e0c9f8c0d469e035dc16855956d9..46c35425f41eb06a3da5be3898fabcfc5c07e8b3 100644 (file)
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -1,7 +1,7 @@
 This is the hackers' guide to SST2K.  Read it before messing with the code.
 
 It consists of an introduction, a history, suggestions for regression testing,
 This is the hackers' guide to SST2K.  Read it before messing with the code.
 
 It consists of an introduction, a history, suggestions for regression testing,

-some notes on the Python translation.  For a to-do list, see TODO in the
+and some notes on the Python translation.  For a to-do list, see TODO in the

 top-level directory.
 
 INTRODUCTION:
 top-level directory.
 
 INTRODUCTION:


@@ -191,7 +191,7 @@ probability of being damaged."
 This is one place where OPTION_PLAIN does not restore the original
 behavior, which was equiprobable damage across all devices.  If we
 wanted that, we'd return randrange(NDEVICES) and have done with it.
 This is one place where OPTION_PLAIN does not restore the original
 behavior, which was equiprobable damage across all devices.  If we
 wanted that, we'd return randrange(NDEVICES) and have done with it.

-Also, in the original game, DNAVYS and DCOMPTR were the same device.
+Also, in the original game, DNAVSYS and DCOMPTR were the same device.

 
 Instead, we use a table of weights similar to the one from BSD Trek.
 BSD doesn't have the shuttle, shield controller, death ray, or probes.
 
 Instead, we use a table of weights similar to the one from BSD Trek.
 BSD doesn't have the shuttle, shield controller, death ray, or probes.


@@ -216,21 +216,13 @@ This code has been designed to be tested.  A simple shellscript
 included in the distribution, 'replay', automatically reruns the
 last game you played.
 
 included in the distribution, 'replay', automatically reruns the
 last game you played.
 

-Here are some interesting seeds for debugging and regression testing
-For each one, I list the seed, the options, and the last svn revision
-for which it is known to have given the described behavior.
+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.  

 
 

-1160647745 regular short good fancy    (r769)
-
-Starts you in a quadrant with the Super-Commander in it.  Slamming three
-torps at him will kill him.  You can use this to regression-test both
-torpedo tracks and the Deep Space Probe. Known bug: "probe aut 2 8"
-triggers manual navigation.
-
-1160707235 regular short good fancy    (r769)
-
-Do sr/mov aut 5 4/sr/sensors/orbit/transport; you'll get a transporter
-failure.
+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:
 
 
 NOTES ON THE PYTHON TRANSLATION: