]> git.ipfire.org Git - thirdparty/haproxy.git/commit
DOC: lua: fix yield-dependent methods expected contexts
authorAurelien DARRAGON <adarragon@haproxy.com>
Tue, 19 Nov 2024 18:28:16 +0000 (19:28 +0100)
committerAurelien DARRAGON <adarragon@haproxy.com>
Tue, 19 Nov 2024 18:36:02 +0000 (19:36 +0100)
commit501827ebe0ad8f4121c4397267afbc7968e3d9af
tree2b292ae0d31d8450407cc337133ed324e2f5f676
parent6f746af915103bc73401dca55b0d7c4f7d88807f
DOC: lua: fix yield-dependent methods expected contexts

Contrary to what the doc states, it is not expected (nor relevant) to
use yield-dependent methods such as core.yield() or core.(m)sleep() from
contexts that don't support yielding. Such contexts include body, init,
fetches and converters.

Thus the doc got it wrong since the beginning, because such methods were
never supported from the above contexts, yet it was listed in the list
of compatible contexts (probably the result of a copy-paste), which is
error-prone because it could either cause a Lua runtime error to be
thrown, or be ignored in some other cases.

It should be backported to all stable versions.
doc/lua-api/index.rst