about summary refs log tree commit diff
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2014-01-14 18:07:23 +0100
committerJason A. Donenfeld <Jason@zx2c4.com>2014-01-14 18:09:52 +0100
commit6ca734da8fb246ad2272826331e0d56428b96fa1 (patch)
tree01abfea3df45135b1114996de29093b6eed7023a /cgitrc.5.txt
parenttests/: Add t0111-filter.sh (diff)
downloadcgit-pink-6ca734da8fb246ad2272826331e0d56428b96fa1.tar.gz
cgit-pink-6ca734da8fb246ad2272826331e0d56428b96fa1.zip
filter: allow returning exit code from filter
Filters can now indicate a status back to cgit by means of the exit code
for exec, or the return value from close for Lua.

Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to '')
-rw-r--r--cgitrc.5.txt3
1 files changed, 2 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index d8f7d0e..170e825 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -590,7 +590,8 @@ specification with the relevant string; available values are:
 		This is called whenever cgit writes data to the webpage.
 	'filter_close()'::
 		This is called when the current filtering operation is
-		completed.
+		completed. It must return an integer value. Usually 0
+		indicates success.
 	
 	Additionally, cgit exposes to the Lua the following built-in functions: