From c63f1f3988fa3b76a21155998eb6f2bdf5e841ec Mon Sep 17 00:00:00 2001 From: Tristan Lins Date: Tue, 14 Apr 2020 15:14:04 +0200 Subject: [PATCH 1/3] Fixup media_storage_providers options comments Signed-off-by: Tristan Lins --- synapse/config/repository.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/synapse/config/repository.py b/synapse/config/repository.py index 7193ea11140d..9d2ce20220a4 100644 --- a/synapse/config/repository.py +++ b/synapse/config/repository.py @@ -224,12 +224,11 @@ def generate_config_section(self, data_dir_path, **kwargs): # #media_storage_providers: # - module: file_system - # # Whether to write new local files. + # # Whether to store newly uploaded local files # store_local: false - # # Whether to write new remote media + # # Whether to store newly downloaded remote files # store_remote: false - # # Whether to block upload requests waiting for write to this - # # provider to complete + # # Whether to wait for successful storage for local uploads # store_synchronous: false # config: # directory: /mnt/some/other/directory From 735a3c42e7fef8cdddeda2d2cf8f92baedcfedcc Mon Sep 17 00:00:00 2001 From: Tristan Lins Date: Tue, 14 Apr 2020 23:41:57 +0200 Subject: [PATCH 2/3] Update sample_config.yaml Signed-off-by: Tristan Lins --- docs/sample_config.yaml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 81dccbd99738..5ff1be4ebcc4 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -735,12 +735,11 @@ media_store_path: "DATADIR/media_store" # #media_storage_providers: # - module: file_system -# # Whether to write new local files. +# # Whether to store newly uploaded local files # store_local: false -# # Whether to write new remote media +# # Whether to store newly downloaded remote files # store_remote: false -# # Whether to block upload requests waiting for write to this -# # provider to complete +# # Whether to wait for successful storage for local uploads # store_synchronous: false # config: # directory: /mnt/some/other/directory From 9176a293382effc063ff379384eee67e08f71870 Mon Sep 17 00:00:00 2001 From: Tristan Lins Date: Thu, 16 Apr 2020 20:00:24 +0200 Subject: [PATCH 3/3] Added changelog for pr #7272 Signed-off-by: Tristan Lins --- changelog.d/7272.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/7272.doc diff --git a/changelog.d/7272.doc b/changelog.d/7272.doc new file mode 100644 index 000000000000..13a1ee340d46 --- /dev/null +++ b/changelog.d/7272.doc @@ -0,0 +1 @@ +Documentation of media_storage_providers options updated to avoid misunderstandings. Contributed by Tristan Lins. \ No newline at end of file