| -rw-r--r-- | cgitrc.5.txt | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index df494aa..46df291 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -195,18 +195,18 @@ noheader:: on all pages. Default value: none. See also: "embedded". renamelimit:: Maximum number of files to consider when detecting renames. The value "-1" uses the compiletime value in git (for further info, look at `man git-diff`). Default value: "-1". repo.group:: - Legacy alias for 'section' which will be deprecated starting with - cgit-1.0. + Legacy alias for "section". This option is deprecated and will not be + supported in cgit-1.0. robots:: Text used as content for the "robots" meta-tag. Default value: "index, nofollow". root-desc:: Text printed below the heading on the repository index page. Default value: "a fast webinterface for the git dscm". @@ -220,17 +220,17 @@ root-title:: Text printed as heading on the repository index page. Default value: "Git Repository Browser". 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: +section:: The name of the current repository section - all repositories defined after this option will inherit the current section name. Default value: none. snapshots:: Text which specifies the default set of snapshot formats generated by cgit. The value is a space-separated list of zero or more of the values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. @@ -311,33 +311,34 @@ repo.readme:: A path (relative to <repo.path>) which specifies a file to include verbatim as the "About" page for this repo. Default value: none. repo.snapshots:: A mask of allowed snapshot-formats for this repo, restricted by the "snapshots" global setting. Default value: <snapshots>. repo.section:: - Override the current section for this repository. Default value: none. + Override the current section name for this repository. Default value: + none. repo.source-filter:: Override the default source-filter. Default value: <source-filter>. 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. +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. EXAMPLE CGITRC FILE ------------------- .... # Enable caching of up to 1000 output entriess cache-size=1000 |