aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBenoit Germain <benoit.germain@ubisoft.com>2024-06-12 08:26:47 +0200
committerBenoit Germain <benoit.germain@ubisoft.com>2024-06-12 08:26:47 +0200
commit9b78a51e6eb060ce0bee664d18facc656135035a (patch)
tree9c4004e4dc88a1dffd999ed2057e741d79ef818b /docs
parent529c31f3a4ca26f2f57052db352e1f686317b19c (diff)
downloadlanes-9b78a51e6eb060ce0bee664d18facc656135035a.tar.gz
lanes-9b78a51e6eb060ce0bee664d18facc656135035a.tar.bz2
lanes-9b78a51e6eb060ce0bee664d18facc656135035a.zip
Documentation tweaks
Diffstat (limited to 'docs')
-rw-r--r--docs/index.html8
1 files changed, 4 insertions, 4 deletions
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 @@
776 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 /> 776 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 />
777 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 /> 777 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 />
778 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 /> 778 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 />
779 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). 779 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 />
780 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>.
780</p> 781</p>
781 782
782<p> 783<p>
@@ -986,12 +987,11 @@
986</p> 987</p>
987 988
988<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre> 989<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre>
989 [...]|[nil,err,stack_tbl]= lane_h:join([timeout_secs]) 990 [...]|[nil,err,stack_tbl]= lane_h:join([timeout])
990</pre></td></tr></table> 991</pre></td></tr></table>
991 992
992<p> 993<p>
993 <tt>timeout</tt> is an optional number &gt= 0 (the default if unspecified).<br /> 994 Waits until the lane finishes, or <tt>timeout</tt> seconds have passed (forever if <tt>nil</tt>).<br />
994 Waits until the lane finishes, or <tt>timeout</tt> seconds have passed.<br />
995 Unlike in reading the results in table fashion, errors are not propagated.<br /> 995 Unlike in reading the results in table fashion, errors are not propagated.<br />
996 Possible return values are: 996 Possible return values are:
997 <ul> 997 <ul>