This repository was archived by the owner on Oct 3, 2026. It is now read-only.
Repository navigation
docs: fix stale hot-commit claim and mount-type examples - #49
Merged
Merged
Conversation
- CLAUDE.md "Commit Quiesce Contract": removed the false claim that hot commit "requires a qemubox-side protocol that does not exist yet; until then it fails loudly by design". Hot commit IS implemented: a paused + FIFREEZE'd guest commits via the containerd.io/snapshot/erofs.quiesced label, which mounts rwlayer.img ro,norecovery without the OFD lock gate. Now matches internal/snapshotter/doc.go. - README: fsmeta mounts with device= options are multi-device EROFS, so the examples must use Type "format/erofs", not "erofs" (the documented VM-only signal). Fixed the VMDK view and the active-writable examples. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Documentation correctness fixes. No code changes.
CLAUDE.md — false "hot commit doesn't exist" claim
The Commit Quiesce Contract said:
That is factually wrong now — hot commit is implemented, and
internal/snapshotter/doc.goalready describes it correctly. (This matters extra because CLAUDE.md is read every session.) Rewrote the section: cold commit requires stopped; hot commit is supported via thecontainerd.io/snapshot/erofs.quiescedlabel set by a runtime that paused the VM and FIFREEZE'd its filesystems — the snapshotter then mountsrwlayer.imgro,norecoverywithout the OFD lock gate.README — wrong mount type for multi-device EROFS
Two examples showed
Type: "erofs"for an fsmeta mount that hasdevice=options. Per the documented rule (and the code), fsmeta +device=is multi-device →format/erofs(the VM-only signal). Fixed the VMDK view example and the active-writable example.Verified:
internal/snapshotter/doc.gowas already correct (an earlier audit pass wrongly flagged it) — left untouched.🤖 Generated with Claude Code