Re: Add documentation for coverage reports with meson - Mailing list pgsql-hackers

From Peter Eisentraut
Subject Re: Add documentation for coverage reports with meson
Date
Msg-id f7e5de60-7a69-88ee-27c1-1cf11c1cbbe2@enterprisedb.com
Whole thread Raw
In response to Add documentation for coverage reports with meson  (Michael Paquier <michael@paquier.xyz>)
Responses Re: Add documentation for coverage reports with meson  (Michael Paquier <michael@paquier.xyz>)
List pgsql-hackers
On 28.02.23 09:49, Michael Paquier wrote:
> -    when compiling with GCC, and it requires the <command>gcov</command>
> -    and <command>lcov</command> programs.
> +    when compiling with GCC, and it requires the <command>gcov</command>,
> +    <command>lcov</command> and <command>genhtml</command> programs.

genhtml is part of the lcov package.  I think it would be confusing to 
mention it explicitly, since you won't be able to find it as something 
to install.  Maybe leave the original list and change "programs" to 
"packages"?

> -   <para>
> -    A typical workflow looks like this:
> +   <sect2 id="regress-coverage-configure">
> +    <title>Coverage with <filename>configure</filename></title>
> +    <para>
> +     A typical workflow looks like this:

In the installation chapter we use titles like "Building and 
Installation with Autoconf and Make" and "Building and Installation with 
Meson".  We should use analogous wordings here.

> +    <para>
> +     A typical workflow looks like this:
> +<screen>
> +meson setup -Db_coverage=true ... OTHER OPTIONS ...
> +ninja
> +meson test
> +ninja coverage-html
> +</screen>
> +     Then point your HTML browser
> +     to <filename>./meson-logs/coveragereport/index.html</filename>.
> +    </para>

This ignores which directory you have to be in.  The meson calls have to 
be at the top level, the ninja calls have to be in the build directory. 
We should be more precise here, otherwise someone trying this will find 
that it doesn't work.

Personally I use "meson compile" instead of "ninja"; I'm not sure what 
the best recommendation is, but that least that way all the initial 
commands are "meson something" instead of going back and forth.




pgsql-hackers by date:

Previous
From: Kyotaro Horiguchi
Date:
Subject: Re: In-placre persistance change of a relation
Next
From: Peter Eisentraut
Date:
Subject: Re: meson: Non-feature feature options