diff options
author | Shay <hillerys@element.io> | 2022-06-14 07:53:42 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-06-14 07:53:42 -0700 |
commit | 493c2fc44abcf3457953cc2f6f23509ff7855253 (patch) | |
tree | f429a75b187fdd0449bc1a460ce730b6d2b2ccd2 /synapse/config/background_updates.py | |
parent | Rename delta to apply in the proper schema version. (#13050) (diff) | |
download | synapse-493c2fc44abcf3457953cc2f6f23509ff7855253.tar.xz |
Remove code generating comments in configuration file (#12941)
Diffstat (limited to 'synapse/config/background_updates.py')
-rw-r--r-- | synapse/config/background_updates.py | 34 |
1 files changed, 0 insertions, 34 deletions
diff --git a/synapse/config/background_updates.py b/synapse/config/background_updates.py index 07fadbe041..1c6cd97de8 100644 --- a/synapse/config/background_updates.py +++ b/synapse/config/background_updates.py @@ -21,40 +21,6 @@ from ._base import Config class BackgroundUpdateConfig(Config): section = "background_updates" - def generate_config_section(self, **kwargs: Any) -> str: - return """\ - ## Background Updates ## - - # Background updates are database updates that are run in the background in batches. - # The duration, minimum batch size, default batch size, whether to sleep between batches and if so, how long to - # sleep can all be configured. This is helpful to speed up or slow down the updates. - # - background_updates: - # How long in milliseconds to run a batch of background updates for. Defaults to 100. Uncomment and set - # a time to change the default. - # - #background_update_duration_ms: 500 - - # Whether to sleep between updates. Defaults to True. Uncomment to change the default. - # - #sleep_enabled: false - - # If sleeping between updates, how long in milliseconds to sleep for. Defaults to 1000. Uncomment - # and set a duration to change the default. - # - #sleep_duration_ms: 300 - - # Minimum size a batch of background updates can be. Must be greater than 0. Defaults to 1. Uncomment and - # set a size to change the default. - # - #min_batch_size: 10 - - # The batch size to use for the first iteration of a new background update. The default is 100. - # Uncomment and set a size to change the default. - # - #default_batch_size: 50 - """ - def read_config(self, config: JsonDict, **kwargs: Any) -> None: bg_update_config = config.get("background_updates") or {} |