Documentation tweaks

2 files changed, 10 insertions, 9 deletions

diff --git a/CHANGES b/CHANGES
index fe5b72e..64794b1 100644
--- a/CHANGES
+++ b/CHANGES
@@ -4,18 +4,19 @@ CHANGE 2: BGe 11-Jun-24
    * Lanes API changes
        - Version is now 4.0.0
        - Lanes configuration settings:
-           - demote_full_userdata removed.
-           - keepers_gc_threshold added. Control when GC runs inside keepers.
+           - demote_full_userdata removed. Use __lanesconvert instead.
+           - keepers_gc_threshold added. Controls when GC runs inside keepers.
            - nb_keepers changed to nb_user_keepers. limited to 100 keepers on top of the internal keeper used by the timer Linda.
            - shutdown_mode added. Controls how free running lanes are signalled at Lanes shutdown.
            - strip_functions added. Only useful for Lua 5.3+.
-           - verbose_errors removed.
+           - verbose_errors removed. Use lane error_trace_level instead.
            - with_timers is false by default.
         - Full userdata conversion:
-            - __lanesignore removed.
-            - __lanesconvert added. Also replaces the global Lanes setting demote_full_userdata.
+            - __lanesignore removed. Use __lanesconvert instead.
+            - __lanesconvert added.
         - Lanes API and behavior:
             - new function lanes.finally(). Installs a function that gets called at Lanes shutdown.
+            - lanes have a __close metamethod that calls join().
             - lanes can no longer be "killed" by hard-stopping their thread without any resource cleanup (see lane:cancel()).
             - lane:join(), linda:receive(), linda:send() return nil, error in case of problem.
             - lane function body must return a non-nil first value on success if lane is waited upon with lane:join().
diff --git a/docs/index.html b/docs/index.html
index 3136fb3..10bf832 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -776,7 +776,8 @@
         Change <tt>HAVE_DECODA_SUPPORT()</tt> in <tt>lanesconf.h</tt> to enable the Decoda support, that sets a special global variable <tt>decoda_name</tt> in the lane's state.<br />
         The name is stored inside the Lua state registry so that it is available for error reporting. Changing <tt>decoda_name</tt> doesn't affect this hidden name or the OS thread name reported by MSVC.<br />
         When Lanes is initialized by the first <a href="#initialization"><tt>lanes.configure()</tt></a> call, <tt>"main"</tt> is stored in the registry in the same fashion (but <tt>decoda_name</tt> and the OS thread name are left unchanged).<br />
-        The lane also has a method <tt>lane:get_debug_threadname()</tt> that gives access to that name from the caller side (returns <tt>"&lt;unnamed&gt;"</tt> if unset, <tt>"&lt;closed&gt;"</tt> if the internal Lua state is closed).
+        The lane also has a method <tt>lane:get_debug_threadname()</tt> that gives access to that name from the caller side (returns <tt>"&lt;unnamed&gt;"</tt> if unset, <tt>"&lt;closed&gt;"</tt> if the internal Lua state is closed).<br />
+        With Lua 5.4, Lanes have a <tt>__close</tt> metamethod, meaning they can be declared to-be-closed. <tt>__close</tt> calls <tt>lane:join(nil)</tt>.
 </p>
 
 <p>
@@ -986,12 +987,11 @@
 </p>
 
 <table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre>
-        [...]|[nil,err,stack_tbl]= lane_h:join([timeout_secs])
+        [...]|[nil,err,stack_tbl]= lane_h:join([timeout])
 </pre></td></tr></table>
 
 <p>
-        <tt>timeout</tt> is an optional number &gt= 0 (the default if unspecified).<br />
-        Waits until the lane finishes, or <tt>timeout</tt> seconds have passed.<br />
+        Waits until the lane finishes, or <tt>timeout</tt> seconds have passed (forever if <tt>nil</tt>).<br />
         Unlike in reading the results in table fashion, errors are not propagated.<br />
         Possible return values are:
         <ul>