Repository navigation
Make the pages state what the std file tools do - #24
Conversation
The pages describe the `std` Pack, and the merged code of that Pack does more than two pages said about `StrReplace` and `Delete`. `tools-and-packs.md` said that a failure of `StrReplace` states how many times the text occurs, and it said nothing about the time between the two requests of `Delete`. The two pages now state each failure of `StrReplace`, the directory that `Delete` can remove, and the two issues that track the open gaps, and the diff changes no code. - `tools-and-packs.md` says that a failure of `StrReplace` states the count when the text occurs zero times, or more than once without `replace_all`. The count is of the occurrences that do not overlap, from the start of the file, and a call with `replace_all` replaces those. - The page says that a text that starts at more than one place does not occur once, even where the places overlap. When the count for such a text is one, a call without `replace_all` is refused, and that failure states no count. - The page says that `StrReplace` refuses an edit that would leave the file over 16 MiB, before it builds the edited text. - The page said that `Delete` asks what the path names before it asks for the removal. It now also says that the two are requests of their own, so a directory with no entries that another task puts at the path between them is removed, and that a directory with entries is never removed. cppalliance/runvil-plugin-std#3 tracks a removal in the contract that takes a file only. - The lost edit of `StrReplace` gets the link cppalliance/runvil-plugin-std#4 in `tools-and-packs.md` and in `files-and-the-vfs.md`. The words of `files-and-the-vfs.md` on the decision of the owner stay as they are. - The list of planned work in `tools-and-packs.md` gets two items that start with the word "Undecided": a removal that takes a file only, and an edit that keeps the change of another task. Each item ends with the sentence that the owner has yet to decide on it. - Each quote in the two pages is the same: 25 quoted strings in `tools-and-packs.md` and 43 in `files-and-the-vfs.md`, before and after. - The diff changes two Markdown files and adds no test.
|
Caution Review failedThe pull request is closed. Walkthrough
Merge Risk:
|
There was a problem hiding this comment.
🔵 Needs a closer look
The StrReplace overlap/count and preallocation-limit guarantees need confirmation against runvil-plugin-std at a806bf6, which is outside this checkout and unavailable through the provided tools.
No open issues 🎉
What changed in this PR
Updates two decision pages to reflect the merged std Pack’s file-tool behavior. This is documentation-only; no code changes.
Changes:
- Clarifies StrReplace’s occurrence counting, overlapping matches, and 16 MiB output limit.
- Documents Delete’s directory-removal race and links both known file-operation gaps to tracking issues.
- Adds explicitly undecided contract improvements for file-only removal and edits that preserve concurrent changes.
| File | Description |
|---|---|
decisions/tools-and-packs.md |
Clarifies file-tool behavior and records two undecided contract improvements. |
decisions/files-and-the-vfs.md |
Links the existing lost-edit gap to its tracking issue. |
Review effort: Balanced
The decision pages describe the
stdPack, and the review of cppalliance/runvil-plugin-std#2 changed a few things that the pages did not follow. This brings two pages back in line with the merged code. It changes two Markdown files underdecisions/and no code.What the pages say now
decisions/tools-and-packs.md, in the entry on thestdfile tools:replace_all, and the page now says so. The count is of the occurrences that do not overlap. A text that overlaps itself and counts as one, asanadoes inbanana, is refused withoutreplace_all, and that failure states no count.decisions/files-and-the-vfs.md:Two new items under Planned work
Both are in the "Undecided" form that the list already uses, and each ends with "The owner has yet to decide on it."
These two items were not asked for by name. Remove them if the list should hold decided work only.
Checks
decisions/tools-and-packs.mdanddecisions/files-and-the-vfs.mdchange. Nothing underplan/changes.tools-and-packs.mdand 43 infiles-and-the-vfs.md.node --test tools/docs-claims.mjspasses, 3 of 3. That tool does not readdecisions/, so the new text was compared with thestdcode ata806bf6by hand.stdandbashin the eight pages was compared with the merged code, and none was found false.Summary by CodeRabbit