From 306ba25c38f864280c9f78a06816d713f1113416 Mon Sep 17 00:00:00 2001 From: erikjohnston Date: Wed, 13 Dec 2023 16:39:14 +0000 Subject: deploy: 930dc9e2d3efd6d82b86c2205b80d6ccb9b4bb86 --- develop/development/git.html | 6 +++--- develop/development/synapse_architecture/streams.html | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) (limited to 'develop/development') 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 git log --grap

Note how the commit comment explains clearly what is changing and why. Also note the absence of merge commits, as well as the absence of commits called things like (to pick a few culprits): -“pep8”, “fix broken +“pep8”, “fix broken test”, -“oops”, -“typo”, or “Who's +“oops”, +“typo”, or “Who's the president?”.

There are a number of reasons why keeping a clean commit history is a good thing:

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 @@

Streams

-

Synapse has a concept of "streams", which are roughly described in id_generators.py. +

Synapse has a concept of "streams", which are roughly described in id_generators.py. 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:

-

See synapse.replication.tcp.streams for the full list of streams.

+

See synapse.replication.tcp.streams for the full list of streams.

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 AbstractStreamIdGenerator.

+To that end, let's describe streams formally, paraphrasing from the docstring of AbstractStreamIdGenerator.

Definition

A stream is an append-only log T1, T2, ..., Tn, ... of facts1 which grows over time. Only "writers" can add facts to a stream, and there may be multiple writers.

-- cgit 1.5.1