filter: allow returning exit code from filter

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index b7dc5a4ca665e092a7f5f03a9f749fccd02984b1..170e825b414d4daebf719bb6567f5cc70e447a80 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -121,9 +121,9 @@ email-filter::
        Specifies a command which will be invoked to format names and email
        address of committers, authors, and taggers, as represented in various
        places throughout the cgit interface. This command will receive an
        Specifies a command which will be invoked to format names and email
        address of committers, authors, and taggers, as represented in various
        places throughout the cgit interface. This command will receive an

-       email address as its only command line argument, and the text to
-       format on STDIN. It is to write the formatted text back out onto
-       STDOUT. Default value: none. See also: "FILTER API".
+       email address and an origin page string as its command line arguments,
+       and the text to format on STDIN. It is to write the formatted text back
+       out onto STDOUT. Default value: none. See also: "FILTER API".

 
 embedded::
        Flag which, when set to "1", will make cgit generate a html fragment
 
 embedded::
        Flag which, when set to "1", will make cgit generate a html fragment


@@ -390,10 +390,10 @@ side-by-side-diffs::
        default. Default value: "0".
 
 snapshots::
        default. Default value: "0".
 
 snapshots::

-       Text which specifies the default set of snapshot formats generated by
-       cgit. The value is a space-separated list of zero or more of the
-       values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value:
-       none.
+       Text which specifies the default set of snapshot formats that cgit
+       generates links for. The value is a space-separated list of zero or
+       more of the values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip".
+       Default value: none.

 
 source-filter::
        Specifies a command which will be invoked to format plaintext blobs
 
 source-filter::
        Specifies a command which will be invoked to format plaintext blobs


@@ -538,8 +538,9 @@ repo.readme::
        file. Default value: <readme>.
 
 repo.snapshots::
        file. Default value: <readme>.
 
 repo.snapshots::

-       A mask of allowed snapshot-formats for this repo, restricted by the
-       "snapshots" global setting. Default value: <snapshots>.
+       A mask of snapshot formats for this repo that cgit generates links for,
+       restricted by the global "snapshots" setting. Default value:
+       <snapshots>.

 
 repo.section::
        Override the current section name for this repository. Default value:
 
 repo.section::
        Override the current section name for this repository. Default value:


@@ -589,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
                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:
 
        
        Additionally, cgit exposes to the Lua the following built-in functions:
 


@@ -620,10 +622,11 @@ commit filter::
        expected on standard output.
 
 email filter::
        expected on standard output.
 
 email filter::

-       This filter is given a single parameter: the email address of the
-       relevent user. The filter will then receive the text string to format
-       on standard input and is expected to write to standard output the
-       formatted text to be included in the page.
+       This filter is given two parameters: the email address of the relevent
+       author and a string indicating the originating page. The filter will
+       then receive the text string to format on standard input and is
+       expected to write to standard output the formatted text to be included
+       in the page.

 
 source filter::
        This filter is given a single parameter: the filename of the source
 
 source filter::
        This filter is given a single parameter: the filename of the source