Bump version.

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 7158c10559ade0cba278ce1c3d375138aa0dd85d..b7570db3ed30f2010a706fecc4e4d9b30dcc3541 100644 (file)
--- 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
 
 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
 
 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
 
 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
 
 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
 
 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
 
 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
 
 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::
 
 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".
 
 case-sensitive-sort::
        Sort items in the repo list case sensitively. Default value: "1".


@@ -610,7 +603,7 @@ specification with the relevant string; available values are:
                This is called when the current filtering operation is
                completed. It must return an integer value. Usually 0
                indicates success.
                This is called when the current filtering operation is
                completed. It must return an integer value. Usually 0
                indicates success.

-       
+

        Additionally, cgit exposes to the Lua the following built-in functions:
 
        'html(str)'::
        Additionally, cgit exposes to the Lua the following built-in functions:
 
        'html(str)'::


@@ -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
 -------------------