Document a bugfix and isolate it in a test.
[open-adventure.git] / notes.adoc
index a3304ba63c54d63719bc1308380793110c5e2135..f5116bce0cbba8a3e70154c393cc074b02e78e64 100644 (file)
@@ -45,16 +45,18 @@ future as a Python or Go translation seems possible, even probable.
 
 Bug fixes:
 
-* The caged bird to be counted as two items in your inventory.
+* The caged bird used to be counted as two items in your inventory.
 
 * Reading the relocated Witt's End sign in the endgame didn't work right.
 
 * Oyster was readable after first gotten even when not carried.
 
+* Response to an attempt to unlock the oyster while carrying it was incorrect. 
+
 * Behavior when saying the giant's magic words outside his room wasn't
   quite correct - the game responded as though the player were in
-  the room ("...can't you read?"). The new message is "Well, that was
-  remarkably pointless."
+  the room ("...can't you read?"). The new message is "Nothing happens."
+  The -o option reverts this change.
  
 * Attempting to extinguish an unlit urn caused it to lose its oil.
 
@@ -63,14 +65,11 @@ Bug fixes:
   bridge spans the fissure." (timeless present).
 
 * A few minor typos have been corrected: absence of capitalization on
-  "Swiss" and "Persian", inconsistent selling of "imbedded" vs. "embedded",
-  "eying" for "eyeing". "thresholds" for "threshholds".
+  "Swiss" and "Persian", inconsistent spelling of "imbedded" vs. "embedded",
+  "eying" for "eyeing", "thresholds" for "threshholds".
 
 * Under odd circumstances (dropping rug or vase outdoors) the game could
-  say "floor" when it should say "ground" (or "dirt", or something).
-
-* Bird starts uncaged in the endgame. This is an accidental change
-  that doesn't seem worth the effort to fix.
+  formerly say "floor" when it should say "ground" (or "dirt", or something).
 
 Enhancements:
 
@@ -95,6 +94,7 @@ that random events (dwarf & pirate appearances, the bird's magic word)
 will be reproducible.
 
 A "version" command has been added. This has no effect on gameplay.
+
 The text displayed by the "news" command has been updated.
 
 A -l command-line option has been added. When this is given (with a
@@ -118,11 +118,25 @@ FORTRAN-derived code that formerly implemented the save/restore
 functions; without C's fread(3)/fwrite() and structs it was
 necessarily pretty ugly by modern standards. Encryption and
 checksumming have been discarded - it's pointless to try
-tamper-proofing saves when everyone has the source code.
+tamper-proofing saves when everyone has the source code. However
+the game still integrity-checks savefiles on resume.
+
+Save and resume filenames are stripped of leading and trailing
+whitespace before processing.
 
 A -r command-line option has been added. When it is given (with a file
 path argument) it is functionally equivalent to a RESTORE command.
 
+An -a command-line option has been added (comditionally on
+ADVENT_AUTOSAVE) for use in BBS door systems.  When this option is
+given, the game roads from the specified filename argument on startup
+and saves to it on quit or a received signal. There is a new nmessage
+to inform the user about this.
+
+The game can be built in a mode that entirely disables save/resume
+(-DADVENT_NOSAVE). If the game had been built this way, a diagnostic is
+emitted if you try to save or resume.
+
 == Translation ==
 
 The 2.5 code was a mechanical C translation of a FORTRAN original.
@@ -159,6 +173,9 @@ afl (American Fuzzy Lop).  We've found and fixed some crashers in
 our new code (which occasionally uses malloc(3)), but none as yet
 in Don's old code (which didn't).
 
+After version 1.11, correctness was carefully checked against the
+behavior of a binary from before the big refactoring.
+
 The code falls short of being fully modern C in the following
 ways:
 
@@ -178,14 +195,18 @@ ways:
   arrays are a cell larger than they strictly need to be and cell 0 is
   unused.
 
-* The code is still mostly typeless, slinging around machine ints
-  like a FORTRAN or BCPL program.  Some (incomplete) effort has been made
-  to introduce semantic types.
-
 We have made exactly one minor architectural change.  In addition to the
 old code's per-object state-description messages, we now have a per-object
 message series for state *changes*.  This makes it possible to pull a fair
 amount of text out of the arbitrary-messages list and associate those
 messages with the objects that conceptually own them.
 
+== Development status ==
+
+We consider this project finished. All issues and TODOs have been
+cleared, behavior has been carefully checked against original ADVENT,
+no future demand for new features is expected, and the test suite has
+100% code coverage.  If new bugs appear the toolchain bit-rots out
+from under underneath, we will fix those problems.
+
 // end