Add config option 'enable-filter-overrides'

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 46df291c1612a9f63f7bdae7b44dea95727e85c4..617b7c39a03aaa7a5bc355fc05e2ea2be1d2bf5c 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -88,6 +88,10 @@ embedded::
        suitable for embedding in other html pages. Default value: none. See
        also: "noheader".
        
+enable-filter-overrides::
+       Flag which, when set to "1", allows all filter settings to be
+       overridden in repository-specific cgitrc files. Default value: none.
+
 enable-index-links::
        Flag which, when set to "1", will make cgit generate extra links for
        each repo in the repository index (specifically, to the "summary",
@@ -266,14 +270,16 @@ virtual-root::
 REPOSITORY SETTINGS
 -------------------
 repo.about-filter::
-       Override the default about-filter. Default value: <about-filter>.
+       Override the default about-filter. Default value: none. See also:
+       "enable-filter-overrides".
 
 repo.clone-url::
        A list of space-separated urls which can be used to clone this repo.
        Default value: none.
 
 repo.commit-filter::
-       Override the default commit-filter. Default value: <commit-filter>.
+       Override the default commit-filter. Default value: none. See also:
+       "enable-filter-overrides".
 
 repo.defbranch::
        The name of the default branch for this repository. If no such branch
@@ -320,7 +326,8 @@ repo.section::
        none.
 
 repo.source-filter::
-       Override the default source-filter. Default value: <source-filter>.
+       Override the default source-filter. Default value: none. See also:
+       "enable-filter-overrides".
 
 repo.url::
        The relative url used to access the repository. This must be the first
@@ -332,8 +339,12 @@ REPOSITORY-SPECIFIC CGITRC FILE
 When the option "scan-path" is used to auto-discover git repositories, cgit
 will try to parse the file "cgitrc" within any found repository. Such a
 repo-specific config file may contain any of the repo-specific options
-described above, except "repo.url" and "repo.path". Also, in a repo-specific
-config file, the "repo." prefix is dropped from the config option names.
+described above, except "repo.url" and "repo.path". Additionally, the "filter"
+options are only acknowledged in repo-specific config files when
+"enable-filter-overrides" is set to "1".
+
+Note: the "repo." prefix is dropped from the option names in repo-specific
+config files, e.g. "repo.desc" becomes "desc".
 
 
 EXAMPLE CGITRC FILE