Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 4eb7796

Browse files
Update backward extremity docs to make it clear that it does not indicate whether we have fetched an events' prev_events (#11469)
Spawning from #9445 (comment) Co-authored-by: Richard van der Hoff <[email protected]>
1 parent 637df95 commit 4eb7796

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

changelog.d/11469.doc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update section about backward extremities in the room DAG concepts doc to correct the misconception about backward extremities indicating whether we have fetched an events' `prev_events`.

docs/development/room-dag-concepts.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,15 @@ Most-recent-in-time events in the DAG which are not referenced by any other even
3838
The forward extremities of a room are used as the `prev_events` when the next event is sent.
3939

4040

41-
## Backwards extremity
41+
## Backward extremity
4242

4343
The current marker of where we have backfilled up to and will generally be the
44-
oldest-in-time events we know of in the DAG.
44+
`prev_events` of the oldest-in-time events we have in the DAG. This gives a starting point when
45+
backfilling history.
4546

46-
This is an event where we haven't fetched all of the `prev_events` for.
47-
48-
Once we have fetched all of its `prev_events`, it's unmarked as a backwards
49-
extremity (although we may have formed new backwards extremities from the prev
50-
events during the backfilling process).
47+
When we persist a non-outlier event, we clear it as a backward extremity and set
48+
all of its `prev_events` as the new backward extremities if they aren't already
49+
persisted in the `events` table.
5150

5251

5352
## Outliers
@@ -56,8 +55,7 @@ We mark an event as an `outlier` when we haven't figured out the state for the
5655
room at that point in the DAG yet.
5756

5857
We won't *necessarily* have the `prev_events` of an `outlier` in the database,
59-
but it's entirely possible that we *might*. The status of whether we have all of
60-
the `prev_events` is marked as a [backwards extremity](#backwards-extremity).
58+
but it's entirely possible that we *might*.
6159

6260
For example, when we fetch the event auth chain or state for a given event, we
6361
mark all of those claimed auth events as outliers because we haven't done the

0 commit comments

Comments
 (0)