kaslo/synapse
1
0
Fork 0
Code Packages Releases 124 Wiki Activity

Document config file merge behavior (#18664)

Browse Source 
Explains in the doc comment of `synapse.config._base.read_config_file`
how config files are merged.
This commit is contained in:
V02460
2025-07-11 12:15:12 +02:00
committed by GitHub
parent 28c9ed3ccb
commit c5999cf452
2 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/18664.misc Normal file
View File

@@ -0,0 +1 @@
Add doc comment explaining that config files are shallowly merged.

5
synapse/config/_base.py
View File

@@ -909,7 +909,10 @@ class RootConfig:
def read_config_files(config_files: Iterable[str]) -> Dict[str, Any]:
"""Read the config files into a dict
"""Read the config files and shallowly merge them into a dict.
Successive configurations are shallowly merged into ones provided earlier,
i.e., entirely replacing top-level sections of the configuration.
Args:
config_files: A list of the config files to read