From c3a71f6db6781e40a9e75bb1107c901d791aab04 Mon Sep 17 00:00:00 2001
From: "Eric S. Raymond" <esr@thyrsus.com>
Date: Wed, 21 Jun 2017 11:45:16 -0400
Subject: [PATCH] Documentation and polishing.

---
 adventure.yaml |  4 ++++
 newdungeon.py  | 26 ++++++++++++++++++--------
 2 files changed, 22 insertions(+), 8 deletions(-)

diff --git a/adventure.yaml b/adventure.yaml
index c5987d7..c339e0f 100644
--- a/adventure.yaml
+++ b/adventure.yaml
@@ -33,6 +33,10 @@
 #    If the inventory desription begins with "*" the object is dungeon
 #    furniture that cannot be taken or carried.
 #
+# obituaries: Death messages abd reincarnation queries.  Order is
+#    significant, they're used in succession as the player racks up
+#    deaths.
+#
 # hints: Each item contains a hint number (add 10 to get cond bit),
 #    the number of turns he must be at the right loc(s) before
 #    triggering the hint, the points deducted for taking the hint, the
diff --git a/newdungeon.py b/newdungeon.py
index 136d941..52380e6 100755
--- a/newdungeon.py
+++ b/newdungeon.py
@@ -8,7 +8,9 @@ yaml_name = "adventure.yaml"
 h_name = "newdb.h"
 c_name = "newdb.c"
 
-h_template = """#include <stdio.h>
+h_template = """/* Generated from adventure.yaml - do not hand-hack! */
+
+#include <stdio.h>
 
 typedef struct {{
   const char* inventory;
@@ -56,9 +58,9 @@ extern turn_threshold_t turn_thresholds[];
 extern obituary_t obituaries[];
 extern hint_t hints[];
 
-extern size_t CLSSES;
-extern int maximum_deaths;
-extern int turn_threshold_count;
+extern const size_t CLSSES;
+extern const int maximum_deaths;
+extern const int turn_threshold_count;
 
 enum arbitrary_messages_refs {{
 {}
@@ -71,9 +73,13 @@ enum locations_refs {{
 enum object_descriptions_refs {{
 {}
 }};
+
+/* end */
 """
 
-c_template = """#include "{}"
+c_template = """/* Generated from adventure.yaml - do not hand-hack! */
+
+#include "{}"
 
 const char* arbitrary_messages[] = {{
 {}
@@ -103,9 +109,11 @@ hint_t hints[] = {{
 {}
 }};
 
-size_t CLSSES = {};
-int maximum_deaths = {};
-int turn_threshold_count = {};
+const size_t CLSSES = {};
+const int maximum_deaths = {};
+const int turn_threshold_count = {};
+
+/* end */
 """
 
 def make_c_string(string):
@@ -269,3 +277,5 @@ if __name__ == "__main__":
 
     with open(c_name, "w") as cf:
         cf.write(c)
+
+# end
-- 
2.31.1