summary refs log tree commit diff
path: root/synapse/config
diff options
context:
space:
mode:
authorMark Haines <mark.haines@matrix.org>2015-04-28 10:17:10 +0100
committerMark Haines <mark.haines@matrix.org>2015-04-28 10:17:10 +0100
commit0bc71103e16a774b53383365d461c7705e313a5b (patch)
tree554bae7d7ce95bbb24b3f23ec0f339ae481fb8fd /synapse/config
parentMerge pull request #132 from matrix-org/observer_and_locks (diff)
downloadsynapse-0bc71103e16a774b53383365d461c7705e313a5b.tar.xz
Output vim style mode markers into the yaml config file
Diffstat (limited to 'synapse/config')
-rw-r--r--synapse/config/_base.py7
1 files changed, 4 insertions, 3 deletions
diff --git a/synapse/config/_base.py b/synapse/config/_base.py
index 87cdbf1d30..6017cb6334 100644
--- a/synapse/config/_base.py
+++ b/synapse/config/_base.py
@@ -147,9 +147,10 @@ class Config(object):
                         and value is not None):
                     config[key] = value
             with open(config_args.config_path, "w") as config_file:
-                # TODO(paul) it would be lovely if we wrote out vim- and emacs-
-                #   style mode markers into the file, to hint to people that
-                #   this is a YAML file.
+                # TODO(mark/paul) We might want to output emacs-style mode
+                # markers as well as vim-style mode markers into the file,
+                # to further hint to people this is a YAML file.
+                config_file.write("# vim:ft=yaml\n")
                 yaml.dump(config, config_file, default_flow_style=False)
             print (
                 "A config file has been generated in %s for server name"