author | Lars Hjemli <hjemli@gmail.com> | 2009-08-24 06:53:21 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2009-08-24 08:22:59 (UTC) |
commit | 2273c2c821bfc77d492d7e97ae38f162d7fc91aa (patch) (unidiff) | |
tree | 688acf38d828122c86af88585cd89dbf23efc239 /cgitrc.5.txt | |
parent | 007df98d2114fac4e9134cd7bc7e2960d0d730b4 (diff) | |
download | cgit-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>
-rw-r--r-- | cgitrc.5.txt | 21 |
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 | |||
@@ -79,24 +79,28 @@ commit-filter:: | |||
79 | command will be included verbatim as the commit message, i.e. this can | 79 | command will be included verbatim as the commit message, i.e. this can |
80 | be used to implement bugtracker integration. Default value: none. | 80 | be used to implement bugtracker integration. Default value: none. |
81 | 81 | ||
82 | css:: | 82 | css:: |
83 | Url which specifies the css document to include in all cgit pages. | 83 | Url which specifies the css document to include in all cgit pages. |
84 | Default value: "/cgit.css". | 84 | Default value: "/cgit.css". |
85 | 85 | ||
86 | embedded:: | 86 | embedded:: |
87 | Flag which, when set to "1", will make cgit generate a html fragment | 87 | Flag which, when set to "1", will make cgit generate a html fragment |
88 | suitable for embedding in other html pages. Default value: none. See | 88 | suitable for embedding in other html pages. Default value: none. See |
89 | also: "noheader". | 89 | also: "noheader". |
90 | 90 | ||
91 | enable-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 | |||
91 | enable-index-links:: | 95 | enable-index-links:: |
92 | Flag which, when set to "1", will make cgit generate extra links for | 96 | Flag which, when set to "1", will make cgit generate extra links for |
93 | each repo in the repository index (specifically, to the "summary", | 97 | each repo in the repository index (specifically, to the "summary", |
94 | "commit" and "tree" pages). Default value: "0". | 98 | "commit" and "tree" pages). Default value: "0". |
95 | 99 | ||
96 | enable-log-filecount:: | 100 | enable-log-filecount:: |
97 | Flag which, when set to "1", will make cgit print the number of | 101 | Flag which, when set to "1", will make cgit print the number of |
98 | modified files for each commit on the repository log page. Default | 102 | modified files for each commit on the repository log page. Default |
99 | value: "0". | 103 | value: "0". |
100 | 104 | ||
101 | enable-log-linecount:: | 105 | enable-log-linecount:: |
102 | Flag which, when set to "1", will make cgit print the number of added | 106 | Flag which, when set to "1", will make cgit print the number of added |
@@ -257,32 +261,34 @@ summary-tags:: | |||
257 | 261 | ||
258 | virtual-root:: | 262 | virtual-root:: |
259 | Url which, if specified, will be used as root for all cgit links. It | 263 | Url which, if specified, will be used as root for all cgit links. It |
260 | will also cause cgit to generate 'virtual urls', i.e. urls like | 264 | will also cause cgit to generate 'virtual urls', i.e. urls like |
261 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 265 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
262 | value: none. | 266 | value: none. |
263 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 267 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
264 | same kind of virtual urls, so this option will probably be deprecated. | 268 | same kind of virtual urls, so this option will probably be deprecated. |
265 | 269 | ||
266 | REPOSITORY SETTINGS | 270 | REPOSITORY SETTINGS |
267 | ------------------- | 271 | ------------------- |
268 | repo.about-filter:: | 272 | repo.about-filter:: |
269 | Override the default about-filter. Default value: <about-filter>. | 273 | Override the default about-filter. Default value: none. See also: |
274 | "enable-filter-overrides". | ||
270 | 275 | ||
271 | repo.clone-url:: | 276 | repo.clone-url:: |
272 | A list of space-separated urls which can be used to clone this repo. | 277 | A list of space-separated urls which can be used to clone this repo. |
273 | Default value: none. | 278 | Default value: none. |
274 | 279 | ||
275 | repo.commit-filter:: | 280 | repo.commit-filter:: |
276 | Override the default commit-filter. Default value: <commit-filter>. | 281 | Override the default commit-filter. Default value: none. See also: |
282 | "enable-filter-overrides". | ||
277 | 283 | ||
278 | repo.defbranch:: | 284 | repo.defbranch:: |
279 | The name of the default branch for this repository. If no such branch | 285 | The name of the default branch for this repository. If no such branch |
280 | exists in the repository, the first branch name (when sorted) is used | 286 | exists in the repository, the first branch name (when sorted) is used |
281 | as default instead. Default value: "master". | 287 | as default instead. Default value: "master". |
282 | 288 | ||
283 | repo.desc:: | 289 | repo.desc:: |
284 | The value to show as repository description. Default value: none. | 290 | The value to show as repository description. Default value: none. |
285 | 291 | ||
286 | repo.enable-log-filecount:: | 292 | repo.enable-log-filecount:: |
287 | A flag which can be used to disable the global setting | 293 | A flag which can be used to disable the global setting |
288 | `enable-log-filecount'. Default value: none. | 294 | `enable-log-filecount'. Default value: none. |
@@ -311,38 +317,43 @@ repo.readme:: | |||
311 | A path (relative to <repo.path>) which specifies a file to include | 317 | A path (relative to <repo.path>) which specifies a file to include |
312 | verbatim as the "About" page for this repo. Default value: none. | 318 | verbatim as the "About" page for this repo. Default value: none. |
313 | 319 | ||
314 | repo.snapshots:: | 320 | repo.snapshots:: |
315 | A mask of allowed snapshot-formats for this repo, restricted by the | 321 | A mask of allowed snapshot-formats for this repo, restricted by the |
316 | "snapshots" global setting. Default value: <snapshots>. | 322 | "snapshots" global setting. Default value: <snapshots>. |
317 | 323 | ||
318 | repo.section:: | 324 | repo.section:: |
319 | Override the current section name for this repository. Default value: | 325 | Override the current section name for this repository. Default value: |
320 | none. | 326 | none. |
321 | 327 | ||
322 | repo.source-filter:: | 328 | repo.source-filter:: |
323 | Override the default source-filter. Default value: <source-filter>. | 329 | Override the default source-filter. Default value: none. See also: |
330 | "enable-filter-overrides". | ||
324 | 331 | ||
325 | repo.url:: | 332 | repo.url:: |
326 | The relative url used to access the repository. This must be the first | 333 | The relative url used to access the repository. This must be the first |
327 | setting specified for each repo. Default value: none. | 334 | setting specified for each repo. Default value: none. |
328 | 335 | ||
329 | 336 | ||
330 | REPOSITORY-SPECIFIC CGITRC FILE | 337 | REPOSITORY-SPECIFIC CGITRC FILE |
331 | ------------------------------- | 338 | ------------------------------- |
332 | When the option "scan-path" is used to auto-discover git repositories, cgit | 339 | When the option "scan-path" is used to auto-discover git repositories, cgit |
333 | will try to parse the file "cgitrc" within any found repository. Such a | 340 | will try to parse the file "cgitrc" within any found repository. Such a |
334 | repo-specific config file may contain any of the repo-specific options | 341 | repo-specific config file may contain any of the repo-specific options |
335 | described above, except "repo.url" and "repo.path". Also, in a repo-specific | 342 | described above, except "repo.url" and "repo.path". Additionally, the "filter" |
336 | config file, the "repo." prefix is dropped from the config option names. | 343 | options are only acknowledged in repo-specific config files when |
344 | "enable-filter-overrides" is set to "1". | ||
345 | |||
346 | Note: the "repo." prefix is dropped from the option names in repo-specific | ||
347 | config files, e.g. "repo.desc" becomes "desc". | ||
337 | 348 | ||
338 | 349 | ||
339 | EXAMPLE CGITRC FILE | 350 | EXAMPLE CGITRC FILE |
340 | ------------------- | 351 | ------------------- |
341 | 352 | ||
342 | .... | 353 | .... |
343 | # Enable caching of up to 1000 output entriess | 354 | # Enable caching of up to 1000 output entriess |
344 | cache-size=1000 | 355 | cache-size=1000 |
345 | 356 | ||
346 | 357 | ||
347 | # Specify some default clone prefixes | 358 | # Specify some default clone prefixes |
348 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 359 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |