From f212d36727290fa559994913520905f6e28dfa76 Mon Sep 17 00:00:00 2001 From: "H. Shay" Date: Tue, 3 May 2022 13:33:23 -0700 Subject: [PATCH 1/4] add where info about tcp replication module can be found --- changelog.d/12621.doc | 2 ++ docs/replication.md | 5 +++++ synapse/replication/tcp/__init__.py | 2 +- 3 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 changelog.d/12621.doc diff --git a/changelog.d/12621.doc b/changelog.d/12621.doc new file mode 100644 index 000000000000..59d8e47a308f --- /dev/null +++ b/changelog.d/12621.doc @@ -0,0 +1,2 @@ +Add information about the TCP replication module to docs. + diff --git a/docs/replication.md b/docs/replication.md index e82df0de8a30..108da9a065d8 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 1fa60af8e6bc..2c5f5f0bf867 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: From b83180e2829e94c7a330285a455fe1182cfcd332 Mon Sep 17 00:00:00 2001 From: "H. Shay" Date: Tue, 3 May 2022 13:41:23 -0700 Subject: [PATCH 2/4] fix newsfragment --- changelog.d/12621.doc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/changelog.d/12621.doc b/changelog.d/12621.doc index 59d8e47a308f..1610abaa481e 100644 --- a/changelog.d/12621.doc +++ b/changelog.d/12621.doc @@ -1,2 +1,3 @@ -Add information about the TCP replication module to docs. +Add information about the TCP replication module to docs. + From 335f9607f4e02e0ef4b9c6b4ee6d3c0ae0bd92a1 Mon Sep 17 00:00:00 2001 From: "H. Shay" Date: Fri, 6 May 2022 14:13:25 -0700 Subject: [PATCH 3/4] remove excess blank line --- changelog.d/12621.doc | 1 - 1 file changed, 1 deletion(-) diff --git a/changelog.d/12621.doc b/changelog.d/12621.doc index 1610abaa481e..758189146597 100644 --- a/changelog.d/12621.doc +++ b/changelog.d/12621.doc @@ -1,3 +1,2 @@ Add information about the TCP replication module to docs. - From 94a23d9b371dc4d33a835ace7759aa753cff85d2 Mon Sep 17 00:00:00 2001 From: Shay Date: Mon, 9 May 2022 13:58:30 -0700 Subject: [PATCH 4/4] Update 12621.doc --- changelog.d/12621.doc | 1 - 1 file changed, 1 deletion(-) diff --git a/changelog.d/12621.doc b/changelog.d/12621.doc index 758189146597..d29fb9cb995e 100644 --- a/changelog.d/12621.doc +++ b/changelog.d/12621.doc @@ -1,2 +1 @@ Add information about the TCP replication module to docs. -