summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
authorLars Hjemli <hjemli@gmail.com>2009-09-13 20:02:07 (UTC)
committer Lars Hjemli <hjemli@gmail.com>2009-09-13 20:02:07 (UTC)
commit92f6940975f6771f3a08d497c02575ee5bdc79da (patch) (unidiff)
treec1c538b24e50be3bf63356acf246cda76b91c519 /cgitrc.5.txt
parent5f12e45fe3338095916a444ff106dd9fc9991d84 (diff)
parentee554849ac7209fa8f7486327ec9f3b370e4c876 (diff)
downloadcgit-92f6940975f6771f3a08d497c02575ee5bdc79da.zip
cgit-92f6940975f6771f3a08d497c02575ee5bdc79da.tar.gz
cgit-92f6940975f6771f3a08d497c02575ee5bdc79da.tar.bz2
Merge branch 'lh/repo-scan'
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt48
1 files changed, 43 insertions, 5 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 3b16db9..4dc383d 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -56,2 +56,6 @@ cache-root-ttl::
56 56
57cache-scanrc-ttl::
58 Number which specifies the time-to-live, in minutes, for the result
59 of scanning a path for git repositories. Default value: "15".
60
57cache-size:: 61cache-size::
@@ -86,2 +90,6 @@ embedded::
86 90
91enable-filter-overrides::
92 Flag which, when set to "1", allows all filter settings to be
93 overridden in repository-specific cgitrc files. Default value: none.
94
87enable-index-links:: 95enable-index-links::
@@ -202,4 +210,4 @@ renamelimit::
202repo.group:: 210repo.group::
203 A value for the current repository group, which all repositories 211 Legacy alias for "section". This option is deprecated and will not be
204 specified after this setting will inherit. Default value: none. 212 supported in cgit-1.0.
205 213
@@ -222,2 +230,12 @@ root-title::
222 230
231scan-path::
232 A path which will be scanned for repositories. If caching is enabled,
233 the result will be cached as a cgitrc include-file in the cache
234 directory. Default value: none. See also: cache-scanrc-ttl.
235
236section::
237 The name of the current repository section - all repositories defined
238 after this option will inherit the current section name. Default value:
239 none.
240
223snapshots:: 241snapshots::
@@ -258,3 +276,4 @@ REPOSITORY SETTINGS
258repo.about-filter:: 276repo.about-filter::
259 Override the default about-filter. Default value: <about-filter>. 277 Override the default about-filter. Default value: none. See also:
278 "enable-filter-overrides".
260 279
@@ -265,3 +284,4 @@ repo.clone-url::
265repo.commit-filter:: 284repo.commit-filter::
266 Override the default commit-filter. Default value: <commit-filter>. 285 Override the default commit-filter. Default value: none. See also:
286 "enable-filter-overrides".
267 287
@@ -307,4 +327,9 @@ repo.snapshots::
307 327
328repo.section::
329 Override the current section name for this repository. Default value:
330 none.
331
308repo.source-filter:: 332repo.source-filter::
309 Override the default source-filter. Default value: <source-filter>. 333 Override the default source-filter. Default value: none. See also:
334 "enable-filter-overrides".
310 335
@@ -315,2 +340,15 @@ repo.url::
315 340
341REPOSITORY-SPECIFIC CGITRC FILE
342-------------------------------
343When the option "scan-path" is used to auto-discover git repositories, cgit
344will try to parse the file "cgitrc" within any found repository. Such a
345repo-specific config file may contain any of the repo-specific options
346described above, except "repo.url" and "repo.path". Additionally, the "filter"
347options are only acknowledged in repo-specific config files when
348"enable-filter-overrides" is set to "1".
349
350Note: the "repo." prefix is dropped from the option names in repo-specific
351config files, e.g. "repo.desc" becomes "desc".
352
353
316EXAMPLE CGITRC FILE 354EXAMPLE CGITRC FILE