Add a comment about systemd-python. (#9464)

This confused me for a while.
matrix-org · Feb 23, 2021 · 713145d · 713145d
1 parent 65a9eb8
commit 713145d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/changelog.d/9464.misc b/changelog.d/9464.misc
@@ -0,0 +1 @@
+Add a comment about systemd-python.
diff --git a/synapse/python_dependencies.py b/synapse/python_dependencies.py
@@ -106,6 +106,9 @@
         "pysaml2>=4.5.0;python_version>='3.6'",
     ],
     "oidc": ["authlib>=0.14.0"],
+    # systemd-python is necessary for logging to the systemd journal via
+    # `systemd.journal.JournalHandler`, as is documented in
+    # `contrib/systemd/log_config.yaml`.
     "systemd": ["systemd-python>=231"],
     "url_preview": ["lxml>=3.5.0"],
     "sentry": ["sentry-sdk>=0.7.2"],