diff options
| author | Shay <hillerys@element.io> | 2022-05-09 14:46:43 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-09 14:46:43 -0700 |
| commit | d80a7ab151afd6919b4e14a258105ab59146d528 (patch) | |
| tree | 8fbdbd7330035195f79f8dbf13ae91db8b285d40 | |
| parent | Update SQL statements in docs for Synapse Admins (#12536) (diff) | |
| download | synapse-d80a7ab151afd6919b4e14a258105ab59146d528.tar.xz | |
Update `replication.md` with info on TCP module structure (#12621)
| -rw-r--r-- | changelog.d/12621.doc | 1 | ||||
| -rw-r--r-- | docs/replication.md | 5 | ||||
| -rw-r--r-- | synapse/replication/tcp/__init__.py | 2 |
3 files changed, 7 insertions, 1 deletions
diff --git a/changelog.d/12621.doc b/changelog.d/12621.doc new file mode 100644 index 0000000000..d29fb9cb99 --- /dev/null +++ b/changelog.d/12621.doc @@ -0,0 +1 @@ +Add information about the TCP replication module to docs. diff --git a/docs/replication.md b/docs/replication.md index e82df0de8a..108da9a065 100644 --- a/docs/replication.md +++ b/docs/replication.md @@ -35,3 +35,8 @@ See [the TCP replication documentation](tcp_replication.md). There are read-only version of the synapse storage layer in `synapse/replication/slave/storage` that use the response of the replication API to invalidate their caches. + +### The TCP Replication Module +Information about how the tcp replication module is structured, including how +the classes interact, can be found in +`synapse/replication/tcp/__init__.py` diff --git a/synapse/replication/tcp/__init__.py b/synapse/replication/tcp/__init__.py index 1fa60af8e6..2c5f5f0bf8 100644 --- a/synapse/replication/tcp/__init__.py +++ b/synapse/replication/tcp/__init__.py @@ -15,7 +15,7 @@ """This module implements the TCP replication protocol used by synapse to communicate between the master process and its workers (when they're enabled). -Further details can be found in docs/tcp_replication.rst +Further details can be found in docs/tcp_replication.md Structure of the module: |