mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2025-01-06 03:53:59 +02:00
1bd5530a59
Double spaces have fallen out of favor in recent years because they no longer contribute to readability. We have been using single spaces and editing related paragraphs for some time, but now it seems best to update the remaining instances to avoid churn in unrelated commits and to make it clearer what spacing contributors should use.
32 lines
1.5 KiB
XML
32 lines
1.5 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE doc SYSTEM "doc.dtd" [<!ENTITY metricCoverageReport SYSTEM "auto/metric-coverage-report.auto.xml">]>
|
|
<doc title="{[project]}" subtitle="Metrics">
|
|
<description>{[project]} project metrics.</description>
|
|
|
|
<!-- ======================================================================================================================= -->
|
|
<section id="code-coverage">
|
|
<title>Code Coverage</title>
|
|
|
|
<p><backrest/> aims to have complete function/branch/line coverage for the core C code in <path>/src</path>.</p>
|
|
|
|
<p>Function/line coverage is complete with no exceptions.</p>
|
|
|
|
<p>Branch coverage excludes branches inside macros and <code>assert()</code> calls. Macros have their own unit tests so they do not need to be tested everywhere they appear. Asserts are not expected to have complete branch coverage since they test cases that should always be true.</p>
|
|
|
|
<table>
|
|
<table-header>
|
|
<table-column fill="y">Directory</table-column>
|
|
<table-column align="right">Functions</table-column>
|
|
<table-column align="right">Branches</table-column>
|
|
<table-column align="right">Lines</table-column>
|
|
</table-header>
|
|
|
|
<table-data>
|
|
&metricCoverageReport;
|
|
</table-data>
|
|
</table>
|
|
|
|
<p>The C unit test modules in <path>/test/src/module</path> also have complete function/line coverage but are not included in the report.</p>
|
|
</section>
|
|
</doc>
|