Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 70d3e70

Browse files
authored
Make the configuration for the cache clearer (#13481)
1 parent 0f95446 commit 70d3e70

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

changelog.d/13481.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Make the configuration for the cache clearer.

docs/usage/configuration/config_documentation.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1056,26 +1056,26 @@ allow_device_name_lookup_over_federation: true
10561056
---
10571057
## Caching ##
10581058

1059-
Options related to caching
1059+
Options related to caching.
10601060

10611061
---
10621062
### `event_cache_size`
10631063

10641064
The number of events to cache in memory. Not affected by
1065-
`caches.global_factor`. Defaults to 10K.
1065+
`caches.global_factor` and is not part of the `caches` section. Defaults to 10K.
10661066

10671067
Example configuration:
10681068
```yaml
10691069
event_cache_size: 15K
10701070
```
10711071
---
1072-
### `cache` and associated values
1072+
### `caches` and associated values
10731073

10741074
A cache 'factor' is a multiplier that can be applied to each of
10751075
Synapse's caches in order to increase or decrease the maximum
10761076
number of entries that can be stored.
10771077

1078-
Caching can be configured through the following sub-options:
1078+
`caches` can be configured through the following sub-options:
10791079

10801080
* `global_factor`: Controls the global cache factor, which is the default cache factor
10811081
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:
11371137

11381138
Example configuration:
11391139
```yaml
1140+
event_cache_size: 15K
11401141
caches:
11411142
global_factor: 1.0
11421143
per_cache_factors:

0 commit comments

Comments
 (0)