about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorJason A. Donenfeld2014-02-21 01:36:20 +0100
committerJason A. Donenfeld2014-02-21 01:36:20 +0100
commit2e8e9af1d4161bfe1bfbf1e34b1631b7cc1c1b95 (patch)
tree2388bb14949180bc641f94a2ba6953c33f536b51
parentSkip cache slot when time-to-live is zero (diff)
downloadcgit-2e8e9af1d4161bfe1bfbf1e34b1631b7cc1c1b95.tar.gz
cgit-2e8e9af1d4161bfe1bfbf1e34b1631b7cc1c1b95.zip
Clean up cache documentation.
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
-rw-r--r--cgitrc.5.txt47
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::
60 60
61cache-static-ttl:: 61cache-static-ttl::
62 Number which specifies the time-to-live, in minutes, for the cached 62 Number which specifies the time-to-live, in minutes, for the cached
63 version of repository pages accessed with a fixed SHA1. Negative 63 version of repository pages accessed with a fixed SHA1. See also:
64 values have infinite ttl, zero means that the cache is disabled for 64 "CACHE". Default value: -1".
65 this type of pages. Default value: -1".
66 65
67cache-dynamic-ttl:: 66cache-dynamic-ttl::
68 Number which specifies the time-to-live, in minutes, for the cached 67 Number which specifies the time-to-live, in minutes, for the cached
69 version of repository pages accessed without a fixed SHA1. Negative 68 version of repository pages accessed without a fixed SHA1. See also:
70 values have infinite ttl, zero means that the cache is disabled for this 69 "CACHE". Default value: "5".
71 type of pages. Default value: "5".
72 70
73cache-repo-ttl:: 71cache-repo-ttl::
74 Number which specifies the time-to-live, in minutes, for the cached 72 Number which specifies the time-to-live, in minutes, for the cached
75 version of the repository summary page. Negative values have infinite 73 version of the repository summary page. See also: "CACHE". Default
76 ttl, zero means that the cache is disabled for this type of pages. 74 value: "5".
77 Default value: "5".
78 75
79cache-root-ttl:: 76cache-root-ttl::
80 Number which specifies the time-to-live, in minutes, for the cached 77 Number which specifies the time-to-live, in minutes, for the cached
81 version of the repository index page. Negative values have infinite 78 version of the repository index page. See also: "CACHE". Default
82 ttl, zero means that the cache is disabled for this type of pages. 79 value: "5".
83 Default value: "5".
84 80
85cache-scanrc-ttl:: 81cache-scanrc-ttl::
86 Number which specifies the time-to-live, in minutes, for the result 82 Number which specifies the time-to-live, in minutes, for the result
87 of scanning a path for git repositories. Negative values have infinite 83 of scanning a path for git repositories. See also: "CACHE". Default
88 ttl, zero means that the cache is disable for this type of pages. 84 value: "15".
89 Default value: "15".
90 85
91cache-about-ttl:: 86cache-about-ttl::
92 Number which specifies the time-to-live, in minutes, for the cached 87 Number which specifies the time-to-live, in minutes, for the cached
93 version of the repository about page. Negative values have infinite 88 version of the repository about page. See also: "CACHE". Default
94 ttl, zero means that the cache is disable for this type of pages. 89 value: "15".
95 Default value: "15".
96 90
97cache-snapshot-ttl:: 91cache-snapshot-ttl::
98 Number which specifies the time-to-live, in minutes, for the cached 92 Number which specifies the time-to-live, in minutes, for the cached
99 version of snapshots. Negative values have infinite ttl, zero means 93 version of snapshots. See also: "CACHE". Default value: "5".
100 that the cache is disable for this type of pages. Default value: "5".
101 94
102cache-size:: 95cache-size::
103 The maximum number of entries in the cgit cache. Default value: "0" 96 The maximum number of entries in the cgit cache. When set to "0",
104 (i.e. caching is disabled). 97 caching is disabled. See also: "CACHE". Default value: "0"
105 98
106case-sensitive-sort:: 99case-sensitive-sort::
107 Sort items in the repo list case sensitively. Default value: "1". 100 Sort items in the repo list case sensitively. Default value: "1".
@@ -723,6 +716,16 @@ the environment variables defined in "FILTER API":
723- repo.clone-url 716- repo.clone-url
724 717
725 718
719CACHE
720------
721
722All cache ttl values are in minutes. Negative ttl values indicate that a page
723type will never expire, and thus the first time a URL is accessed, the result
724will be cached indefinitely, even if the underlying git repository changes.
725Conversely, when a ttl value is zero, the cache is disabled for that
726particular page type, and the page type is never cached.
727
728
726EXAMPLE CGITRC FILE 729EXAMPLE CGITRC FILE
727------------------- 730-------------------
728 731