diff options
| author | Jason A. Donenfeld <Jason@zx2c4.com> | 2013-05-25 14:50:19 +0200 |
|---|---|---|
| committer | Jason A. Donenfeld <Jason@zx2c4.com> | 2013-05-25 20:33:28 +0200 |
| commit | c0dfaf1c281d0697ce43131343d7a9f170a61ff9 (patch) | |
| tree | e52a47596e72d9a7f1ebb19fd4fe5b3a39d95567 /cgitrc.5.txt | |
| parent | 3cb5d86dc68bab4883bf5a7cbc90f3e266237355 (diff) | |
ui-summary: Pass filename to about-filter
This gives the about-filter API the same semantics as source-filter,
where the filter receives the filename so it can decide what to do next
with it.
While we're at it, plug a memory leak.
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to 'cgitrc.5.txt')
| -rw-r--r-- | cgitrc.5.txt | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 8a0a9c9..ea0bbe7 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -542,9 +542,11 @@ config files, e.g. "repo.desc" becomes "desc". FILTER API ---------- about filter:: - This filter is given no arguments. The about text that is to be - filtered is available on standard input and the filtered text is - expected on standard output. + This filter is given a single parameter: the filename of the source + file to filter. The filter can use the filename to determine (for + example) the type of syntax to follow when formatting the readme file. + The about text that is to be filtered is available on standard input + and the filtered text is expected on standard output. commit filter:: This filter is given no arguments. The commit message text that is to |