docs: correct BoxOptions::detach contract + restore two-side test rule#601
Merged
Conversation
- BoxOptions::detach: the old docstring undersold the contract. Detached boxes outlive the host process (clean exit, panic, SIGKILL), not just RuntimeImpl::Drop. Updated to state that explicitly, drop implementation details, and name the only two supported stop paths. - CLAUDE.md: restore the two-side verification protocol for reproducer tests. The "every test must reference a project symbol" replacement collapses the same idea into one bullet but loses the explicit revert/restore loop that catches tests which would stay green even if the fix never landed.
This was referenced May 27, 2026
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
1 participant
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
BoxOptions::detachdocstring to describe the actual contract: a detached box outlives the host process (clean exit, panic, SIGKILL), is reattachable viaruntime.get(box_id), and is stopped only byruntime.get(box_id).stop()orboxlite stop <id>. Drops the implementation specifics (setsid, recovery pipeline, PID 1) from public docs.Test plan
cargo doc -p boxlite --no-depsrenders the newBoxOptions::detachdocstring without warnings.setsid/pre_exec/PID 1/ "recovery pipeline" / "control socket" in the rendered doc.