Documentation
¶
Overview ¶
Command bugledger generates the public bug fix ledger from the project's ground truth: the commit history since the previous release, the "Fixed" sections of CHANGELOG.md and changelog.d, and the divergence records that mark a Pi defect fixed ahead of Pi.
`make bug-ledger` writes docs/bug-ledger.json and docs/site/docs/bug-ledger.md. `make bug-ledger-check` (-check) fails when they are out of date, when a recorded test no longer exists, or when a fix-titled commit that changes shipped code has no entry. The ledger needs the full history; a shallow clone fails with a message that says so.
-notes <version> prints the draft release notes for a version from the same sources.
A fix-titled commit that is not a product bug is listed with a category and a reason in automation/ci/bugledger/exempt.txt, or carries a "Bug-Ledger: exempt <category>: <reason>" trailer. A follow-up commit of an existing fix carries "Bug-Ledger: see <commit>".