summary refs log tree commit diff
path: root/docs/usage
diff options
context:
space:
mode:
authorDirk Klimpel <5740567+dklimpel@users.noreply.github.com>2022-08-09 12:30:22 +0200
committerGitHub <noreply@github.com>2022-08-09 11:30:22 +0100
commit70d3e7000910f0171f43fb4d2450121eea1214c7 (patch)
tree66ad4ce724a620ecd87a87bff79e32c1397474c5 /docs/usage
parentUpdate matrix-synapse-ldap3 version in lockfile to v0.2.2. (#13470) (diff)
downloadsynapse-70d3e7000910f0171f43fb4d2450121eea1214c7.tar.xz
Make the configuration for the cache clearer (#13481)
Diffstat (limited to 'docs/usage')
-rw-r--r--docs/usage/configuration/config_documentation.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 3a9466a837..2af32a6155 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -1056,26 +1056,26 @@ allow_device_name_lookup_over_federation: true
 ---
 ## Caching ##
 
-Options related to caching
+Options related to caching.
 
 ---
 ### `event_cache_size`
 
 The number of events to cache in memory. Not affected by
-`caches.global_factor`. Defaults to 10K.
+`caches.global_factor` and is not part of the `caches` section. Defaults to 10K.
 
 Example configuration:
 ```yaml
 event_cache_size: 15K
 ```
 ---
-### `cache` and associated values
+### `caches` and associated values
 
 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.
 
-Caching can be configured through the following sub-options:
+`caches` can be configured through the following sub-options:
 
 * `global_factor`: Controls the global cache factor, which is the default cache factor
   for all caches if a specific factor for that cache is not otherwise
@@ -1137,6 +1137,7 @@ Caching can be configured through the following sub-options:
 
 Example configuration:
 ```yaml
+event_cache_size: 15K
 caches:
   global_factor: 1.0
   per_cache_factors: