Skip to content

Harden v0.2.0: bug fixes, docs, and sources→transform rename - #6

Merged
stmcgovern merged 2 commits into
mainfrom
docs-and-hardening
May 29, 2026
Merged

stmcgovern merged 2 commits into
mainfrom
docs-and-hardening

Conversation

@stmcgovern

Copy link
Copy Markdown
Collaborator

Summary

  • Bug fixes: jsonEscape control char handling, output-dir path escape (SmallVector self-reference crash), Reporter sort determinism (old_text tiebreaker)
  • Config rename: sources field → transform — reads as "what to transform," works for incremental migration
  • Docs rewrite: user-guide.md, README.md, CLAUDE.md updated for v0.2.0 features (plan mode, --jobs, --output-dir, transform field, .cuh support, migration progress tooling). Config-first workflow presented as default.
  • Demo walkthrough: new docs/demo-walkthrough.md — real-world case study analyzing vLLM (~50k lines of C++/CUDA)
  • Test: new output-dir-rewrite feature test

Test plan

  • ninja -C build -j30 builds clean
  • RESOURCE_DIR=/usr/lib/clang/19 bash test/run_tests.sh — 42/42 checks pass (14 rewrite, 14 verify, 4 exit code, 7 feature, 1 parallel, 1 macro body, 2 completeness)
  • output-dir-rewrite test passes (was crashing before the path fix)
  • Docs render correctly on GitHub

The 'transform' field makes incremental migration explicit: set
project_root for full include scope, list only the files to transform
in this run. Also adds input integrity guard to test suite and
updates docs for pytorch_root: auto.
Bug fixes:
- jsonEscape: handle control chars < 0x20 with \u00xx encoding
- output-dir: guard against path escape (leading separator after
  replace_path_prefix) and files outside project root
- Reporter: deterministic sort with old_text tiebreaker

Docs: rewrite user-guide.md, README.md, CLAUDE.md to present YAML
config as default workflow, document plan mode, --jobs, --output-dir,
transform field, .cuh support, and migration progress tooling.
@stmcgovern
stmcgovern merged commit 369e798 into main May 29, 2026
2 checks passed
@stmcgovern
stmcgovern deleted the docs-and-hardening branch May 29, 2026 15:29
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