1berry/postgres
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc: improve explanation of how to use our code coverage infrastructure.

Browse Source 
The reference to running "make coverage" in a subdirectory was a
bit obscure, so clarify what happens when you do that.  Do a little
desultory copy-editing, too.

Per a question from Peter Smith.

Discussion: https://postgr.es/m/CAHut+Pu0r3AjRSyu5E0v2-zRj8r24OSrkWs3fEBxOuaw1i8DKA@mail.gmail.com
This commit is contained in:
Tom Lane 2020-10-27 14:31:12 -04:00
parent 8e5d1aef8e
commit 8d132b2850
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/src/sgml/regress.sgml
View File

@ -806,12 +806,12 @@ make check PROVE_TESTS='t/001_test1.pl t/003_test3.pl'
instrumentation, so that it becomes possible to examine which
parts of the code are covered by the regression tests or any other
test suite that is run with the code. This is currently supported
when compiling with GCC and requires the <command>gcov</command>
when compiling with GCC, and it requires the <command>gcov</command>
and <command>lcov</command> programs.
</para>
<para>
A typical workflow would look like this:
A typical workflow looks like this:
<screen>
./configure --enable-coverage ... OTHER OPTIONS ...
make
@ -820,12 +820,11 @@ make coverage-html
</screen>
Then point your HTML browser
to <filename>coverage/index.html</filename>.
The <command>make</command> commands also work in subdirectories.
</para>
<para>
If you don't have <command>lcov</command> or prefer text output over an
HTML report, you can also run
HTML report, you can run
<screen>
make coverage
</screen>
@ -837,11 +836,23 @@ make coverage
</para>
<para>
To reset the execution counts between test runs, run:
You can run several different tests before making the coverage report;
the execution counts will accumulate. If you want
to reset the execution counts between test runs, run:
<screen>
make coverage-clean
</screen>
</para>
<para>
You can run the <literal>make coverage-html</literal> or <literal>make
coverage</literal> command in a subdirectory if you want a coverage
report for only a portion of the code tree.
</para>
<para>
Use <literal>make distclean</literal> to clean up when done.
</para>
</sect1>
</chapter>