Two coverage imprivenents, one by recognizing dead code.

[open-adventure.git] / notes.adoc

diff --git a/notes.adoc b/notes.adoc
index c993f91a5459a5a60dff7dbb818a1ce33ef01f0e..5994b54e80de547aaec85fdda492571e4b0f9b98 100644 (file)
--- a/notes.adoc
+++ b/notes.adoc
@@ -11,8 +11,9 @@ The principal maintainers of this code are Eric S. Raymond and Jason
 Ninneman.  Eric received Don Woods's encouragement to update and ship
 the game; Jason signed on early in the process to help. The assistance
 of Peje Nilsson in restructuring some particularly grotty gotos is
-gratefully acknowledged. Petr Voropaev contributed fuzz testing. Aaron
-Traas did a lot of painstaking work to improve test coverage.
+gratefully acknowledged. Petr Voropaev contributed fuzz testing and
+code cleanups. Aaron Traas did a lot of painstaking work to improve
+test coverage.
 
 == Nomenclature ==
 
@@ -31,7 +32,7 @@ with the BSD Games version.
 Extreme care has been taken not to make changes that would alter the
 logic of the game as we received it from Don Woods, except to fix
 glitches that were clearly bugs.  By policy, all user-visible
-changes must be revertible with the -o (oldstyle) option.
+changes to gameplay must be revertible with the -o (oldstyle) option.
 
 It is a goal of this project to exactly preserve the *intended
 behavior* of 430-point Adventure, but the implementation of it is fair
@@ -48,17 +49,18 @@ Bug fixes:
 
 * 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.
+  the room ("...can't you read?"). The new message is "Well, that was
+  remarkably pointless."
  
 * Attempting to extinguish an unlit urn caused it to lose its oil.
 
-* Unrecognized words are no longer truncated to 5 characters and
-  uppercased when they are echoed.
-
 * "A crystal bridge now spans the fissure." (progressive present) was
   incorrect most places it appeared and has been replaced by "A crystal 
   bridge spans the fissure." (timeless present).
 
+* Under odd circumstances (dropping rug or vase outdoors) the game could
+  say "floor" when it should say "ground" (or "dirt", or something).
+
 By default, advent issues "> " as a command prompt.  This feature
 became common in many variants after the original 350-point version,
 but was never backported into Crowther & Woods's main line before now.
@@ -70,6 +72,10 @@ for a turn, 'i' for 'inventory', 'g' for 'get', and 'd' for 'drop'.  The 'd'
 alias collides with 'd' for 'down', but the others have been implemented.
 The "-o" (oldstyle) option disables them.
 
+Unrecognized words are no longer truncated to 5 characters and
+uppercased when they are echoed. The "-o" (oldstyle) option restores
+this behavior.
+
 A "seed" command has been added.  This is not intended for human use
 but as a way for game logs to set the PRNG (pseudorandom-number generator) so
 that random events (dwarf & pirate appearances, the bird's magic word)
@@ -98,8 +104,8 @@ 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.
 
-A -r command-line been added. When it is given (with a file path
-argument) it is functionally equivalent to a RESTORE command.
+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.
 
 == Translation ==
 
@@ -110,7 +116,7 @@ ugly and quite unreadable.
 Jason Ninneman and I have moved it to what is almost, but not quite,
 idiomatic modern C.  We refactored the right way, checking correctness
 against a comprehensive test suite that we built first and verified
-with coverage tools (we have over 95% coverage, with the remaining
+with coverage tools (we have over 98% coverage, with the remaining
 confined to exception cases that are very difficult to reach). This is
 what you are running when you do "make check".