From: Jason at zx2c4.com (Jason A. Donenfeld)
Subject: [PATCH 07/12] filter: document lua filter type
Date: Mon, 13 Jan 2014 05:11:14 +0100 [thread overview]
Message-ID: <1389586279-23724-8-git-send-email-Jason@zx2c4.com> (raw)
In-Reply-To: <1389586279-23724-1-git-send-email-Jason@zx2c4.com>
Signed-off-by: Jason A. Donenfeld <Jason at zx2c4.com>
---
cgitrc.5.txt | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 60159f6..d1e872f 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -564,6 +564,29 @@ specification with the relevant string; available values are:
'exec:'::
The default "one process per filter" mode.
+'lua:'::
+ Executes the script using a built-in Lua interpreter. The script is
+ loaded once per execution of cgit, and may be called multiple times
+ during cgit's lifetime, making it a good choice for repeated filters
+ such as the 'email filter'. It responds to three functions:
+
+ 'filter_open(argument1, argument2, argument3, ...)'::
+ This is called upon activation of the filter for a particular
+ set of data.
+
+ 'filter_write(buffer)'::
+ This is called whenever cgit writes data to the webpage.
+
+ 'filter_close()'::
+ This is called when the current filtering operation is
+ completed.
+
+ Additionally, cgit exposes to the Lua the following built-in function:
+
+ 'html(str)'::
+ Writes 'str' to the webpage.
+
+
Parameters are provided to filters as follows.
about filter::
--
1.8.5.2
next prev parent reply other threads:[~2014-01-13 4:11 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-01-13 4:11 [PATCH 00/12] filter framework and lua integration: complete Jason
2014-01-13 4:11 ` [PATCH 01/12] filter: add fprintf_filter function Jason
2014-01-13 4:11 ` [PATCH 02/12] filter: add interface layer Jason
2014-01-13 4:11 ` [PATCH 03/12] filter: introduce "filter type" prefix Jason
2014-01-13 4:11 ` [PATCH 04/12] filter: allow for cleanup hook for filter types Jason
2014-01-13 4:11 ` [PATCH 05/12] filter: basic write hooking infrastructure Jason
2014-01-13 8:19 ` cgit
2014-01-13 4:11 ` [PATCH 06/12] filter: add preliminary lua support Jason
2014-01-13 8:31 ` cgit
2014-01-13 8:53 ` john
2014-01-13 8:39 ` cgit
2014-01-13 8:55 ` john
2014-01-13 9:41 ` bluewind
2014-01-13 4:11 ` Jason [this message]
2014-01-13 4:11 ` [PATCH 08/12] filter: lua error reporting Jason
2014-01-13 4:11 ` [PATCH 09/12] filter: return on null filter from open and close Jason
2014-01-13 4:11 ` [PATCH 10/12] filter: add support for email filter Jason
2014-01-13 4:11 ` [PATCH 11/12] filter: add simple gravatar " Jason
2014-01-13 4:11 ` [PATCH 12/12] filter: add gravatar lua script Jason
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1389586279-23724-8-git-send-email-Jason@zx2c4.com \
--to=cgit@lists.zx2c4.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).