Skip to content

docs(streaming): bring the task ledger and the checkpoint contract up to what landed (#205, #206, #207) - #400

Merged
DrunkOnJava merged 2 commits into
mainfrom
docs/streaming-ledger
Oct 28, 2026
Merged

DrunkOnJava merged 2 commits into
mainfrom
docs/streaming-ledger

Conversation

@DrunkOnJava

@DrunkOnJava DrunkOnJava commented Oct 27, 2026 •

Copy link
Copy Markdown
Owner

Summary

Brings docs/streaming/task-ledger.md and the README's "Checkpoint contract" section up to what is on main, from the code and from the evidence files of a green Streaming E2E run; anything without a run or file behind it is marked NOT MEASURED. Documentation only.

Spec reference

None; no decoder changes. Refs #205, #206, #207 (they stay open: their remaining items are what the ledger now lists), and #209, #210, #211, #212 for their ledger rows.

Evidence: the required Streaming E2E job of run 40532346151 on main at e7c53e1, success, artifact streaming-evidence (one *-evidence.json per step). The same commit's ci.yml run is 40532346172.

Test plan

  • Every number was read from the artifact, not from earlier prose: walk-evidence.json (17 file cases, 5,835 records, each with legacy_parity true and the oracle "independent framing parse"), lz77-evidence.json (25 files, 266 pages, 6,097,392 bytes), map-evidence.json, sections-evidence.json, file-evidence.json, objects-evidence.json, r2007-evidence.json, r2007-objects-evidence.json, source-evidence.json, the four wasm*-evidence.json (all status: passed).
  • Checkpoint kinds, markers, CRC-32 trailers, restore(input, expected_source) signatures and size constants read from src/streaming/checkpoint.rs and r2007_checkpoint.rs: ten kinds (DWGH, DWGW, DWG4, DWGZ, DWGM, DWGS, DWGF, DWGO, DWGR, DWGQ); every restore checks marker, version, length and the CRC-32, and every one but DWGZ takes the expected source identity.
  • The manifests in tools/streaming/*-corpus.json (54 entries) name all 52 pinned drawings in tools/corpus/pins.tsv.
  • The committed ruleset (.github/rulesets/main-protection.json) has no bypass actor and the same twelve required checks as the live one; git worktree list --porcelain shows no prunable worktree.
  • python3 tools/ci/spec_coverage.py --check and python3 tools/maintainer/train/arch.py check: clean.
  • No code, no build.

What changed:

Left as it was, because it is still true: the per-walker sections of the README, the throughput table and the audit.md file.

Source-provenance declaration

By submitting this PR I certify that my contribution does not incorporate executable code from any source whose license is incompatible with Apache-2.0. Specifically:

  • No Autodesk DWG SDK source (RealDWG, ObjectARX, ObjectDBX) or NDA-protected Autodesk documentation was consulted or imported.
  • No Open Design Alliance Teigha / Drawings SDK source was consulted or imported. The ODA's public Open Design Specification for .dwg files PDF is explicitly allowed (see CLEANROOM.md).
  • No GPL-licensed DWG implementation source (LibreDWG, etc.) was consulted or imported. This matters because dwg-rs is Apache-2.0 and must remain compatible.

My contribution is based on:

  • The ODA's freely-redistributable Open Design Specification for .dwg files (v5.4.1);
  • Public reverse-engineering notes, research papers, or blog posts cited inline;
  • Reading algorithm-description comments (not executable code) in permissively-licensed projects (MIT / Apache / BSD) to resolve spec ambiguities — disclose any such reading in this PR body so it can be recorded in CLEANROOM.md.

See CLEANROOM.md for the full allowed/forbidden source list and the honest scope of what "clean-room" means for this project.

Developer Certificate of Origin

By submitting this PR, I certify that the contribution complies with the
Developer Certificate of Origin 1.1.
Specifically, I affirm that the contribution is my own work (or rightfully
licensed to me) and that it can be distributed under the project's Apache-2.0
license.

I will sign off commits with git commit -s when asked, which adds a
Signed-off-by trailer to the commit message asserting the DCO.

… to what landed (#205, #206, #207)

The ledger stopped at the header and the R13-R2000 walk, and the README's
checkpoint contract described the header checkpoint alone and said full object
and decompression checkpoints remain open. Both now cover the ten checkpoint
kinds on main and the walkers of #240, #246, #260, #276, #299, #312, #333, #340
and #363, the perf series #360 to #366, and cite the evidence files of Streaming
E2E run 40532346151. What was not measured is marked NOT MEASURED.
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-28T17:11:09.284031Z f16c8c7 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@DrunkOnJava
DrunkOnJava enabled auto-merge (squash) October 28, 2026 17:17
@DrunkOnJava
DrunkOnJava merged commit 9daa7ce into main Oct 28, 2026
24 checks passed
@DrunkOnJava
DrunkOnJava deleted the docs/streaming-ledger branch October 28, 2026 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant