-rw-r--r-- | cgitrc.5.txt | 23 |
1 files changed, 16 insertions, 7 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 60d3ea4..0bbbea3 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -71,16 +71,12 @@ enable-log-filecount | |||
71 | 71 | ||
72 | enable-log-linecount | 72 | enable-log-linecount |
73 | Flag which, when set to "1", will make cgit print the number of added | 73 | Flag which, when set to "1", will make cgit print the number of added |
74 | and removed lines for each commit on the repository log page. Default | 74 | and removed lines for each commit on the repository log page. Default |
75 | value: "0". | 75 | value: "0". |
76 | 76 | ||
77 | enable-stats | ||
78 | Globally enable/disable statistics for each repository. Default | ||
79 | value: "0". | ||
80 | |||
81 | favicon | 77 | favicon |
82 | Url used as link to a shortcut icon for cgit. If specified, it is | 78 | Url used as link to a shortcut icon for cgit. If specified, it is |
83 | suggested to use the value "/favicon.ico" since certain browsers will | 79 | suggested to use the value "/favicon.ico" since certain browsers will |
84 | ignore other values. Default value: none. | 80 | ignore other values. Default value: none. |
85 | 81 | ||
86 | footer | 82 | footer |
@@ -130,12 +126,17 @@ max-repo-count | |||
130 | index page. Default value: "50". | 126 | index page. Default value: "50". |
131 | 127 | ||
132 | max-repodesc-length | 128 | max-repodesc-length |
133 | Specifies the maximum number of repo description characters to display | 129 | Specifies the maximum number of repo description characters to display |
134 | on the repository index page. Default value: "80". | 130 | on the repository index page. Default value: "80". |
135 | 131 | ||
132 | max-stats | ||
133 | Set the default maximum statistics period. Valid values are "week", | ||
134 | "month", "quarter" and "year". If unspecified, statistics are | ||
135 | disabled. Default value: none. See also: "repo.max-stats". | ||
136 | |||
136 | module-link | 137 | module-link |
137 | Text which will be used as the formatstring for a hyperlink when a | 138 | Text which will be used as the formatstring for a hyperlink when a |
138 | submodule is printed in a directory listing. The arguments for the | 139 | submodule is printed in a directory listing. The arguments for the |
139 | formatstring are the path and SHA1 of the submodule commit. Default | 140 | formatstring are the path and SHA1 of the submodule commit. Default |
140 | value: "./?repo=%s&page=commit&id=%s" | 141 | value: "./?repo=%s&page=commit&id=%s" |
141 | 142 | ||
@@ -219,15 +220,16 @@ repo.enable-log-filecount | |||
219 | `enable-log-filecount'. Default value: none. | 220 | `enable-log-filecount'. Default value: none. |
220 | 221 | ||
221 | repo.enable-log-linecount | 222 | repo.enable-log-linecount |
222 | A flag which can be used to disable the global setting | 223 | A flag which can be used to disable the global setting |
223 | `enable-log-linecount'. Default value: none. | 224 | `enable-log-linecount'. Default value: none. |
224 | 225 | ||
225 | repo.enable-stats | 226 | repo.max-stats |
226 | A flag which can be used to disable the global setting | 227 | Override the default maximum statistics period. Valid values are equal |
227 | `enable-stats'. Default value: none. | 228 | to the values specified for the global "max-stats" setting. Default |
229 | value: none. | ||
228 | 230 | ||
229 | repo.name | 231 | repo.name |
230 | The value to show as repository name. Default value: <repo.url>. | 232 | The value to show as repository name. Default value: <repo.url>. |
231 | 233 | ||
232 | repo.owner | 234 | repo.owner |
233 | A value used to identify the owner of the repository. Default value: | 235 | A value used to identify the owner of the repository. Default value: |
@@ -281,12 +283,16 @@ favicon=/favicon.ico | |||
281 | 283 | ||
282 | 284 | ||
283 | # Use a custom logo | 285 | # Use a custom logo |
284 | logo=/img/mylogo.png | 286 | logo=/img/mylogo.png |
285 | 287 | ||
286 | 288 | ||
289 | # Enable statistics per week, month and quarter | ||
290 | max-stats=quarter | ||
291 | |||
292 | |||
287 | # Set the title and heading of the repository index page | 293 | # Set the title and heading of the repository index page |
288 | root-title=foobar.com git repositories | 294 | root-title=foobar.com git repositories |
289 | 295 | ||
290 | 296 | ||
291 | # Set a subheading for the repository index page | 297 | # Set a subheading for the repository index page |
292 | root-desc=tracking the foobar development | 298 | root-desc=tracking the foobar development |
@@ -353,12 +359,15 @@ repo.desc=the kernel | |||
353 | # Disable adhoc downloads of this repo | 359 | # Disable adhoc downloads of this repo |
354 | repo.snapshots=0 | 360 | repo.snapshots=0 |
355 | 361 | ||
356 | # Disable line-counts for this repo | 362 | # Disable line-counts for this repo |
357 | repo.enable-log-linecount=0 | 363 | repo.enable-log-linecount=0 |
358 | 364 | ||
365 | # Restrict the max statistics period for this repo | ||
366 | repo.max-stats=month | ||
367 | |||
359 | 368 | ||
360 | BUGS | 369 | BUGS |
361 | ---- | 370 | ---- |
362 | Comments currently cannot appear on the same line as a setting; the comment | 371 | Comments currently cannot appear on the same line as a setting; the comment |
363 | will be included as part of the value. E.g. this line: | 372 | will be included as part of the value. E.g. this line: |
364 | 373 | ||