summary refs log tree commit diff
path: root/develop/development
diff options
context:
space:
mode:
Diffstat (limited to 'develop/development')
-rw-r--r--develop/development/git.html6
-rw-r--r--develop/development/synapse_architecture/streams.html6
2 files changed, 6 insertions, 6 deletions
diff --git a/develop/development/git.html b/develop/development/git.html

index cd675a4207..854bb64b23 100644 --- a/develop/development/git.html +++ b/develop/development/git.html
@@ -168,10 +168,10 @@ before. Here, by way of an arbitrary example, is the top of <code>git log --grap <p>Note how the commit comment explains clearly what is changing and why. Also note the <em>absence</em> of merge commits, as well as the absence of commits called things like (to pick a few culprits): -<a href="https://github.com/element.-hq/synapse/commit/84691da6c">“pep8”</a>, <a href="https://github.com/element.-hq/synapse/commit/474810d9d">“fix broken +<a href="https://github.com/element-hq/synapse/commit/84691da6c">“pep8”</a>, <a href="https://github.com/element-hq/synapse/commit/474810d9d">“fix broken test”</a>, -<a href="https://github.com/element.-hq/synapse/commit/c9d72e457">“oops”</a>, -<a href="https://github.com/element.-hq/synapse/commit/836358823">“typo”</a>, or <a href="https://github.com/element.-hq/synapse/commit/707374d5d">“Who's +<a href="https://github.com/element-hq/synapse/commit/c9d72e457">“oops”</a>, +<a href="https://github.com/element-hq/synapse/commit/836358823">“typo”</a>, or <a href="https://github.com/element-hq/synapse/commit/707374d5d">“Who's the president?”</a>.</p> <p>There are a number of reasons why keeping a clean commit history is a good thing:</p> diff --git a/develop/development/synapse_architecture/streams.html b/develop/development/synapse_architecture/streams.html
index 485b50dbab..9b8fb5f8b7 100644 --- a/develop/development/synapse_architecture/streams.html +++ b/develop/development/synapse_architecture/streams.html
@@ -160,7 +160,7 @@ </div> <h2 id="streams"><a class="header" href="#streams">Streams</a></h2> -<p>Synapse has a concept of &quot;streams&quot;, which are roughly described in <a href="https://github.com/element.-hq/synapse/blob/develop/synapse/storage/util/id_generators.py"><code>id_generators.py</code></a>. +<p>Synapse has a concept of &quot;streams&quot;, which are roughly described in <a href="https://github.com/element-hq/synapse/blob/develop/synapse/storage/util/id_generators.py"><code>id_generators.py</code></a>. Generally speaking, streams are a series of notifications that something in Synapse's database has changed that the application might need to respond to. For example:</p> <ul> @@ -168,9 +168,9 @@ For example:</p> <li>The account data stream reports changes to users' <a href="https://spec.matrix.org/v1.7/client-server-api/#client-config">account data</a>.</li> <li>The to-device stream reports when a device has a new <a href="https://spec.matrix.org/v1.7/client-server-api/#send-to-device-messaging">to-device message</a>.</li> </ul> -<p>See <a href="https://github.com/element.-hq/synapse/blob/develop/synapse/replication/tcp/streams/__init__.py"><code>synapse.replication.tcp.streams</code></a> for the full list of streams.</p> +<p>See <a href="https://github.com/element-hq/synapse/blob/develop/synapse/replication/tcp/streams/__init__.py"><code>synapse.replication.tcp.streams</code></a> for the full list of streams.</p> <p>It is very helpful to understand the streams mechanism when working on any part of Synapse that needs to respond to changes—especially if those changes are made by different workers. -To that end, let's describe streams formally, paraphrasing from the docstring of <a href="https://github.com/element.-hq/synapse/blob/a719b703d9bd0dade2565ddcad0e2f3a7a9d4c37/synapse/storage/util/id_generators.py#L96"><code>AbstractStreamIdGenerator</code></a>.</p> +To that end, let's describe streams formally, paraphrasing from the docstring of <a href="https://github.com/element-hq/synapse/blob/a719b703d9bd0dade2565ddcad0e2f3a7a9d4c37/synapse/storage/util/id_generators.py#L96"><code>AbstractStreamIdGenerator</code></a>.</p> <h3 id="definition"><a class="header" href="#definition">Definition</a></h3> <p>A stream is an append-only log <code>T1, T2, ..., Tn, ...</code> of facts<sup class="footnote-reference"><a href="#1">1</a></sup> which grows over time. Only &quot;writers&quot; can add facts to a stream, and there may be multiple writers.</p>