Repository navigation
docs: compatibility matrix, semantic deltas and release packaging (#5) - #35
Merged
Merged
Conversation
Twelve SD entries, each with a C snippet, a classification and the Rust tests that pin today's behaviour. SD-03, SD-06 and SD-12 are recorded as suspected regressions for adjudication in #15; no production code changes.
scripts/package-release.sh ships libmap2check.a (no features) and libmap2check_libfuzzer.a: the libfuzzer build references __map2check_main__ and does not link into a plain C program. CI runs scripts/test-package-release.sh, which links a C program against the unpacked archive. docs/release.md documents the steps; README points to the compatibility docs instead of a stale JSON sample.
… declarations (#5) cbindgen does not see the nondet_ffi!/overflow_ffi_* exports, so build.rs writes their C declarations by hand and tests/compat_docs.rs could not catch a Rust signature change. Also pins the byte-sized size argument of map2check_map_non_static_alloca (SD-12).
This was referenced Oct 15, 2026
…ds (#5) compat_docs is the first integration test that links the crate. With --features libfuzzer, LLVMFuzzerTestOneInput references __map2check_main__, whose stub in libfuzzer.rs is cfg(test)-only and absent when the crate is a dependency. cargo tarpaulin keeps dead code (-C link-dead-code), so the test binary failed to link in CI.
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
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.
Closes #5
Acceptance criteria
docs/api-deltas.mdwith a symbol/signature compatibility matrixinclude/map2check.h, exact declaration) and Map2Check pass matrixdocs/semantic-deltas.mdwith reproducible casesCHANGELOG.md,docs/integration-guide.md,docs/release.md,scripts/package-release.sh(tested in CI byscripts/test-package-release.sh)next_current_step,free_resolved_addresssemantics recorded), #14 (SD-01pending decision), #21 (pass matrixpending)Keeping the docs honest
tests/compat_docs.rsfails when:SD-NNentry points to a test that does not exist, or anSD-NNis cited but not defined;ffi_tests.rsalso pins the 17 macro-generated exports to the C declarations thatbuild.rswrites by hand, since cbindgen does not see them.Notes
.gitignoreand README.libmap2check.a(no features) andlibmap2check_libfuzzer.a. A--all-featuresbuild does not link into a plain C program (undefined reference to '__map2check_main__')."true","line","property": "NONE"on success). It now points to the checked examples in the guide.Suspected regressions (no code changed here; follow-up issues, differential check in #15)
map2check_check_free_resolved_addresstreats an untracked address as safe; legacy treats it as an invalid free.map2check_map_non_static_allocais reported as a memcleanup leak, andsizeis in bytes where legacy takes an element count.Verification
cargo fmt --check,cargo clippy --all-targets --all-features -- -D warnings,cargo test --all-features(146 unit, compat_docs 8, checklist 11, header_version 3),cargo test,scripts/test-branch-protection.sh,scripts/test-check-no-c-era-artifacts.sh,scripts/check-no-c-era-artifacts.shandscripts/test-package-release.shpass locally.scripts/coverage.shwas not run locally (cargo-tarpaulin not installed); CI runs it.