From 6234c2113a2b52ddc9fa900e7848f2cd19bd9394 Mon Sep 17 00:00:00 2001
From: Benoit Germain <bnt.germain@gmail.com>
Date: Wed, 27 Jun 2012 14:07:55 +0200
Subject: * when a transfered function is not found in source, guess its name
 to help the user find out what's wrong * new function lanes.nameof()

---
 docs/index.html | 111 +++++++-------------------------------------------------
 1 file changed, 13 insertions(+), 98 deletions(-)

(limited to 'docs')

diff --git a/docs/index.html b/docs/index.html
index 52ba852..2d1c78e 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -56,7 +56,7 @@
 
 <p><br/><font size="-1"><i>Copyright &copy; 2007-12 Asko Kauppi, Benoit Germain. 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 23-Jun-12, and applies to version 3.1.4
+    </p><p>This document was revised on 26-Jun-12, and applies to version 3.1.4
 </font></p>
 
 </center>
@@ -359,6 +359,17 @@ also in the new lanes.
   </table>
   <p>Each lane also gets a function <tt>set_debug_threadname()</tt> that it can use anytime to do as the name says.
 Supported debuggers are Microsoft Visual Studio (for the C side) and Decoda (for the Lua side).
+</p>
+  <p>
+    If a lane body pulls a C function imported by a module required before Lanes itself (thus not through a hooked <tt>require</tt>), the lane generator creation will raise an error.
+    The function name it shows is a path where it was found by scanning _G. As a utility, the name guessing functionality is exposed as such:
+<table border="1" bgcolor="#E0E0FF" cellpadding="10">
+    <tr>
+      <td>
+        <code>
+          "type", "name" = lanes.nameof( o)
+        </code>
+      </table>
 </p>
 
 <h3>Free running lanes</h3>
@@ -1089,103 +1100,7 @@ its actual value.
 <h2 id="changes">Change log</h2>
 
 <p>
-  Apr-2012
-  <ul>
-    <li>improved LuaJIT2 compatibility by handling "*" library set through luaL_openlibs().</li>
-  </ul>
-
-
-  Feb-2012
-  <ul>
-    <li>Added support for an on_state_create callback invoked on a pristine Lua state created by Lanes.</li>
-    <li>This required a change in the <tt>lanes.configure()</tt> signature, hence the minor version bump.</li>
-  </ul>
-
-
-  Nov-2011
-  <ul>
-    <li>process exit change: close everything at GC when main state closes, not when atexit() handlers are processed</li>
-    <li>Lua 5.2-style module:</li>
-    <ul>
-      <li>module() is no longer used to implement lanes.lua</li>
-      <li>a global "lanes" variable is no longer created when the module is required</li>
-      <li>the Lanes module table is returned instead</li>
-    </ul>
-    <li>Lanes must be initialized before used:</li>
-    <ul>
-      <li>the first occurence of 'require "lanes"' produces a minimal interface that only contains a configure() function</li>
-      <li>the remainder of the interface is made available once this function is called</li>
-      <li>subsequent calls to configure() do nothing</li>
-      <li>configure() controls the number of keeper states and the startup of timers</li>
-    </ul>
-    <li>* LuaJIT 2 compatibility</li>
-    <ul>
-      <li>non-Lua functions are no longer copied by creating a C closure from a C pointer, but through 2-way lookup tables</li>
-      <li>this means that if a lane function body pulls non-Lua functions, the lane generator description must contain the list of libraries and modules that exports them</li>
-      <li>introduces a change in configuration .globals management: contents are copied *after* std libs are loaded</li>
-      <li>new .required configuration entry to list modules that must be require()'ed before lane body is transferred</li>
-    </ul>
-    <li>lane:cancel() wakes up waiting lindas like what is done at lane shutdown</li>
-    <li>removed packagepath and packagecpath options, replaced by a package table, whose fields path, cpath, loaders, preload are transfered</li>
-  </ul>
-
-  Mar-2011 (not yet versioned)
-  <ul>
-    <li>linda honors __tostring and __concat</li>
-    <li>new accessor linda:count(), to get info about data stored inside a linda.</li>
-    <li>new lanes options packagepath and packagecpath, in case one needs to set them differently than the default.</li>
-  </ul>
-
-  Mar-2011 (2.1.0)
-  <ul>
-  <li>fixed potential crash at application shutdown when calling lua_close() on a killed thread's VM.</li>
-  <li>exposed cancel_test() in the lanes to enable manual testing for cancellation requests.</li>
-  <li>removed kludgy {globals={threadName}} support, replaced with a new function set_debug_threadname().</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>
-  <li>Changed the atexit code to trip the timer thread's write signal.</li>
-  <li>Changed lanes.c to export functions as a module rather than writing them directly to the globals table.</li>
-</ul>
-
-Jan-2011 (2.0.10):
-<ul>
-  <li>linda_send was waiting on the wrong signal</li>
-  <li>buildfix when using i586-mingw32msvc-gcc cross compiler</li>
-  <li>lanes_h:cancel() returns a boolean as it should</li>
-  <li>timers could get blocked sometimes because they were initialized with negative values</li>
-  <li>prepare_timeout could generate an illegal setting</li>
-</ul>
-
-Dec-2010 (2.0.9):
-<ul>
-  <li>Fixed 'memory leak' in some situations where a free running lane is collected before application shutdown</li>
-  <li>Fix LuaJIT2 incompatibility (no 'tostring' hijack anymore)</li>
-  <li>Added support to generate a lane from a string</li>
-</ul>
-
-Aug-2010 (2.0.6):
-<ul>
-<li>Fixed some memory leaks</li>
-<li>Fixed error in passing parameters to finalizers</li>
-<li>Fixed missing argument propagation in lane:cancel</li>
-<li>Added thread name debugging in VS</li>
-</ul>
-
-Jan-2009 (2.0.3):
-<ul>
-  <li>Added 'finalizer' to lane options. (TBD: not implemented yet!)
-  </li>
-  <li>Added call stack to errors coming from a lane.
-  </li>
-</ul>
-
-Jul-2008 (2.0):
-<ul>
-  <li>Too many changes to list (you'll need to re-read this manual)
-  </li>
-</ul>
+  See CHANGES.
 </p>
 
 <!-- footnotes +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
-- 
cgit v1.2.3-55-g6feb