aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenoit Germain <benoit.germain@ubisoft.com>2026-03-12 11:21:51 +0100
committerBenoit Germain <benoit.germain@ubisoft.com>2026-03-12 11:21:51 +0100
commit4aa54c9a6876c4af175b306fffe8dbc010e72c5b (patch)
tree156c0c94d2b42e9a25242500d0e0d98064e61262
parentb48df44c377fa0da8af20f2eb73c602be5aeebd6 (diff)
downloadlanes-master.tar.gz
lanes-master.tar.bz2
lanes-master.zip
Minor documentation improvementsHEADmaster
-rw-r--r--docs/index.html13
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/index.html b/docs/index.html
index 9ba2bf4..cd8a371 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -75,7 +75,7 @@
75 </p> 75 </p>
76 76
77 <p> 77 <p>
78 This document was revised on 5-Mar-2026, and applies to version <code>4.0.1</code>. 78 This document was revised on 12-Mar-2026, and applies to version <code>4.0.1</code>.
79 </p> 79 </p>
80 </center> 80 </center>
81</div> 81</div>
@@ -211,7 +211,7 @@
211 <ul> 211 <ul>
212 <li><code>lane_h[]</code>: wait for, and read the values returned by the lane</li> 212 <li><code>lane_h[]</code>: wait for, and read the values returned by the lane</li>
213 <li><code>lane_h:cancel()</code>: request the lane to stop running</li> 213 <li><code>lane_h:cancel()</code>: request the lane to stop running</li>
214 <li><code>lane_h.error_trace_level</code>: current setting of error logging level</li> 214 <li><code>lane_h.error_trace_level</code>: read the current error logging level</li>
215 <li><code>lane_h:get_threadname()</code>: read the thread name</li> 215 <li><code>lane_h:get_threadname()</code>: read the thread name</li>
216 <li><code>lane_h:join()</code>: wait for the lane to close, reading the returned values</li> 216 <li><code>lane_h:join()</code>: wait for the lane to close, reading the returned values</li>
217 <li><code>lane_h:resume()</code>: resume a coroutine Lane</li> 217 <li><code>lane_h:resume()</code>: resume a coroutine Lane</li>
@@ -241,6 +241,7 @@
241 <li><code>l:restrict()</code>: place a restraint on the operations that can be done on a slot</li> 241 <li><code>l:restrict()</code>: place a restraint on the operations that can be done on a slot</li>
242 <li><code>l:send()</code>: append data</li> 242 <li><code>l:send()</code>: append data</li>
243 <li><code>l:set()</code>: replace the data</li> 243 <li><code>l:set()</code>: replace the data</li>
244 <li><code>l.status</code>: current status of the <a href="#lindas">linda</a></li>
244 <li><code>l:wake()</code>: manually wake blocking calls</li> 245 <li><code>l:wake()</code>: manually wake blocking calls</li>
245 </ul> 246 </ul>
246 </li> 247 </li>
@@ -1017,11 +1018,13 @@ static constexpr lua_CFunction _provideAllocator = +[](lua_State* const L_) {
1017 </tr> 1018 </tr>
1018 </table> 1019 </table>
1019<p> 1020<p>
1020 Each thread can change its own affinity at will. This is also true for the main Lua state. 1021 Each thread can change its own affinity at will. This is also true for the main Lua state.<br />
1022 By default, threads can run on all CPU cores.<br />
1023 Affinity should be provided as an unsigned integer value that will be interpreted as a mask where the CPU cores that can be used are defined by the set bits.
1021</p> 1024</p>
1022 1025
1023 1026
1024<!-- status +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 1027<!-- error_trace_level +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
1025<hr/> 1028<hr/>
1026<h2 id="error_trace_level">Error trace level</h2> 1029<h2 id="error_trace_level">Error trace level</h2>
1027 1030
@@ -1109,7 +1112,7 @@ static constexpr lua_CFunction _provideAllocator = +[](lua_State* const L_) {
1109 <code>"waiting"</code> 1112 <code>"waiting"</code>
1110 </td> 1113 </td>
1111 <td> 1114 <td>
1112 Waiting at a <a href="#lindas">linda</a> <code>:receive()</code> or <code>:send()</code>. 1115 Waiting at a <a href="#lindas">linda</a> <code>:receive()</code> (when insufficient data is available to serve the operation) or <code>:send()</code> (when a limit of the <a href="#lindas">linda</a> prevents sending all the values).
1113 </td> 1116 </td>
1114 </tr> 1117 </tr>
1115 <tr> 1118 <tr>