summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
authorLars Hjemli <hjemli@gmail.com>2009-08-24 06:53:21 (UTC)
committer Lars Hjemli <hjemli@gmail.com>2009-08-24 08:22:59 (UTC)
commit2273c2c821bfc77d492d7e97ae38f162d7fc91aa (patch) (side-by-side diff)
tree688acf38d828122c86af88585cd89dbf23efc239 /cgitrc.5.txt
parent007df98d2114fac4e9134cd7bc7e2960d0d730b4 (diff)
downloadcgit-2273c2c821bfc77d492d7e97ae38f162d7fc91aa.zip
cgit-2273c2c821bfc77d492d7e97ae38f162d7fc91aa.tar.gz
cgit-2273c2c821bfc77d492d7e97ae38f162d7fc91aa.tar.bz2
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>
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt21
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
@@ -85,12 +85,16 @@ 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::
@@ -263,20 +267,22 @@ virtual-root::
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".
@@ -317,26 +323,31 @@ repo.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
-------------------
....