about summary refs log tree commit diff
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
authorJohn Keeping <john@keeping.me.uk>2014-01-12 17:13:53 +0000
committerJason A. Donenfeld <Jason@zx2c4.com>2014-01-14 02:00:07 +0100
commit4bb87cbf17588ec91b46bf0ef0be01672e9be787 (patch)
tree454216292add842ac194ec909a073002dc840609 /cgitrc.5.txt
parentfilter: add interface layer (diff)
downloadcgit-pink-4bb87cbf17588ec91b46bf0ef0be01672e9be787.tar.gz
cgit-pink-4bb87cbf17588ec91b46bf0ef0be01672e9be787.zip
filter: introduce "filter type" prefix
This allows different filter implementations to be specified in the
configuration file.  Currently only "exec" is supported, but it may now
be specified either with or without the "exec:" prefix.

Signed-off-by: John Keeping <john@keeping.me.uk>
Diffstat (limited to '')
-rw-r--r--cgitrc.5.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 52caed0..60159f6 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -557,6 +557,15 @@ config files, e.g. "repo.desc" becomes "desc".
 
 FILTER API
 ----------
+By default, filters are separate processes that are executed each time they
+are needed.  Alternative technologies may be used by prefixing the filter
+specification with the relevant string; available values are:
+
+'exec:'::
+	The default "one process per filter" mode.
+
+Parameters are provided to filters as follows.
+
 about filter::
 	This filter is given a single parameter: the filename of the source
 	file to filter. The filter can use the filename to determine (for