Document the tweakables.

diff --git a/mparena.c b/mparena.c
index e40a6a6..54d9449 100644 (file)
--- a/mparena.c
+++ b/mparena.c
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: mparena.c,v 1.2 1999/11/21 22:14:19 mdw Exp $
+ * $Id: mparena.c,v 1.3 1999/11/22 13:58:00 mdw Exp $
  *
  * Allocation and freeing of MP buffers
  *
@@ -30,6 +30,9 @@
 /*----- Revision history --------------------------------------------------* 
  *
  * $Log: mparena.c,v $
+ * Revision 1.3  1999/11/22 13:58:00  mdw
+ * Document the tweakables.
+ *
  * Revision 1.2  1999/11/21 22:14:19  mdw
  * Fix bug.  Improve diagnostic capabilities.
  *
@@ -51,8 +54,21 @@
 
 /*----- Tweakables --------------------------------------------------------*/
 
+/* --- @MPARENA_TRIVIAL@ --- *
+ *
+ * Make the allocator a passthrough.  It immediately calls the underlying
+ * allocation functions rather than attempting to keep track of blocks
+ * itself.
+ */
+
 /* #define MPARENA_TRIVIAL */
 
+/* --- @MPARENA_DEBUG@ --- *
+ *
+ * The name of an output trace file to which logging information about the
+ * state of arena trees should be written.  If unset, no logging is done.
+ */
+
 /* #define MPARENA_DEBUG "mparena.out" */
 
 /*----- Default allocator -------------------------------------------------*/