author | Lars Hjemli <hjemli@gmail.com> | 2009-08-23 22:04:58 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2009-08-24 08:22:58 (UTC) |
commit | 74061ed5f03e72796450aa3b8ca1cf6ced5d59e2 (patch) (unidiff) | |
tree | 235ab2c29c027f19b00da815af3bf1d2856edc21 /cgitrc.5.txt | |
parent | a1b3938f711c9b0e5eedad1678535e5779da82c1 (diff) | |
download | cgit-74061ed5f03e72796450aa3b8ca1cf6ced5d59e2.zip cgit-74061ed5f03e72796450aa3b8ca1cf6ced5d59e2.tar.gz cgit-74061ed5f03e72796450aa3b8ca1cf6ced5d59e2.tar.bz2 |
Add support for repo-local cgitrc file
When recursively scanning a directory tree looking for git repositories,
cgit will now parse cgitrc files found within such repositories.
The repo-specific config files can include any repo-specific options
except 'repo.url' and 'repo.path'. Also, in such config files the 'repo.'
prefix can not be used, i.e. the valid options then becomes:
* name
* clone-url
* desc
* ower
* defbranch
* snapshots
* enable-log-filecount
* enable-log-linecount
* max-stats
* module-link
* section
* about-filter
* commit-filter
* source-filter
* readme
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
-rw-r--r-- | cgitrc.5.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index e99c9f7..df494aa 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -305,48 +305,57 @@ repo.owner:: | |||
305 | 305 | ||
306 | repo.path:: | 306 | repo.path:: |
307 | An absolute path to the repository directory. For non-bare repositories | 307 | An absolute path to the repository directory. For non-bare repositories |
308 | this is the .git-directory. Default value: none. | 308 | this is the .git-directory. Default value: none. |
309 | 309 | ||
310 | repo.readme:: | 310 | repo.readme:: |
311 | A path (relative to <repo.path>) which specifies a file to include | 311 | A path (relative to <repo.path>) which specifies a file to include |
312 | verbatim as the "About" page for this repo. Default value: none. | 312 | verbatim as the "About" page for this repo. Default value: none. |
313 | 313 | ||
314 | repo.snapshots:: | 314 | repo.snapshots:: |
315 | A mask of allowed snapshot-formats for this repo, restricted by the | 315 | A mask of allowed snapshot-formats for this repo, restricted by the |
316 | "snapshots" global setting. Default value: <snapshots>. | 316 | "snapshots" global setting. Default value: <snapshots>. |
317 | 317 | ||
318 | repo.section:: | 318 | repo.section:: |
319 | Override the current section for this repository. Default value: none. | 319 | Override the current section for this repository. Default value: none. |
320 | 320 | ||
321 | repo.source-filter:: | 321 | repo.source-filter:: |
322 | Override the default source-filter. Default value: <source-filter>. | 322 | Override the default source-filter. Default value: <source-filter>. |
323 | 323 | ||
324 | repo.url:: | 324 | repo.url:: |
325 | The relative url used to access the repository. This must be the first | 325 | The relative url used to access the repository. This must be the first |
326 | setting specified for each repo. Default value: none. | 326 | setting specified for each repo. Default value: none. |
327 | 327 | ||
328 | 328 | ||
329 | REPOSITORY-SPECIFIC CGITRC FILE | ||
330 | ------------------------------- | ||
331 | When the option 'scan-path' is used to auto-discover git repositories, cgit | ||
332 | will try to parse the file 'cgitrc' within any found repository. Such a repo- | ||
333 | specific config file may contain any of the repo-specific options described | ||
334 | above, except 'repo.url' and 'repo.path'. Also, in a repo-specific config | ||
335 | file, the 'repo.' prefix is dropped from the config option names. | ||
336 | |||
337 | |||
329 | EXAMPLE CGITRC FILE | 338 | EXAMPLE CGITRC FILE |
330 | ------------------- | 339 | ------------------- |
331 | 340 | ||
332 | .... | 341 | .... |
333 | # Enable caching of up to 1000 output entriess | 342 | # Enable caching of up to 1000 output entriess |
334 | cache-size=1000 | 343 | cache-size=1000 |
335 | 344 | ||
336 | 345 | ||
337 | # Specify some default clone prefixes | 346 | # Specify some default clone prefixes |
338 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 347 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |
339 | 348 | ||
340 | # Specify the css url | 349 | # Specify the css url |
341 | css=/css/cgit.css | 350 | css=/css/cgit.css |
342 | 351 | ||
343 | 352 | ||
344 | # Show extra links for each repository on the index page | 353 | # Show extra links for each repository on the index page |
345 | enable-index-links=1 | 354 | enable-index-links=1 |
346 | 355 | ||
347 | 356 | ||
348 | # Show number of affected files per commit on the log pages | 357 | # Show number of affected files per commit on the log pages |
349 | enable-log-filecount=1 | 358 | enable-log-filecount=1 |
350 | 359 | ||
351 | 360 | ||
352 | # Show number of added/removed lines per commit on the log pages | 361 | # Show number of added/removed lines per commit on the log pages |