Better document how .config must match compiled-in UIDs

diff --git a/include/item.h b/include/item.h
index 4d6861ce82e162b03b14f2e5e503a07d98eaca00..caf159b408e58ac67d577515ecf2cbab19dcf073 100644 (file)
--- a/include/item.h
+++ b/include/item.h
@@ -47,6 +47,7 @@ enum {
     NUMPKG = BPKG + 1
 };
 
+/* Item types, must match item.config */
 typedef enum {
     I_NONE = -1,
     I_CIVIL,

diff --git a/include/sect.h b/include/sect.h
index ec6e30c6b8969db55bbd1c3eb459750e5aab7ec6..e52cd6e236076efa10d4a7d61718d8f06683b4bb 100644 (file)
--- a/include/sect.h
+++ b/include/sect.h
@@ -121,8 +121,7 @@ struct dchrstr {
     char *d_name;              /* full name of sector type */
 };
 
-       /* sector types (must agree with order in dchr, empglb.c) */
-
+/* Sector types, must match sect.config */
 #define SCT_WATER      0       /* basics */
 #define SCT_MOUNT      1
 #define SCT_SANCT      2
@@ -195,6 +194,7 @@ extern struct dchrstr dchr[SCT_TYPE_MAX + 2];
 #define SCT_LANDMINES(sp) \
     (SCT_MINES_ARE_SEAMINES((sp)) ? 0 : (sp)->sct_mines)
 
+/* Sector infrastructure types, must match infra.config */
 #define INT_ROAD       0
 #define INT_RAIL       1
 #define INT_DEF                2

diff --git a/src/lib/global/infra.config b/src/lib/global/infra.config
index 8f539a82907404fd985e325562eb4e518f3ad7f1..9128e235124f96a1247fb328cb95172c5c9804d0 100644 (file)
--- a/src/lib/global/infra.config
+++ b/src/lib/global/infra.config
@@ -27,7 +27,7 @@
 #   infra.config: Infrastructure characteristics
 #
 #   Known contributors to this file:
-#      Markus Armbruster, 2006
+#      Markus Armbruster, 2006-2011
 #
 #   Derived from sect.c; known contributors:
 #      Dave Pare, 1986
@@ -37,6 +37,9 @@
 #      Steve McClure, 1998
 #
 
+# Row order is relevant, it must match the compiled-in order defined
+# in sect.h
+
 # Do not edit this file to customize a game!  Create your own custom
 # configuration file(s), best next to your econfig, and name them in
 # econfig key custom_tables.

diff --git a/src/lib/global/item.config b/src/lib/global/item.config
index 67f6531b0a4d65266d174b97e50871388db40538..b9428d5152cfe829920fc9811f8df7260050be19 100644 (file)
--- a/src/lib/global/item.config
+++ b/src/lib/global/item.config
@@ -32,6 +32,9 @@
 #   Derived from item.c; no known contributors.
 #
 
+# The item types (column uid) must match the compiled-in types defined
+# in item.h.
+
 # Columns pkg are indexed by packing types in compiled-in table
 # packing.
 

diff --git a/src/lib/global/sect.config b/src/lib/global/sect.config
index 2340de9a9a946fcb4316d35cff8114a17bc24fb9..52dcc5cdabd8398b4e17cb4c6f0bb7312ab1d301 100644 (file)
--- a/src/lib/global/sect.config
+++ b/src/lib/global/sect.config
@@ -37,6 +37,9 @@
 #      Steve McClure, 1998
 #
 
+# The sector types (column uid) must match the compiled-in types
+# defined in sect.h.
+
 # Sector terrain (column terra) is the uid of the underlying terrain
 # sector type.  Sector types that occur in that column are terrain
 # types, and must have themselves as terrain.
@@ -97,4 +100,5 @@ uid mnem terra prd peff mob0 mob1  nav  pkg ostr dstr val cost bui lcm hcm maint
  31  "e"    4   -1    0  0.4  0.2 land norm  1.0  2.0   7    0   1   0   0     0 1000 "enlistment center"
  32  "~"   32   -1    0  0.4  0.2 land norm  1.0  1.5   1   -1   1   0   0     0  100 "plains"
  33  "@"    0   -1    0  0.4  0.0 land norm  1.0  1.5   4   -1   1   0   0     0  100 "bridge tower"
+# Deity-defined sector types go here
 /config