diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.html | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/docs/index.html b/docs/index.html index eda1758..20a5c3f 100644 --- a/docs/index.html +++ b/docs/index.html | |||
| @@ -70,7 +70,7 @@ | |||
| 70 | </p> | 70 | </p> |
| 71 | 71 | ||
| 72 | <p> | 72 | <p> |
| 73 | This document was revised on 27-Sept-13, and applies to version <tt>3.6.6</tt>. | 73 | This document was revised on 11-Oct-13, and applies to version <tt>3.7.0</tt>. |
| 74 | </p> | 74 | </p> |
| 75 | </font> | 75 | </font> |
| 76 | </center> | 76 | </center> |
| @@ -248,7 +248,10 @@ | |||
| 248 | After lanes is required, it is necessary to call <tt>lanes.configure()</tt>, which is the only function exposed by the module at this point. Calling <tt>configure()</tt> will perform one-time initializations and make the rest of the API available. | 248 | After lanes is required, it is necessary to call <tt>lanes.configure()</tt>, which is the only function exposed by the module at this point. Calling <tt>configure()</tt> will perform one-time initializations and make the rest of the API available. |
| 249 | </p> | 249 | </p> |
| 250 | <p> | 250 | <p> |
| 251 | At the same time, <tt>configure()</tt> itself will be replaced by another function that raises an error if called again with differing arguments. | 251 | At the same time, <tt>configure()</tt> itself will be replaced by another function that raises an error if called again with differing arguments, if any. |
| 252 | </p> | ||
| 253 | <p> | ||
| 254 | <b>IMPORTANT NOTE:</b> Starting with version 3.7.0, only the first occurence of <tt>require "lanes"</tt> must be followed by a call to <tt>.configure()</tt>. From this point, a simple <tt>require "lanes"</tt> will do wherever you need to require lanes again. | ||
| 252 | </p> | 255 | </p> |
| 253 | 256 | ||
| 254 | <p> | 257 | <p> |
| @@ -326,7 +329,8 @@ | |||
| 326 | <tt>nil</tt>/<tt>false</tt>/anything | 329 | <tt>nil</tt>/<tt>false</tt>/anything |
| 327 | </td> | 330 | </td> |
| 328 | <td> | 331 | <td> |
| 329 | Any non-<tt>nil|false</tt> value instructs Lanes keeps track of all lanes, so that <a href="#tracking"><tt>lanes.threads()</tt></a> can list them. | 332 | Any non-<tt>nil|false</tt> value instructs Lanes keeps track of all lanes, so that <a href="#tracking"><tt>lanes.threads()</tt></a> can list them. If <tt>false</tt>, <tt>lanes.threads()</tt> will raise an error when called. |
| 333 | Default is <tt>false</tt>. | ||
| 330 | </td> | 334 | </td> |
| 331 | </tr> | 335 | </tr> |
| 332 | 336 | ||
| @@ -364,9 +368,7 @@ | |||
| 364 | </p> | 368 | </p> |
| 365 | 369 | ||
| 366 | <p> | 370 | <p> |
| 367 | NEW (version 3.5.0) | 371 | (Since v3.5.0) Once Lanes is configured, one should register with Lanes the modules exporting functions that will be transferred either during lane generation or through <a href="#lindas">lindas</a>. |
| 368 | <br> | ||
| 369 | Once Lanes is configured, one should register with Lanes the modules exporting functions that will be transferred either during lane generation or through <a href="#lindas">lindas</a>. | ||
| 370 | <br> | 372 | <br> |
| 371 | Use <tt>lanes.require()</tt> for this purpose. This will call the original <tt>require()</tt>, then add the result to the lookup databases. | 373 | Use <tt>lanes.require()</tt> for this purpose. This will call the original <tt>require()</tt>, then add the result to the lookup databases. |
| 372 | </p> | 374 | </p> |
