Skip to content

docs: add the raw lcov coverage report contract - #53

Merged
walterjgsp merged 1 commit into
mainfrom
docs/coverage-lcov-contract
Oct 3, 2026
Merged

walterjgsp merged 1 commit into
mainfrom
docs/coverage-lcov-contract

Conversation

@walterjgsp

Copy link
Copy Markdown
Contributor

Summary

Phase 3 of #46, the consumer contract. docs/coverage-lcov.md documents, for any consumer (an annotated source view, a dashboard such as Veritas):

  • where each test rule keeps its raw lcov report (plz-out/bin/<package>/<target>.lcov) and its lifetime (only under plz cover, last executed run, not recreated from a cached result);
  • the lcov records used, and what each rule set provides (real or 0/1 counts, functions, real, anonymous or synthesized branches);
  • how to classify a line as covered, uncovered, partial or not executable, and how to merge reports (and why not to compare arm numbers across tools);
  • the reference implementation, tools/common/lcov.

Linked from docs/README.md. Docs only; the Veritas side is not part of this repository.

Test plan

🤖 Generated with Claude Code

Document where each test rule keeps its raw lcov report, the format, what each rule set provides, how to classify covered, uncovered and partly covered lines, and how to read and merge the files. Phase 3 of #46 (the contract; the consumer lives in Veritas).

Refs #46

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@walterjgsp
walterjgsp merged commit 8c54e0e into main Oct 3, 2026
3 checks passed
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