Name the write queue in the index of the directory that holds it - #480
Merged
Merged
Conversation
The header of `src/server/mod.rs` walks the directory one module at a time and gave nine of the ten modules registered below it a paragraph. `write_queue` had none, and neither the word queue, nor 0047, nor #47 appeared anywhere above the registrations. It now carries a paragraph in the same shape as the nine beside it, placed after `states` and before `federation`, saying which record it holds, what of that record is here, and that nothing is sent, nothing is acknowledged and no drain runs. What that prevents is an absence read as a decision. A reader who wants to know where a write to a server is held opens this directory, reads a walk that names nine modules, and concludes the queue is somewhere else or is not built. The module says of itself that it belongs here and that it drains on `recovery`, eight files outside `src/server/` already point a reader at it, one of them importing it at the top of a library file, and the coverage register pins it as a module the bar is measured over. The index was the one place disagreeing with all of them. The registration was added to this file by the commit that added the module, on 2026-08-30, and the header gained two further module paragraphs afterwards, so the file was opened twice more with the gap in it. Nothing else moves. No behaviour, signature, type, variant or registration, and the absences the neighbouring paragraphs state stay negative. Closes #479 Signed-off-by: Nils Lehnen <30603423+iderex@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The issue this belongs to
Closes #479
What changed
The header of
src/server/mod.rsgains one paragraph, forwrite_queue, in thesame shape as the nine beside it: which record it holds, what of that record is
here, and the absence it keeps. It is placed after
statesand beforefederation, where the module's own header says it sits, and it says thatnothing is sent, nothing is acknowledged and no drain runs, for the same reason
transportholds no socket.Nothing else moves. No behaviour, signature, type, variant or registration.
What failure it prevents
The directory's front page walked ten registered modules and named nine. A
reader who wants to know where a write to a server is held opens this directory,
reads a walk that names nine modules, and concludes the queue is somewhere else
or is not built. That is the direction that reads as covered: the answer is one
entry away, says of itself that it belongs here, and the index was the one place
in the tree not saying so.
It was found by deriving the header's module walk from the registrations below
it rather than by reading the prose.
Evidence
The commit being pushed:
What the header named, at the parent. The header is everything above the first
registration, and the count is per registered module rather than typed:
Not in any looser form either, and neither its record nor its issue:
The same derivation at this commit:
The module says where it belongs, at the parent:
and what it states as absent, which the new paragraph repeats rather than
softens:
The rest of the tree already points a reader at it, at the parent:
The dates. The registration was added by the commit that added the module, and
the header gained two further module paragraphs after that:
What the change is:
The two commands the gate runs, at this commit. The build was run first and
exited 0; its own summary line is not pasted, because this board's hygiene check
reads the word in it as a speed claim:
Four of this board's own legs, run on this machine at this commit:
What this does not cover
src/server/write_queue.rs. Read as evidence and not edited. It alreadysays where it belongs and what it does not do.
The header's opening sentence. It names the records 0027, 0028, 0029,
0037, 0038 and 0069 and the issues Build the HTTP transport, with timeouts, connection reuse and cancellation #27 through Implement the library query surface a client needs to show a first screen #39, and three modules in this
directory sit outside that,
federation,destinationsandwrite_queue.Each of the three is now reached by a paragraph naming its own record, and
whether that opening sentence should be widened is a separate reading about
what 0003 places where. It was not made here.
The delivery. Nothing in this tree opens a socket to send a queued write.
Build the HTTP transport, with timeouts, connection reuse and cancellation #27 and Decide what creating and stopping the core means, including a host that suspends it #115 are open and nothing is claimed about when either lands.
0047 and 0003. Both records are read and neither is edited. A record is
added or superseded rather than edited in place, which
docs/decisions/0001-decision-records.mdfixes.The other directory indexes. Whether another
mod.rsheader in this treeleaves out a module it registers is a separate reading and was not made here.
Behaviour. No production line changes. The whole diff is doc comments.
A check that would refuse this. Nothing in this tree reads a module header
against the registrations below it, and the document check reads only
.mdfiles. This adds no rule, so the next gap of this shape is caught by a reader
or not at all.
The shell analysis. It was not run on this machine, because the analyser
is not on this machine's path:
What the run on this pull request reports is the reading, and nothing is
claimed for it from here. This change touches no shell file.
Who has read it
Nobody other than the author. There is no second reader on this board tonight,
and the readings pasted above stand in place of one rather than a review having
happened.