From b70fdcd50698f4d4c697da4ca8a9403b26ff8cae Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?L=C3=A9o=20Gaspard?= <leo@gaspard.io>
Date: Mon, 5 Oct 2020 23:35:28 +0200
Subject: [PATCH] matrix-synapse module: fix documentation and add release
 notes (#99564)

(cherry picked from commit e0c48efc170866a8889b6b758aac10e6d04a4d9b)
---
 nixos/doc/manual/release-notes/rl-2009.xml     | 5 +++++
 nixos/modules/services/misc/matrix-synapse.nix | 7 ++++++-
 2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/nixos/doc/manual/release-notes/rl-2009.xml b/nixos/doc/manual/release-notes/rl-2009.xml
index f19203e9fb27..ed3032637c71 100644
--- a/nixos/doc/manual/release-notes/rl-2009.xml
+++ b/nixos/doc/manual/release-notes/rl-2009.xml
@@ -568,6 +568,11 @@ systemd.services.mysql.serviceConfig.ReadWritePaths = [ "/var/data" ];
   </para>
 
   <itemizedlist>
+   <listitem>
+    <para>
+     The <link linkend="opt-services.matrix-synapse.enable">matrix-synapse</link> module no longer includes optional dependencies by default, they have to be added through the <link linkend="opt-services.matrix-synapse.plugins">plugins</link> option.
+    </para>
+   </listitem>
    <listitem>
     <para>
      <literal>buildGoModule</literal> now internally creates a vendor directory
diff --git a/nixos/modules/services/misc/matrix-synapse.nix b/nixos/modules/services/misc/matrix-synapse.nix
index 3eb1073387fe..7f42184735c8 100644
--- a/nixos/modules/services/misc/matrix-synapse.nix
+++ b/nixos/modules/services/misc/matrix-synapse.nix
@@ -131,7 +131,12 @@ in {
       plugins = mkOption {
         type = types.listOf types.package;
         default = [ ];
-        defaultText = "with config.services.matrix-synapse.package.plugins [ matrix-synapse-ldap3 matrix-synapse-pam ]";
+        example = literalExample ''
+          with config.services.matrix-synapse.package.plugins; [
+            matrix-synapse-ldap3
+            matrix-synapse-pam
+          ];
+        '';
         description = ''
           List of additional Matrix plugins to make available.
         '';