summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPrudhvi Akhil Alahari <prudhvi.alahari@linaro.org>2023-09-27 14:17:40 +0530
committerPrudhvi Akhil Alahari <prudhvi.alahari@linaro.org>2023-09-27 14:25:34 +0530
commitb9417cf04b6226572620ced115fc04cf1fafe062 (patch)
tree9751b96b3fb87466912f85c34d60173360520ed5
parentcc259a44a228cc575767eee5f765b3f821b25195 (diff)
Fix cache.<name>.maxAge gerrit config doc
The statement "refreshed from source data every maxAge interval" is not true. The Guava [1] and Caffeine [2] docs specify that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation. The value is not refreshed automatically after its removal. Thus remove the misleading statement. [1] https://guava.dev/releases/19.0/api/docs/com/google/common/cache/CacheBuilder.html#expireAfterWrite(long,%20java.util.concurrent.TimeUnit) [2] https://www.javadoc.io/doc/com.github.ben-manes.caffeine/caffeine/2.1.0/com/github/benmanes/caffeine/cache/Caffeine.html#expireAfterWrite-long-java.util.concurrent.TimeUnit- Release-Notes: skip Change-Id: Ie83a22f1936ea6208456b2fac05f5d4c46cae8ad
-rw-r--r--Documentation/config-gerrit.txt3
1 files changed, 1 insertions, 2 deletions
diff --git a/Documentation/config-gerrit.txt b/Documentation/config-gerrit.txt
index 5f49d614e2..c071d901da 100644
--- a/Documentation/config-gerrit.txt
+++ b/Documentation/config-gerrit.txt
@@ -826,8 +826,7 @@ Default is 0.
[[cache.name.maxAge]]cache.<name>.maxAge::
+
-Maximum age to keep an entry in the cache. Entries are removed from
-the cache and refreshed from source data every maxAge interval.
+Maximum age to keep an entry in the cache.
Values should use common unit suffixes to express their setting:
+
* s, sec, second, seconds