From 974aa4343cf900938b5d357d10798d91faf60f5a Mon Sep 17 00:00:00 2001
From: Benoit Germain <bnt.germain@gmail.com>
Date: Mon, 21 Feb 2011 20:33:39 +0100
Subject: Make the number of internal keeper states selectable by an optional
 parameter passed to require.

---
 docs/index.html | 41 ++++++++++++++++++++++++++++++++---------
 1 file changed, 32 insertions(+), 9 deletions(-)

(limited to 'docs')

diff --git a/docs/index.html b/docs/index.html
index a28dd41..3d2ecf2 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -56,7 +56,7 @@
 
 <p><br/><font size="-1"><i>Copyright &copy; 2007-11 Asko Kauppi. All rights reserved.</i>
     <br>Lua Lanes is published under the same <A HREF="http://en.wikipedia.org/wiki/MIT_License">MIT license</A> as Lua 5.1.
-    </p><p>This document was revised on 12-Feb-11, and applies to version 2.0.11.
+    </p><p>This document was revised on 21-Feb-11, and applies to version 2.1.0.
 </font></p>
 
 </center>
@@ -817,12 +817,12 @@ can be used for custom userdata as well. Here's what to do.
       <tt>"delete"</tt>: receives this same pointer on the stack, and should cleanup the object.</li>
     <li>
       <tt>"metatable"</tt>: should build a metatable for the object. Don't cache the metatable
-yourself, Lanes takes care of it ("metatable" should only be invoked once).</li>
+      yourself, Lanes takes care of it ("metatable" should only be invoked once).</li>
       <li>
         <tt>"module"</tt>: is the name of the module that exports the idfunc,
-to be pushed on the stack as a string. It is necessary so that Lanes can require it in
-any Lane and keeper state that receives a userdata. This is to prevent crashes in situations
-where the module could be unloaded while the idfunc pointer is still held.</li>
+        to be pushed on the stack as a string. It is necessary so that Lanes can require it in
+        any Lane and keeper state that receives a userdata. This is to prevent crashes in situations
+        where the module could be unloaded while the idfunc pointer is still held.</li>
 </ul>
 Take a look at <tt>linda_id</tt> in <tt>lanes.c</tt>.
     </li>
@@ -917,10 +917,10 @@ Here are some things one should consider, if best performance is vital:
     merged into one main timer state (see <tt>timer.lua</tt>); no OS side
     timers are utilized.
     </li>
-    <li>Lindas are hashed to a fixed number of "keeper states", which are a locking entity.
-    If you are using a lot of Linda objects,
-    it may be useful to try having more of these keeper states. By default,
-    only one is used (see <tt>KEEPER_STATES_N</tt>), but this is an implementation detail.
+    <li>Lindas are hashed to a number of "keeper states", which are a locking entity.
+    If you are using a lot of Linda objects, it may be useful to try having more of
+    these keeper states. By default, only one is used but this is an implementation detail.
+    It is possible to <tt>require( "lanes", N)</tt> to use more keeper states.
     </li>
 </ul>
 </p>
@@ -952,6 +952,29 @@ its actual value.
 <h2 id="changes">Change log</h2>
 
 <p>
+Feb-2011 (2.1.0)
+<ul>
+  <li>Added an auto-require mechanism to ensure any deep userdata transiting in a lane causes its parent module to be required in that lane
+  <ul>
+    <li>Changed idfunc signature and contract to clarify the fact it is not lua-callable and to be able to require the module it was exported from in the target lanes</li>
+    <li>When a deep userdata idfunc requests a module to be required, manually check that it is not loaded before requiring it instead of relying on the require function's loop detection feature</li>
+    <li>When a module must be required, raise an error if the 'require' function is not found in the target state</li>
+    <li>We know Lanes is loaded in the master state, so we don't force it to be required in every lane too when a linda deep userdata is copied</li>
+  </ul>
+  </li>
+  <li>Fixed application hang-up because keeper state was not released in case of errors thrown by inter-state data copy for unsupported types</li>
+  <li>Refactor lane proxy implementation: it is now a full userdata instead of a table, and its methods are implemented in C instead of Lua
+    <ul>
+      <li>its metatable is no longer accessible</li>
+      <li>writing to the proxy raises an error</li>
+      <li>it is no longer possible to overwrite its join() and cancel() methods</li>
+    </ul>
+  </li>
+  <li>Moved keeper-related code in a separate source file</li>
+  <li>keeper.lua is now embedded in text form instead of bytecode to improve LuaJIT2-compatibility</li>
+  <li>Make the number of internal keeper states selctable by an optional parameter passed to require.</li>
+</ul>
+
 Feb-2011 (2.0.11):
 <ul>
   <li>Fixed bug where reference to Linda object was dropped for a short time (crashing if GC was run during that time).</li>
-- 
cgit v1.2.3-55-g6feb