Diff options
| author | Bryce Kwon <bryce@brycekwon.com> | |
|---|---|---|
| committer | Bryce Kwon <bryce@brycekwon.com> | |
| commit | ||
| parent | ||
| tree | ||
| download | ||
Say what 0 and negative values do
The entries disagreed on what 0 means, a limit lifted for
max-message-length but a description reduced to an ellipsis for
max-repodesc-length, and most did not say at all.
| -rw-r--r-- | MANUAL.txt | 53 |
1 file changed, 32 insertions, 21 deletions
@@ -51,18 +51,21 @@ branch-sort:: cache-about-ttl:: Number which specifies the time-to-live, in minutes, for the cached - version of the repository about page. Default value: "15". See also: - "The cache". + version of the repository about page. A value of "0" leaves the page + uncached and a negative value never expires it. Default value: "15". See + also: "The cache". cache-dynamic-ttl:: Number which specifies the time-to-live, in minutes, for the cached - version of repository pages accessed without a fixed object id. Default - value: "5". See also: "The cache". + version of repository pages accessed without a fixed object id. A value + of "0" leaves them uncached and a negative value never expires them. + Default value: "5". See also: "The cache". cache-index-ttl:: Number which specifies the time-to-live, in minutes, for the cached - version of the repository index page. Default value: "5". See also: "The - cache". + version of the repository index page. A value of "0" leaves the page + uncached and a negative value never expires it. Default value: "5". See + also: "The cache". cache-max-slot-size:: Number which specifies the largest response, in kilobytes, that a cache @@ -91,18 +94,21 @@ cache-size:: cache-snapshot-ttl:: Number which specifies the time-to-live, in minutes, for the cached version of snapshots. A snapshot requested with a fixed object id uses - "cache-static-ttl" instead, since its content can never change. Default - value: "5". See also: "The cache". + "cache-static-ttl" instead, since its content can never change. A value + of "0" leaves them uncached and a negative value never expires them. + Default value: "5". See also: "The cache". cache-static-ttl:: Number which specifies the time-to-live, in minutes, for the cached - version of repository pages accessed with a fixed object id. Default - value: "-1". See also: "The cache". + version of repository pages accessed with a fixed object id. A value of + "0" leaves them uncached and a negative value, as by default, never + expires them. Default value: "-1". See also: "The cache". cache-summary-ttl:: Number which specifies the time-to-live, in minutes, for the cached - version of the repository summary page. Default value: "5". See also: - "The cache". + version of the repository summary page. A value of "0" leaves the page + uncached and a negative value never expires it. Default value: "5". See + also: "The cache". case-sensitive-sort:: Sort items in the repository list case-sensitively. Default value: "1". @@ -350,8 +356,9 @@ logo-link:: of the repository index page. See also: "repo.logo-link". max-atom-items:: - Specifies the number of items to display in the atom feed. Default - value: "10". + Specifies the number of items to display in the atom feed. A value of + "0" leaves the feed empty and a negative value puts every commit in it. + Default value: "10". max-blob-size:: Specifies the maximum size in KBytes of a blob that cgit will read into @@ -364,8 +371,8 @@ max-blob-size:: Default value: "10240" (10 MB). max-commit-count:: - Specifies the number of entries to list per page in "log" page. Default - value: "50". + Specifies the number of entries to list per page in "log" page. A value + of "0" or less lists none. Default value: "50". max-diff-files:: If a commit changes more files than this, the "commit" and "diff" pages @@ -381,7 +388,8 @@ max-diff-lines:: max-message-length:: Specifies the maximum number of commit message characters to display in - the "log" page. Default value: "80". + the "log" page. Any value below "15", "0" included, turns the limit off. + Default value: "80". max-patch-count:: Specifies the maximum number of commits emitted as a series by the @@ -401,7 +409,9 @@ max-repo-count:: max-repodesc-length:: Specifies the maximum number of repository description characters to - display on the repository index page. Default value: "80". + display on the repository index page. A longer description is cut short + with an ellipsis, so a value of "0" or less shows the ellipsis alone. + Default value: "80". max-stats:: Enable the statistics page, which holds the commits-per-author table, @@ -449,8 +459,8 @@ remove-suffix:: rename-limit:: Maximum number of files to consider when detecting renames. The value - "-1" uses the compiletime value in git, see git-diff(1). Default value: - "-1". + "-1" uses the compiletime value in git, see git-diff(1). A value of "0" + removes the limit. Default value: "-1". repository-sort:: The way in which repositories in each section are sorted. Valid values @@ -562,7 +572,8 @@ summary-branches:: summary-log:: Specifies the number of log entries to display in the repository - "summary" page. Default value: "10". + "summary" page. A value of "0" or less leaves the log off the summary + page. Default value: "10". summary-tags:: Specifies the number of tags to display in the repository "summary" |