OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Fix and clarify config comments

pull/6391/head
Andrew Morgan 2020-05-01 19:43:31 +01:00
parent 485f17737b
commit fe890508cc
2 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/sample_config.yaml
View File

@ -1980,13 +1980,17 @@ opentracing:
# Caching can be configured through the following options. # Caching can be configured through the following options.
# #
caches: caches:
# Controls the global cache factor. This overrides the "SYNAPSE_CACHE_FACTOR" # Controls the global cache factor. This can be overridden by the
# environment variable. # "SYNAPSE_CACHE_FACTOR" environment variable.
# #
# global_factor: 0.5 # global_factor: 0.5
# A dictionary of cache name to cache factor for that # A dictionary of cache name to cache factor for that individual
# individual cache. # cache. This can be overridden by environment variables
# comprised of "SYNAPSE_CACHE_FACTOR_" + the name of the cache in
# capital letters and underscores.
#
# Ex. SYNAPSE_CACHE_FACTOR_GET_USERS_WHO_SHARE_ROOM_WITH_USER=2
# #
# per_cache_factors: # per_cache_factors:
# get_users_who_share_room_with_user: 2 # get_users_who_share_room_with_user: 2

12
synapse/config/cache.py
View File

@ -75,13 +75,17 @@ class CacheConfig(Config):
# Caching can be configured through the following options. # Caching can be configured through the following options.
# #
caches: caches:
# Controls the global cache factor. This overrides the "SYNAPSE_CACHE_FACTOR" # Controls the global cache factor. This can be overridden by the
# environment variable. # "SYNAPSE_CACHE_FACTOR" environment variable.
# #
# global_factor: 0.5 # global_factor: 0.5
# A dictionary of cache name to cache factor for that # A dictionary of cache name to cache factor for that individual
# individual cache. # cache. This can be overridden by environment variables
# comprised of "SYNAPSE_CACHE_FACTOR_" + the name of the cache in
# capital letters and underscores.
#
# Ex. SYNAPSE_CACHE_FACTOR_GET_USERS_WHO_SHARE_ROOM_WITH_USER=2
# #
# per_cache_factors: # per_cache_factors:
# get_users_who_share_room_with_user: 2 # get_users_who_share_room_with_user: 2