fix: write qdocco outputs atomically - #43
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates qdocco to write generated HTML/Markdown outputs via an exclusive same-directory temporary file and a final rename step, aiming to avoid leaving partial documents on interruptions, and documents the contract in a new RFC.
Changes:
- Add RFC 0101 specifying
qdocco’s atomic output contract (temp file + sync + rename, collision handling). - Implement
write_output()inqdoccoto write via an exclusive temp file and rename into place, replacingfs::write. - Add a unit test for collision behavior and update project/RFC range references in docs.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/bin/qdocco.rs | Implements atomic-ish output writing via exclusive temp file + sync + rename, and adds a collision test. |
| RFCs/0101-qdocco-atomic-output.md | Defines the new atomic output contract for qdocco. |
| RFCs/0000-project-scope.md | Updates the documented RFC coverage range to include RFC 0101. |
| README.md | Updates the README’s referenced RFC range to include RFC 0101. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
tiye
force-pushed
the
fix/lexer-comment-heredoc-boundary
branch
from
August 23, 2026 04:56
86a7131 to
8feb547
Compare
Base automatically changed from
fix/lexer-comment-heredoc-boundary
to
feat/program-fingerprint
August 23, 2026 04:57
tiye
force-pushed
the
fix/qdocco-atomic-output
branch
from
August 23, 2026 05:00
2e28e70 to
7f60b2e
Compare
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.
Summary
Validation
make checkgit diff --checkThis PR is intentionally stacked on PR #42 and should not be merged independently of the chain.