deploy: eb4aaa1b4b828c7d2ab501f03ebe79b13c75b7e0
1 files changed, 9 insertions, 4 deletions
diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html
index f56ea8d946..2ffaa2fccf 100644
--- a/develop/usage/configuration/config_documentation.html
+++ b/develop/usage/configuration/config_documentation.html
@@ -1060,15 +1060,20 @@ at all.</p>
<p><code>cache_autotuning</code> and its sub-options <code>max_cache_memory_usage</code>, <code>target_cache_memory_usage</code>, and
<code>min_cache_ttl</code> work in conjunction with each other to maintain a balance between cache memory
usage and cache entry availability. You must be using <a href="https://github.com/matrix-org/synapse#help-synapse-is-slow-and-eats-all-my-ramcpu">jemalloc</a>
-to utilize this option, and all three of the options must be specified for this feature to work.</p>
+to utilize this option, and all three of the options must be specified for this feature to work. This option
+defaults to off, enable it by providing values for the sub-options listed below. Please note that the feature will not work
+and may cause unstable behavior (such as excessive emptying of caches or exceptions) if all of the values are not provided.
+Please see the <a href="#config-conventions">Config Conventions</a> for information on how to specify memory size and cache expiry
+durations.</p>
<ul>
<li><code>max_cache_memory_usage</code> sets a ceiling on how much memory the cache can use before caches begin to be continuously evicted.
They will continue to be evicted until the memory usage drops below the <code>target_memory_usage</code>, set in
-the flag below, or until the <code>min_cache_ttl</code> is hit.</li>
-<li><code>target_memory_usage</code> sets a rough target for the desired memory usage of the caches.</li>
+the setting below, or until the <code>min_cache_ttl</code> is hit. There is no default value for this option.</li>
+<li><code>target_memory_usage</code> sets a rough target for the desired memory usage of the caches. There is no default value
+for this option.</li>
<li><code>min_cache_ttl</code> sets a limit under which newer cache entries are not evicted and is only applied when
caches are actively being evicted/<code>max_cache_memory_usage</code> has been exceeded. This is to protect hot caches
-from being emptied while Synapse is evicting due to memory.</li>
+from being emptied while Synapse is evicting due to memory. There is no default value for this option. </li>
</ul>
</li>
</ul>
|
