From 008ae71ca2e9cf16cffdd4534b2e7a5e9162452d Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20=C4=8Cun=C3=A1t?= Date: Wed, 27 Jun 2018 13:45:20 +0200 Subject: [PATCH] doc: behavior of layers on kres.FAIL in lua modules --- modules/README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/modules/README.rst b/modules/README.rst index 4424871ed..60a6a7ee2 100644 --- a/modules/README.rst +++ b/modules/README.rst @@ -118,6 +118,10 @@ doesn't provide any layer to capture events. The Lua module can however provide end } +There is currently an additional "feature" in comparison to C layer functions: +the ``consume``, ``produce`` and ``checkout`` functions do not get called at all +if ``state == kres.FAIL`` (note that ``finish`` does get called nevertheless). + Since the modules are like any other Lua modules, you can interact with them through the CLI and and any interface. .. tip:: The module can be placed anywhere in the Lua search path, in the working directory or in the MODULESDIR. -- 2.47.2