mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2024-12-12 10:04:14 +02:00
Add instructions for building the coverage report.
These are intended to be temporary until a fully automated report is developed. Since we don't know when that will happen, at least make it easier to generate the current report.
This commit is contained in:
parent
da628be8a8
commit
e48b406cdc
77
doc/RELEASE.md
Normal file
77
doc/RELEASE.md
Normal file
@ -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:
|
||||||
|
```
|
||||||
|
<title>LCOV - all.lcov</title>
|
||||||
|
```
|
||||||
|
with:
|
||||||
|
```
|
||||||
|
<title>pgBackRest vX.XX C Code Coverage</title>
|
||||||
|
```
|
||||||
|
|
||||||
|
- In `doc/site/coverage` replace:
|
||||||
|
```
|
||||||
|
<tr><td class="title">LCOV - code coverage report</td></tr>
|
||||||
|
```
|
||||||
|
with:
|
||||||
|
```
|
||||||
|
<tr><td class="title">pgBackRest vX.XX C Code Coverage</td></tr>
|
||||||
|
```
|
||||||
|
|
||||||
|
- In `doc/site/coverage` replace:
|
||||||
|
```
|
||||||
|
<title>LCOV - all.lcov -
|
||||||
|
```
|
||||||
|
with:
|
||||||
|
```
|
||||||
|
<title>pgBackRest vX.XX C Code Coverage -
|
||||||
|
```
|
||||||
|
|
||||||
|
- In `doc/site/coverage` replace:
|
||||||
|
```
|
||||||
|
<td class="headerValue">all C unit</td>
|
||||||
|
```
|
||||||
|
with:
|
||||||
|
```
|
||||||
|
<td class="headerValue">all C unit</td>
|
||||||
|
```
|
||||||
|
|
||||||
|
- Switch to prior dir and copy coverage:
|
||||||
|
```
|
||||||
|
doc/site/prior/X.XX
|
||||||
|
cp -r ../../coverage .
|
||||||
|
```
|
@ -38,6 +38,14 @@
|
|||||||
</release-item>
|
</release-item>
|
||||||
</release-development-list>
|
</release-development-list>
|
||||||
</release-core-list>
|
</release-core-list>
|
||||||
|
|
||||||
|
<release-doc-list>
|
||||||
|
<release-development-list>
|
||||||
|
<release-item>
|
||||||
|
<p>Add instructions for building the coverage report.</p>
|
||||||
|
</release-item>
|
||||||
|
</release-development-list>
|
||||||
|
</release-doc-list>
|
||||||
</release>
|
</release>
|
||||||
|
|
||||||
<release date="2019-02-09" version="2.10" title="Bug Fixes">
|
<release date="2019-02-09" version="2.10" title="Bug Fixes">
|
||||||
|
Loading…
Reference in New Issue
Block a user