diff options
author | Jason A. Donenfeld <Jason@zx2c4.com> | 2014-02-21 09:36:20 (JST) |
---|---|---|
committer | Jason A. Donenfeld <Jason@zx2c4.com> | 2014-02-21 09:36:20 (JST) |
commit | 2e8e9af1d4161bfe1bfbf1e34b1631b7cc1c1b95 (patch) | |
tree | 2388bb14949180bc641f94a2ba6953c33f536b51 | |
parent | 6ceba453a27ead382d0116d95bdeb6b6be1149e2 (diff) | |
download | cgit-2e8e9af1d4161bfe1bfbf1e34b1631b7cc1c1b95.zip cgit-2e8e9af1d4161bfe1bfbf1e34b1631b7cc1c1b95.tar.gz |
Clean up cache documentation.
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
-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:: | |||
60 | 60 | ||
61 | cache-static-ttl:: | 61 | cache-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 | ||
67 | cache-dynamic-ttl:: | 66 | cache-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 | ||
73 | cache-repo-ttl:: | 71 | cache-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 | ||
79 | cache-root-ttl:: | 76 | cache-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 | ||
85 | cache-scanrc-ttl:: | 81 | cache-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 | ||
91 | cache-about-ttl:: | 86 | cache-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 | ||
97 | cache-snapshot-ttl:: | 91 | cache-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 | ||
102 | cache-size:: | 95 | cache-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 | ||
106 | case-sensitive-sort:: | 99 | case-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 | ||
719 | CACHE | ||
720 | ------ | ||
721 | |||
722 | All cache ttl values are in minutes. Negative ttl values indicate that a page | ||
723 | type will never expire, and thus the first time a URL is accessed, the result | ||
724 | will be cached indefinitely, even if the underlying git repository changes. | ||
725 | Conversely, when a ttl value is zero, the cache is disabled for that | ||
726 | particular page type, and the page type is never cached. | ||
727 | |||
728 | |||
726 | EXAMPLE CGITRC FILE | 729 | EXAMPLE CGITRC FILE |
727 | ------------------- | 730 | ------------------- |
728 | 731 | ||