From ca46cc7883b7b2749307a3e5a8196368fb52ba09 Mon Sep 17 00:00:00 2001 From: Benoit Germain Date: Mon, 17 Jun 2024 16:27:24 +0200 Subject: List configure settings alphabetically in documentation --- docs/index.html | 125 +++++++++++++++++++++++++++++--------------------------- 1 file changed, 64 insertions(+), 61 deletions(-) diff --git a/docs/index.html b/docs/index.html index defb0ad..4fdc6f3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -278,55 +278,6 @@ value definition - - - .nb_user_keepers - - integer in [0,100] - - Controls the number of "user" Keeper state used internally by Linda) objects to transfer data between lanes. Default is 0.
- Lanes always creates at least one keeper state (of group 0 for the internal timer Linda. If nb_user_keepers is 0, the other lindas you create will share this keeper by necessity.
- If there is more than one Keeper state (in total), Linda creation must specify the group it belongs to. - - - - - - .keepers_gc_threshold - - integer - - If <0, GC runs automatically. This is the default.
- If 0, GC runs after *every* Keeper operation.
- If >0, Keeper states run GC manually with lua_gc(LUA_GCCOLLECT) whenever memory usage reported by lua_gc(LUA_GCCOUNT) reaches this threshold. Check is made after every operation (see below). If memory usage remains above threshold after the GC cycle, an error is raised. - - - - - - .with_timers - - - nil/false/true - - - If equal to false or nil, Lanes doesn't start the timer service, and the associated API will be absent from the interface (see below). - Default is false. - - - - - - .verbose_errors - - - nil/false/true - - - If equal to true, Lanes will collect more information when transfering stuff across Lua states to help identify errors (with a cost). - Default is false. - - @@ -367,15 +318,27 @@ - - .track_lanes + + .keepers_gc_threshold + integer - nil/false/anything + If <0, GC runs automatically. This is the default.
+ If 0, GC runs after *every* Keeper operation.
+ If >0, Keeper states run GC manually with lua_gc(LUA_GCCOLLECT) whenever memory usage reported by lua_gc(LUA_GCCOUNT) reaches this threshold. + Check is made after every operation (see below). If memory usage remains above threshold after the GC cycle, an error is raised. + + + + + + .nb_user_keepers + integer in [0,100] - Any non-nil|false value instructs Lanes keeps track of all lanes, so that lanes.threads() can list them. If false, lanes.threads() will raise an error when called. - Default is false. + Controls the number of "user" Keeper state used internally by Linda) objects to transfer data between lanes. Default is 0.
+ Lanes always creates at least one keeper state (of group 0 for the internal timer Linda. If nb_user_keepers is 0, the other lindas you create will share this keeper by necessity.
+ If there is more than one Keeper state (in total), Linda creation must specify the group it belongs to. @@ -400,6 +363,18 @@ + + + .shutdown_mode + + + "hard"/"soft"/"call"/"ret"/"line"/"count" + + + Select the cancellation mode used at Lanes shutdown to request free running lane termination. See lane cancellation. Default is "hard". + + + .shutdown_timeout @@ -411,26 +386,54 @@ Sets the duration in seconds Lanes will wait for graceful termination of running lanes at application shutdown. Default is 0.25. + - - .shutdown_mode + + .strip_functions - "hard"/"soft"/"call"/"ret"/"line"/"count" + nil/false/true - Select the cancellation mode used at Lanes shutdown to request free running lane termination. See lane cancellation. Default is "hard". + Controls function bytecode stripping when dumping them for lane transfer. Choose between faster copies or more debug info. Default is true. - - .strip_functions + + .track_lanes + + + nil/false/anything + + + Any non-nil|false value instructs Lanes keeps track of all lanes, so that lanes.threads() can list them. If false, lanes.threads() will raise an error when called. + Default is false. + + + + + + .verbose_errors nil/false/true - Controls function bytecode stripping when dumping them for lane transfer. Choose between faster copies or more debug info. Default is true. + If equal to true, Lanes will collect more information when transfering stuff across Lua states to help identify errors (with a cost). + Default is false. + + + + + + .with_timers + + + nil/false/true + + + If equal to false or nil, Lanes doesn't start the timer service, and the associated API will be absent from the interface (see below). + Default is false. -- cgit v1.2.3-55-g6feb