Add config option 'enable-filter-overrides'

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 4d009f9d943cd5922e1105fc035171db09efc494..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",
@@ -200,8 +204,8 @@ renamelimit::
          `man git-diff`). Default value: "-1".
 
 repo.group::
-       Legacy alias for 'section' which will be deprecated starting with
-       cgit-1.0.
+       Legacy alias for "section". This option is deprecated and will not be
+       supported in cgit-1.0.
 
 robots::
        Text used as content for the "robots" meta-tag. Default value:
@@ -225,7 +229,7 @@ scan-path::
        the result will be cached as a cgitrc include-file in the cache
        directory. Default value: none. See also: cache-scanrc-ttl.
 
-section:
+section::
        The name of the current repository section - all repositories defined
        after this option will inherit the current section name. Default value:
        none.
@@ -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
@@ -315,14 +321,32 @@ repo.snapshots::
        A mask of allowed snapshot-formats for this repo, restricted by the
        "snapshots" global setting. Default value: <snapshots>.
 
+repo.section::
+       Override the current section name for this repository. Default value:
+       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
        setting specified for each repo. Default value: none.
 
 
+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". 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
 -------------------