diff --git a/doc/RELEASE.md b/doc/RELEASE.md new file mode 100644 index 000000000..988169cee --- /dev/null +++ b/doc/RELEASE.md @@ -0,0 +1,77 @@ +# Release Build Instructions + +## Generate Coverage Report + +These instructions are temporary until a fully automated report is implemented. + +- In `test/src/lcov.conf` remove: +``` + # Specify the regular expression of lines to exclude + lcov_excl_line=\{\+*uncovered|\{\+*uncoverable + + # Coverage rate limits + genhtml_hi_limit = 100 + genhtml_med_limit = 90 +``` + +- In `test/lib/pgBackRestTest/Common/JobTest.pm` modify: +``` +if (!$bTest || $iTotalLines != $iCoveredLines || $iTotalBranches != $iCoveredBranches) +``` +to: +``` +if (!$bTest) +``` + +- Run: +``` +/backrest/test/test.pl --dev-test --vm=u18 --c-only +``` + +- Copy coverage report: +``` +cd doc/site +cp -r ../../test/coverage/c coverage +``` + +- In `doc/site/coverage` replace: +``` +
Add instructions for building the coverage report.
+