summary refs log tree commit diff
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2018-05-17 16:07:20 +0100
committerErik Johnston <erik@matrix.org>2018-05-17 16:07:20 +0100
commit12fd6d76888cbb79f9db472a0de47819111e5c0d (patch)
tree9e899d85c60604d60fbc32c8a0cca2d7fe1ac934
parentMake insert_* functions internal and reorder funcs (diff)
downloadsynapse-12fd6d76888cbb79f9db472a0de47819111e5c0d.tar.xz
Document case of unconnected chunks
-rw-r--r--synapse/storage/chunk_ordered_table.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/synapse/storage/chunk_ordered_table.py b/synapse/storage/chunk_ordered_table.py
index 4a56af759a..06257d66d8 100644
--- a/synapse/storage/chunk_ordered_table.py
+++ b/synapse/storage/chunk_ordered_table.py
@@ -38,6 +38,10 @@ class ChunkDBOrderedListStore(OrderedListStore):
     second chunk, then we say that the first chunk references the second, and
     thus forming a DAG.
 
+    The server may only have a subset of all events in a room, in which case
+    its possible for the server to have chunks that are unconnected from each
+    other. The ordering between unconnected chunks is arbitrary.
+
     The class is designed for use inside transactions and so takes a
     transaction object in the constructor. This means that it needs to be
     re-instantiated in each transaction, so all state needs to be stored