From: Vladimír Čunát <vladimir.cunat@nic.cz>
Date: Wed, 27 Jun 2018 11:45:20 +0000 (+0200)
Subject: doc: behavior of layers on kres.FAIL in lua modules
X-Git-Tag: v2.4.0~12^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=008ae71ca2e9cf16cffdd4534b2e7a5e9162452d;p=thirdparty%2Fknot-resolver.git

doc: behavior of layers on kres.FAIL in lua modules
---

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.