.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "GCOV2PERL 1p"
.TH GCOV2PERL 1p 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
gcov2perl \- convert gcov files to Devel::Cover databases
.SH VERSION
.IX Header "VERSION"
version 1.40
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& gcov2perl \-h \-i \-v \-db database gcov_files
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Convert gcov files to Devel::Cover databases.
.SH OPTIONS
.IX Header "OPTIONS"
The following command line options are supported:
.PP
.Vb 1
\& \-db database    \- specify the database to use
\&
\& \-h \-help        \- show help
\& \-i \-info        \- show documentation
\& \-v \-version     \- show version
.Ve
.SH DETAILS
.IX Header "DETAILS"
To obtain coverage of XS files they must first be compiled with the appropriate
options.  In a standard Makefile environment, such as that created by
ExtUtils::MakeMaker, this can be accomplished with the command:
.PP
.Vb 3
\& HARNESS_PERL_SWITCHES=\-MDevel::Cover make test \e
\&   CCFLAGS=\-O0\e \-fprofile\-arcs\e \-ftest\-coverage \e
\&   OTHERLDFLAGS=\-fprofile\-arcs\e \-ftest\-coverage
.Ve
.PP
If you have already built your object files it may be necessary to run make
clean first, or to find some other way to ensure that they get rebuilt with the
options gcov requires.
.PP
Now the code coverage data has been collected \f(CW\*(C`gcov\*(C'\fR needs to be run:
.PP
.Vb 1
\& gcov Mylib.xs
.Ve
.PP
This will create one or more gcov files on which you can run \f(CW\*(C`gcov2perl\*(C'\fR:
.PP
.Vb 1
\& gcov2perl Mylib.xs.gcov
.Ve
.PP
Finally, \f(CW\*(C`cover\*(C'\fR should be run as usual with any options required:
.PP
.Vb 1
\& cover
.Ve
.PP
If you are running everything with standard options, you can do all this with
one command:
.PP
.Vb 1
\& cover \-test
.Ve
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
The following exit values are returned:
.PP
.Vb 2
\& 0   All files converted successfully
\& >0  An error occurred.
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 1
\& Devel::Cover
.Ve
.SH BUGS
.IX Header "BUGS"
Huh?
.SH LICENCE
.IX Header "LICENCE"
Copyright 2001\-2023, Paul Johnson (paul@pjcj.net)
.PP
This software is free.  It is licensed under the same terms as Perl itself.
.PP
The latest version of this software should be available from my homepage:
http://www.pjcj.net