Add config option 'enable-filter-overrides'

This option must be enabled if repo-specific cgitrc files should be
allowed to override any of the 'filter' options.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>

1 files changed, 16 insertions, 5 deletions

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 46df291..617b7c3 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -67,48 +67,52 @@ cache-static-ttl::
 	version of repository pages accessed with a fixed SHA1. Default value:
 	"5".
 
 clone-prefix::
 	Space-separated list of common prefixes which, when combined with a
 	repository url, generates valid clone urls for the repository. This
 	setting is only used if `repo.clone-url` is unspecified. Default value:
 	none.
 
 commit-filter::
 	Specifies a command which will be invoked to format commit messages.
 	The command will get the message on its STDIN, and the STDOUT from the
 	command will be included verbatim as the commit message, i.e. this can
 	be used to implement bugtracker integration. Default value: none.
 
 css::
 	Url which specifies the css document to include in all cgit pages.
 	Default value: "/cgit.css".
 
 embedded::
 	Flag which, when set to "1", will make cgit generate a html fragment
 	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",
 	"commit" and "tree" pages). Default value: "0".
 
 enable-log-filecount::
 	Flag which, when set to "1", will make cgit print the number of
 	modified files for each commit on the repository log page. Default
 	value: "0".
 
 enable-log-linecount::
 	Flag which, when set to "1", will make cgit print the number of added
 	and removed lines for each commit on the repository log page. Default
 	value: "0".
 
 favicon::
 	Url used as link to a shortcut icon for cgit. If specified, it is
 	suggested to use the value "/favicon.ico" since certain browsers will
 	ignore other values. Default value: none.
 
 footer::
 	The content of the file specified with this option will be included
 	verbatim at the bottom of all pages (i.e. it replaces the standard
 	"generated by..." message. Default value: none.
@@ -245,116 +249,123 @@ source-filter::
 
 summary-branches::
 	Specifies the number of branches to display in the repository "summary"
 	view. Default value: "10".
 
 summary-log::
 	Specifies the number of log entries to display in the repository
 	"summary" view. Default value: "10".
 
 summary-tags::
 	Specifies the number of tags to display in the repository "summary"
 	view. Default value: "10".
 
 virtual-root::
 	Url which, if specified, will be used as root for all cgit links. It
 	will also cause cgit to generate 'virtual urls', i.e. urls like
 	'/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
 	value: none.
 	NOTE: cgit has recently learned how to use PATH_INFO to achieve the
 	same kind of virtual urls, so this option will probably be deprecated.
 
 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
 	exists in the repository, the first branch name (when sorted) is used
 	as default instead. Default value: "master".
 
 repo.desc::
 	The value to show as repository description. Default value: none.
 
 repo.enable-log-filecount::
 	A flag which can be used to disable the global setting
 	`enable-log-filecount'. Default value: none.
 
 repo.enable-log-linecount::
 	A flag which can be used to disable the global setting
 	`enable-log-linecount'. Default value: none.
 
 repo.max-stats::
 	Override the default maximum statistics period. Valid values are equal
 	to the values specified for the global "max-stats" setting. Default
 	value: none.
 
 repo.name::
 	The value to show as repository name. Default value: <repo.url>.
 
 repo.owner::
 	A value used to identify the owner of the repository. Default value:
 	none.
 
 repo.path::
 	An absolute path to the repository directory. For non-bare repositories
 	this is the .git-directory. Default value: none.
 
 repo.readme::
 	A path (relative to <repo.path>) which specifies a file to include
 	verbatim as the "About" page for this repo. Default value: none.
 
 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". 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
 -------------------
 
 ....
 # Enable caching of up to 1000 output entriess
 cache-size=1000
 
 
 # Specify some default clone prefixes
 clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
 
 # Specify the css url
 css=/css/cgit.css
 
 
 # Show extra links for each repository on the index page
 enable-index-links=1
 
 
 # Show number of affected files per commit on the log pages
 enable-log-filecount=1