diff options
| author | lukasdenk <63459921+lukasdenk@users.noreply.github.com> | 2022-02-28 12:42:13 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-28 11:42:13 +0000 |
| commit | ab3ef49059e465198754a3d818d1f3b21771f5ef (patch) | |
| tree | e16c94f8443ac1bb512e8327c04fa66a8dc70e6c | |
| parent | Ensure that `get_datastores().main` is typed (#12070) (diff) | |
| download | synapse-ab3ef49059e465198754a3d818d1f3b21771f5ef.tar.xz | |
synctl: print warning if synctl_cache_factor is set in config (#11865)
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
| -rw-r--r-- | changelog.d/11865.removal | 1 | ||||
| -rwxr-xr-x | synctl | 8 |
2 files changed, 9 insertions, 0 deletions
diff --git a/changelog.d/11865.removal b/changelog.d/11865.removal new file mode 100644 index 0000000000..9fcabfc720 --- /dev/null +++ b/changelog.d/11865.removal @@ -0,0 +1 @@ +Deprecate using `synctl` with the config option `synctl_cache_factor` and print a warning if a user still uses this option. diff --git a/synctl b/synctl index 0e54f4847b..1ab36949c7 100755 --- a/synctl +++ b/synctl @@ -37,6 +37,13 @@ YELLOW = "\x1b[1;33m" RED = "\x1b[1;31m" NORMAL = "\x1b[m" +SYNCTL_CACHE_FACTOR_WARNING = """\ +Setting 'synctl_cache_factor' in the config is deprecated. Instead, please do +one of the following: + - Either set the environment variable 'SYNAPSE_CACHE_FACTOR' + - or set 'caches.global_factor' in the homeserver config. +--------------------------------------------------------------------------------""" + def pid_running(pid): try: @@ -228,6 +235,7 @@ def main(): start_stop_synapse = True if cache_factor: + write(SYNCTL_CACHE_FACTOR_WARNING) os.environ["SYNAPSE_CACHE_FACTOR"] = str(cache_factor) cache_factors = config.get("synctl_cache_factors", {}) |