summary refs log tree commit diff
path: root/develop/usage/configuration/config_documentation.html
diff options
context:
space:
mode:
authorDMRobertson <DMRobertson@users.noreply.github.com>2022-08-09 10:31:05 +0000
committerDMRobertson <DMRobertson@users.noreply.github.com>2022-08-09 10:31:05 +0000
commit92f6ed0a4f8fc12b7d36bc81b90d64484339fade (patch)
treeae5572ae5b37ba49a77e3c5373ed396093d66740 /develop/usage/configuration/config_documentation.html
parentdeploy: 3d2cabf9669e27016e6c062313709e88a50697bb (diff)
downloadsynapse-92f6ed0a4f8fc12b7d36bc81b90d64484339fade.tar.xz
deploy: 70d3e7000910f0171f43fb4d2450121eea1214c7
Diffstat (limited to '')
-rw-r--r--develop/usage/configuration/config_documentation.html11
1 files changed, 6 insertions, 5 deletions
diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html
index f2c43e032d..148eda5d9b 100644
--- a/develop/usage/configuration/config_documentation.html
+++ b/develop/usage/configuration/config_documentation.html
@@ -1000,20 +1000,20 @@ on this homeserver.</p>
 </code></pre>
 <hr />
 <h2 id="caching"><a class="header" href="#caching">Caching</a></h2>
-<p>Options related to caching</p>
+<p>Options related to caching.</p>
 <hr />
 <h3 id="event_cache_size"><a class="header" href="#event_cache_size"><code>event_cache_size</code></a></h3>
 <p>The number of events to cache in memory. Not affected by
-<code>caches.global_factor</code>. Defaults to 10K.</p>
+<code>caches.global_factor</code> and is not part of the <code>caches</code> section. Defaults to 10K.</p>
 <p>Example configuration:</p>
 <pre><code class="language-yaml">event_cache_size: 15K
 </code></pre>
 <hr />
-<h3 id="cache-and-associated-values"><a class="header" href="#cache-and-associated-values"><code>cache</code> and associated values</a></h3>
+<h3 id="caches-and-associated-values"><a class="header" href="#caches-and-associated-values"><code>caches</code> and associated values</a></h3>
 <p>A cache 'factor' is a multiplier that can be applied to each of
 Synapse's caches in order to increase or decrease the maximum
 number of entries that can be stored.</p>
-<p>Caching can be configured through the following sub-options:</p>
+<p><code>caches</code> can be configured through the following sub-options:</p>
 <ul>
 <li>
 <p><code>global_factor</code>: Controls the global cache factor, which is the default cache factor
@@ -1078,7 +1078,8 @@ from being emptied while Synapse is evicting due to memory. There is no default
 </li>
 </ul>
 <p>Example configuration:</p>
-<pre><code class="language-yaml">caches:
+<pre><code class="language-yaml">event_cache_size: 15K
+caches:
   global_factor: 1.0
   per_cache_factors:
     get_users_who_share_room_with_user: 2.0