X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/a8d613efdc827a400fee89fc73e34c2666e37be6..c0dfaf1c281d0697ce43131343d7a9f170a61ff9:/cgitrc.5.txt diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 9b803b3..ea0bbe7 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -505,7 +505,9 @@ repo.readme:: A path (relative to ) which specifies a file to include verbatim as the "About" page for this repo. You may also specify a git refspec by head or by hash by prepending the refspec followed by - a colon. For example, "master:docs/readme.mkd" Default value: . + a colon. For example, "master:docs/readme.mkd". If the value begins + with a colon, i.e. ":docs/readme.rst", the default branch of the + repository will be used. Default value: . repo.snapshots:: A mask of allowed snapshot-formats for this repo, restricted by the @@ -540,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