From b4dc93dc76fabf043b7679f8fcab91cdb1f418c6 Mon Sep 17 00:00:00 2001 From: Lars Hjemli Date: Thu, 20 Aug 2009 17:42:14 +0200 Subject: cgitrc.5.txt: document repo.scan and cache-scanrc-ttl Signed-off-by: Lars Hjemli --- cgitrc.5.txt | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'cgitrc.5.txt') diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 0d18290..68ae2ed 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -54,6 +54,10 @@ cache-root-ttl:: Number which specifies the time-to-live, in minutes, for the cached version of the repository index page. Default value: "5". +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:: The maximum number of entries in the cgit cache. Default value: "0" (i.e. caching is disabled). @@ -199,6 +203,11 @@ repo.group:: A value for the current repository group, which all repositories specified after this setting will inherit. Default value: none. +repo.scan:: + 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. + robots:: Text used as content for the "robots" meta-tag. Default value: "index, nofollow". -- cgit v1.2.3-24-g4f1b From 00466376922e2f7db02b3c335d46af5eb8991c49 Mon Sep 17 00:00:00 2001 From: Lars Hjemli Date: Sun, 23 Aug 2009 19:35:56 +0200 Subject: Rename 'repo.scan' to 'scan-path' The 'repo.' prefix will soon be reserved for repo-specific config options. Signed-off-by: Lars Hjemli --- cgitrc.5.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'cgitrc.5.txt') diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 68ae2ed..2abbd41 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -203,11 +203,6 @@ repo.group:: A value for the current repository group, which all repositories specified after this setting will inherit. Default value: none. -repo.scan:: - 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. - robots:: Text used as content for the "robots" meta-tag. Default value: "index, nofollow". @@ -225,6 +220,11 @@ 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. + 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 -- cgit v1.2.3-24-g4f1b From e7af002d5c405c82652f739d08ced3908d1f57e7 Mon Sep 17 00:00:00 2001 From: Lars Hjemli Date: Sun, 23 Aug 2009 22:58:39 +0200 Subject: Introduce 'section' as canonical spelling for 'repo.group' The 'repo.' prefix should be reserved for repo-specific options, but the option 'repo.group' must still be honored to stay backwards compatible. Signed-off-by: Lars Hjemli --- cgitrc.5.txt | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'cgitrc.5.txt') diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 2abbd41..4d009f9 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -200,8 +200,8 @@ renamelimit:: `man git-diff`). Default value: "-1". 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' which will be deprecated starting with + cgit-1.0. robots:: Text used as content for the "robots" meta-tag. Default value: @@ -225,6 +225,11 @@ scan-path:: 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:: 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 -- cgit v1.2.3-24-g4f1b From 39398545787179bc8075d64a443f9da3845c4f67 Mon Sep 17 00:00:00 2001 From: Lars Hjemli Date: Sun, 23 Aug 2009 23:00:28 +0200 Subject: Add config option 'repo.section' This option can be used to specify the section name for the current repository. Signed-off-by: Lars Hjemli --- cgitrc.5.txt | 3 +++ 1 file changed, 3 insertions(+) (limited to 'cgitrc.5.txt') diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 4d009f9..e99c9f7 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -315,6 +315,9 @@ repo.snapshots:: A mask of allowed snapshot-formats for this repo, restricted by the "snapshots" global setting. Default value: . +repo.section:: + Override the current section for this repository. Default value: none. + repo.source-filter:: Override the default source-filter. Default value: . -- cgit v1.2.3-24-g4f1b From 74061ed5f03e72796450aa3b8ca1cf6ced5d59e2 Mon Sep 17 00:00:00 2001 From: Lars Hjemli Date: Mon, 24 Aug 2009 00:04:58 +0200 Subject: 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 --- cgitrc.5.txt | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'cgitrc.5.txt') diff --git a/cgitrc.5.txt b/cgitrc.5.txt index e99c9f7..df494aa 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -326,6 +326,15 @@ repo.url:: 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. + + EXAMPLE CGITRC FILE ------------------- -- cgit v1.2.3-24-g4f1b From 007df98d2114fac4e9134cd7bc7e2960d0d730b4 Mon Sep 17 00:00:00 2001 From: Lars Hjemli Date: Mon, 24 Aug 2009 07:51:48 +0200 Subject: cgitrc.5.txt: fix markup errors Signed-off-by: Lars Hjemli --- cgitrc.5.txt | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) (limited to 'cgitrc.5.txt') diff --git a/cgitrc.5.txt b/cgitrc.5.txt index df494aa..46df291 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -200,8 +200,8 @@ renamelimit:: `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: @@ -225,7 +225,7 @@ scan-path:: 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. @@ -316,7 +316,8 @@ repo.snapshots:: "snapshots" global setting. Default value: . 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: . @@ -328,11 +329,11 @@ 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'. 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 -- cgit v1.2.3-24-g4f1b From 2273c2c821bfc77d492d7e97ae38f162d7fc91aa Mon Sep 17 00:00:00 2001 From: Lars Hjemli Date: Mon, 24 Aug 2009 08:53:21 +0200 Subject: 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 --- cgitrc.5.txt | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) (limited to 'cgitrc.5.txt') diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 46df291..617b7c3 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -88,6 +88,10 @@ embedded:: suitable for embedding in other html pages. Default value: none. See also: "noheader". +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:: Flag which, when set to "1", will make cgit generate extra links for each repo in the repository index (specifically, to the "summary", @@ -266,14 +270,16 @@ virtual-root:: REPOSITORY SETTINGS ------------------- repo.about-filter:: - Override the default about-filter. Default value: . + Override the default about-filter. Default value: none. See also: + "enable-filter-overrides". repo.clone-url:: A list of space-separated urls which can be used to clone this repo. Default value: none. repo.commit-filter:: - Override the default commit-filter. Default value: . + Override the default commit-filter. Default value: none. See also: + "enable-filter-overrides". repo.defbranch:: The name of the default branch for this repository. If no such branch @@ -320,7 +326,8 @@ repo.section:: none. repo.source-filter:: - Override the default source-filter. Default value: . + Override the default source-filter. Default value: none. See also: + "enable-filter-overrides". repo.url:: The relative url used to access the repository. This must be the first @@ -332,8 +339,12 @@ 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. +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 -- cgit v1.2.3-24-g4f1b