| -rw-r--r-- | cgitrc.5.txt | 48 |
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:: +cache-scanrc-ttl:: + Number which specifies the time-to-live, in minutes, for the result + of scanning a path for git repositories. Default value: "15". + cache-size:: @@ -86,2 +90,6 @@ embedded:: +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:: @@ -202,4 +210,4 @@ renamelimit:: repo.group:: - A value for the current repository group, which all repositories - specified after this setting will inherit. Default value: none. + Legacy alias for "section". This option is deprecated and will not be + supported in cgit-1.0. @@ -222,2 +230,12 @@ root-title:: +scan-path:: + A path which will be scanned for repositories. If caching is enabled, + the result will be cached as a cgitrc include-file in the cache + directory. Default value: none. See also: cache-scanrc-ttl. + +section:: + The name of the current repository section - all repositories defined + after this option will inherit the current section name. Default value: + none. + snapshots:: @@ -258,3 +276,4 @@ 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". @@ -265,3 +284,4 @@ repo.clone-url:: 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". @@ -307,4 +327,9 @@ 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". @@ -315,2 +340,15 @@ repo.url:: +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". 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 |