mirrors/cgit
0
0
Fork 0
mirror of https://git.zx2c4.com/cgit synced 2024-11-22 08:28:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up cache documentation.

Browse Source 
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
This commit is contained in:
Jason A. Donenfeld 2014-02-21 01:36:20 +01:00
parent 6ceba453a2
commit 2e8e9af1d4
1 changed files with 25 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
cgitrc.5.txt
View File

@ -60,48 +60,41 @@ cache-root::
cache-static-ttl:: cache-static-ttl::
Number which specifies the time-to-live, in minutes, for the cached Number which specifies the time-to-live, in minutes, for the cached
version of repository pages accessed with a fixed SHA1. Negative version of repository pages accessed with a fixed SHA1. See also:
values have infinite ttl, zero means that the cache is disabled for "CACHE". Default value: -1".
this type of pages. Default value: -1".
cache-dynamic-ttl:: cache-dynamic-ttl::
Number which specifies the time-to-live, in minutes, for the cached Number which specifies the time-to-live, in minutes, for the cached
version of repository pages accessed without a fixed SHA1. Negative version of repository pages accessed without a fixed SHA1. See also:
values have infinite ttl, zero means that the cache is disabled for this "CACHE". Default value: "5".
type of pages. Default value: "5".
cache-repo-ttl:: cache-repo-ttl::
Number which specifies the time-to-live, in minutes, for the cached Number which specifies the time-to-live, in minutes, for the cached
version of the repository summary page. Negative values have infinite version of the repository summary page. See also: "CACHE". Default
ttl, zero means that the cache is disabled for this type of pages. value: "5".
Default value: "5".
cache-root-ttl:: cache-root-ttl::
Number which specifies the time-to-live, in minutes, for the cached Number which specifies the time-to-live, in minutes, for the cached
version of the repository index page. Negative values have infinite version of the repository index page. See also: "CACHE". Default
ttl, zero means that the cache is disabled for this type of pages. value: "5".
Default value: "5".
cache-scanrc-ttl:: cache-scanrc-ttl::
Number which specifies the time-to-live, in minutes, for the result Number which specifies the time-to-live, in minutes, for the result
of scanning a path for git repositories. Negative values have infinite of scanning a path for git repositories. See also: "CACHE". Default
ttl, zero means that the cache is disable for this type of pages. value: "15".
Default value: "15".
cache-about-ttl:: cache-about-ttl::
Number which specifies the time-to-live, in minutes, for the cached Number which specifies the time-to-live, in minutes, for the cached
version of the repository about page. Negative values have infinite version of the repository about page. See also: "CACHE". Default
ttl, zero means that the cache is disable for this type of pages. value: "15".
Default value: "15".
cache-snapshot-ttl:: cache-snapshot-ttl::
Number which specifies the time-to-live, in minutes, for the cached Number which specifies the time-to-live, in minutes, for the cached
version of snapshots. Negative values have infinite ttl, zero means version of snapshots. See also: "CACHE". Default value: "5".
that the cache is disable for this type of pages. Default value: "5".
cache-size:: cache-size::
The maximum number of entries in the cgit cache. Default value: "0" The maximum number of entries in the cgit cache. When set to "0",
(i.e. caching is disabled). caching is disabled. See also: "CACHE". Default value: "0"
case-sensitive-sort:: case-sensitive-sort::
Sort items in the repo list case sensitively. Default value: "1". Sort items in the repo list case sensitively. Default value: "1".
@ -723,6 +716,16 @@ the environment variables defined in "FILTER API":
- repo.clone-url - repo.clone-url
CACHE
------
All cache ttl values are in minutes. Negative ttl values indicate that a page
type will never expire, and thus the first time a URL is accessed, the result
will be cached indefinitely, even if the underlying git repository changes.
Conversely, when a ttl value is zero, the cache is disabled for that
particular page type, and the page type is never cached.
EXAMPLE CGITRC FILE EXAMPLE CGITRC FILE
------------------- -------------------