diff options
| author | Jason A. Donenfeld <Jason@zx2c4.com> | 2014-02-21 01:36:20 +0100 | 
|---|---|---|
| committer | Jason A. Donenfeld <Jason@zx2c4.com> | 2014-02-21 01:36:20 +0100 | 
| commit | 2e8e9af1d4161bfe1bfbf1e34b1631b7cc1c1b95 (patch) | |
| tree | 2388bb14949180bc641f94a2ba6953c33f536b51 /cgitrc.5.txt | |
| parent | Skip cache slot when time-to-live is zero (diff) | |
| download | cgit-2e8e9af1d4161bfe1bfbf1e34b1631b7cc1c1b95.tar.gz cgit-2e8e9af1d4161bfe1bfbf1e34b1631b7cc1c1b95.tar.bz2 cgit-2e8e9af1d4161bfe1bfbf1e34b1631b7cc1c1b95.zip | |
Clean up cache documentation.
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to '')
| -rw-r--r-- | cgitrc.5.txt | 47 | 
1 files changed, 25 insertions, 22 deletions
| diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 7158c10..cbaebca 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -60,48 +60,41 @@ cache-root::  cache-static-ttl::  	Number which specifies the time-to-live, in minutes, for the cached -	version of repository pages accessed with a fixed SHA1. Negative -	values have infinite ttl, zero means that the cache is disabled for -	this type of pages. Default value: -1". +	version of repository pages accessed with a fixed SHA1. See also: +	"CACHE". Default value: -1".  cache-dynamic-ttl::  	Number which specifies the time-to-live, in minutes, for the cached -	version of repository pages accessed without a fixed SHA1. Negative -	values have infinite ttl, zero means that the cache is disabled for this -	type of pages. Default value: "5". +	version of repository pages accessed without a fixed SHA1. See also: +	"CACHE". Default value: "5".  cache-repo-ttl::  	Number which specifies the time-to-live, in minutes, for the cached -	version of the repository summary page. Negative values have infinite -	ttl, zero means that the cache is disabled for this type of pages. -	Default value: "5". +	version of the repository summary page. See also: "CACHE". Default +	value: "5".  cache-root-ttl::  	Number which specifies the time-to-live, in minutes, for the cached -	version of the repository index page. Negative values have infinite -	ttl, zero means that the cache is disabled for this type of pages. -	Default value: "5". +	version of the repository index page. See also: "CACHE". 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. Negative values have infinite -	ttl, zero means that the cache is disable for this type of pages. -	Default value: "15". +	of scanning a path for git repositories. See also: "CACHE". Default +	value: "15".  cache-about-ttl::  	Number which specifies the time-to-live, in minutes, for the cached -	version of the repository about page. Negative values have infinite -	ttl, zero means that the cache is disable for this type of pages. -	Default value: "15". +	version of the repository about page. See also: "CACHE". Default +	value: "15".  cache-snapshot-ttl::  	Number which specifies the time-to-live, in minutes, for the cached -	version of snapshots. Negative values have infinite ttl, zero means -	that the cache is disable for this type of pages. Default value: "5". +	version of snapshots. See also: "CACHE". Default value: "5".  cache-size:: -	The maximum number of entries in the cgit cache. Default value: "0" -	(i.e. caching is disabled). +	The maximum number of entries in the cgit cache. When set to "0", +	caching is disabled. See also: "CACHE". Default value: "0"  case-sensitive-sort::  	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 +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  ------------------- | 
