From cd26839aafdf8dfbd0cd03cf800765721843ce8b Mon Sep 17 00:00:00 2001
From: Richard Kistruck <rhsk@ravenbrook.com>
Date: Thu, 22 Mar 2007 16:20:47 +0000
Subject: [PATCH] Mps design/buffer: create guide (only one glossary item in it
 so far)

Copied from Perforce
 Change: 161986
 ServerID: perforce.ravenbrook.com
---
 mps/design/buffer/index.html | 34 ++++++++++++++++++++++++++++++----
 1 file changed, 30 insertions(+), 4 deletions(-)

diff --git a/mps/design/buffer/index.html b/mps/design/buffer/index.html
index 007c9db107f..631ae87727e 100644
--- a/mps/design/buffer/index.html
+++ b/mps/design/buffer/index.html
@@ -26,8 +26,32 @@
 
 <hr />
 
+<h1>Allocation buffers and allocation points</h1>
+
 </div>
 
+<p>This document contains a <a href="#guide">guide</a> to allocation buffers and allocation points, followed by the historical <a href="#initial-design">initial design</a>.  References, History, Copyright and License are <a href="#section-A">at the end</a>.</p>
+
+<hr />
+
+<h1> <a id="guide">Guide</a> </h1>
+
+<p> Readership: any MPS developer.  Not confidential. </p>
+
+<h2> Introduction </h2>
+
+<p>Glossary:</p>
+<dl>
+  <dt>Trapped</dt>
+  <dd>means the buffer is in a state such that the MPS gets to know about the next use of that buffer</dd>
+</dl>
+
+
+
+<hr />
+
+<h1> <a id="initial-design">Initial Design</a> </h1>
+
 <pre>
                 ALLOCATION BUFFERS AND ALLOCATION POINTS
                            design.mps.buffer
@@ -780,13 +804,15 @@ Buffer States (richardized)
 <table>
 
 <tr valign="top">
-
   <td>2002-06-07</td>
-
   <td><a href="mailto:rb@ravenbrook.com">RB</a></td>
-
   <td>Converted from MMInfo database design document.</td>
+</tr>
 
+<tr valign="top">
+  <td>2007-03-22</td>
+  <td><a href="mailto:rhsk@ravenbrook.com">RHSK</a></td>
+  <td>Created Guide.</td>
 </tr>
 
 </table>
@@ -794,7 +820,7 @@ Buffer States (richardized)
 
 <h2><a id="section-C" name="section-C">C. Copyright and License</a></h2>
 
-<p> This document is copyright &copy; 1995-2002 <a href="http://www.ravenbrook.com/">Ravenbrook Limited</a>.  All rights reserved.  This is an open source license.  Contact Ravenbrook for commercial licensing options. </p>
+<p> This document is copyright &copy; 1995-2002, 2007 <a href="http://www.ravenbrook.com/">Ravenbrook Limited</a>.  All rights reserved.  This is an open source license.  Contact Ravenbrook for commercial licensing options. </p>
 
 <p> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: </p>