ui-stats: replace 'enable-stats' setting with 'max-stats'

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 60d3ea492d3f8a923a3102235d872b93f1c98664..0bbbea3b69c891068bda9e29666877ae2008a119 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -74,10 +74,6 @@ enable-log-linecount
        and removed lines for each commit on the repository log page. Default
        value: "0".
 
-enable-stats
-       Globally enable/disable statistics for each repository. Default
-       value: "0".
-
 favicon
        Url used as link to a shortcut icon for cgit. If specified, it is
        suggested to use the value "/favicon.ico" since certain browsers will
@@ -133,6 +129,11 @@ max-repodesc-length
        Specifies the maximum number of repo description characters to display
        on the repository index page. Default value: "80".
 
+max-stats
+       Set the default maximum statistics period. Valid values are "week",
+       "month", "quarter" and "year". If unspecified, statistics are
+       disabled. Default value: none. See also: "repo.max-stats".
+
 module-link
        Text which will be used as the formatstring for a hyperlink when a
        submodule is printed in a directory listing. The arguments for the
@@ -222,9 +223,10 @@ repo.enable-log-linecount
        A flag which can be used to disable the global setting
        `enable-log-linecount'. Default value: none.
 
-repo.enable-stats
-       A flag which can be used to disable the global setting
-       `enable-stats'. Default value: none.
+repo.max-stats
+       Override the default maximum statistics period. Valid values are equal
+       to the values specified for the global "max-stats" setting. Default
+       value: none.
 
 repo.name
        The value to show as repository name. Default value: <repo.url>.
@@ -284,6 +286,10 @@ favicon=/favicon.ico
 logo=/img/mylogo.png
 
 
+# Enable statistics per week, month and quarter
+max-stats=quarter
+
+
 # Set the title and heading of the repository index page
 root-title=foobar.com git repositories
 
@@ -356,6 +362,9 @@ repo.snapshots=0
 # Disable line-counts for this repo
 repo.enable-log-linecount=0
 
+# Restrict the max statistics period for this repo
+repo.max-stats=month
+
 
 BUGS
 ----