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

Correct out-of-date doc for event_cache_size #13726

Merged
merged 2 commits into from
Sep 7, 2022
Merged

Correct out-of-date doc for event_cache_size #13726

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e581570
Correct out-of-date doc for `event_cache_size`
Sep 6, 2022
c5d2505
Changelog
Sep 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/13726.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix a mistake in the config manual: the `event_cache_size` _is_ scaled by `caches.global_factor`. The documentation was incorrect since Synapse 1.22.
6 changes: 4 additions & 2 deletions docs/usage/configuration/config_documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1069,8 +1069,10 @@ Options related to caching.
---
### `event_cache_size`

The number of events to cache in memory. Not affected by
`caches.global_factor` and is not part of the `caches` section. Defaults to 10K.
The number of events to cache in memory. Defaults to 10K. Like other caches,
this is affected by `caches.global_factor` (see below).

Note that this option is not part of the `caches` section.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😭

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not part of the caches section, but it is handled by synapse.config.cache (note: cache singular). It's all a bit muddled.


Example configuration:
```yaml
Expand Down