Skip to content

docs(log): the store writes run format v3, and Recovery.quarantined counts paths - #5

Merged
HaoZeke merged 2 commits into
mainfrom
fix/log-docs
Nov 16, 2026
Merged

HaoZeke merged 2 commits into
mainfrom
fix/log-docs

Conversation

@HaoZeke

@HaoZeke HaoZeke commented Nov 16, 2026

Copy link
Copy Markdown
Contributor

The store module doc now describes the run format the writer writes, v3, and Recovery::quarantined is documented as counting store paths that opening the store moved aside.

  • The module doc said the writer writes v2 runs in the format RUN_MAGIC describes; Run::encode_blocks writes RUN_MAGIC_V3, front-coded blocks of BLOCK_PAIRS pairs behind an index of first keys, counts and lengths, which the book's runs page already gives. The doc now describes v3 and keeps v2 and v1 as formats readers accept. A test reads the run a seal writes and pins the v3 magic.
  • The Recovery::quarantined field's doc called it the entries found beyond the checkpoint that could not be replayed, but recover reports the length of the data writer's quarantined list: the tile and bundle paths beyond the tree state that Writer::open moved to .state/torn-<utc>. A test leaves a bundle and a tile past the tree state and pins the count at two paths.

The branch has towncrier fragments.

The module doc said the writer writes v2 runs in the format RUN_MAGIC
describes; Run::encode_blocks writes RUN_MAGIC_V3, front-coded blocks of
BLOCK_PAIRS pairs behind an index of first keys, counts and lengths,
which the book's runs page already gives. The doc now describes v3 and
keeps v2 and v1 as formats readers accept. The code was right, so there
is no failing test; a test reads the run a seal writes through the store
and pins the v3 magic the doc now names.
The field's doc called it the entries found beyond the checkpoint that
could not be replayed, but recover reports the length of the data
writer's quarantined list: the tile and bundle paths beyond the tree
state that Writer::open moved to .state/torn-<utc>, as the book's runs
page says. The doc now says so. The code was right, so there is no
failing test; a test leaves a bundle and a tile past the tree state and
pins the count at two paths.
@HaoZeke
HaoZeke merged commit ad74550 into main Nov 16, 2026
6 checks passed
@HaoZeke
HaoZeke deleted the fix/log-docs branch November 16, 2026 05:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant