Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 118 lines (80 sloc) 4.359 kb
692f58f @pjcj import Devel::Cover 0.01
authored
1 NAME
310cdad @pjcj import Devel::Cover 0.05
authored
2 Devel::Cover - Code coverage metrics for Perl
692f58f @pjcj import Devel::Cover 0.01
authored
3
2585fae @pjcj import Devel::Cover 0.42
authored
4 SYNOPSIS
7203f8c @pjcj Regenerate README.
authored
5 To get coverage for an uninstalled module:
2585fae @pjcj import Devel::Cover 0.42
authored
6
2fae052 @pjcj Be more explicit about what I mean when I call this alpha software.
authored
7 cover -test
8
9 or
10
2585fae @pjcj import Devel::Cover 0.42
authored
11 cover -delete
12 HARNESS_PERL_SWITCHES=-MDevel::Cover make test
13 cover
14
7203f8c @pjcj Regenerate README.
authored
15 To get coverage for an uninstalled module which uses Module::Build (0.26
16 or later):
3b62567 @acme Document Module::Build's testcover (Leon Brocard)
acme authored
17
18 ./Build testcover
19
2585fae @pjcj import Devel::Cover 0.42
authored
20 If the module does not use the t/*.t framework:
21
22 PERL5OPT=-MDevel::Cover make test
23
7203f8c @pjcj Regenerate README.
authored
24 If you want to get coverage for a program:
25
26 perl -MDevel::Cover yourprog args
27 cover
28
29 perl -MDevel::Cover=-db,cover_db,-coverage,statement,time yourprog args
30
692f58f @pjcj import Devel::Cover 0.01
authored
31 DESCRIPTION
529ebe7 @acme Add more detail about code coverage in docs (Leon Brocard)
acme authored
32 This module provides code coverage metrics for Perl. Code coverage
2fae052 @pjcj Be more explicit about what I mean when I call this alpha software.
authored
33 metrics describe how thoroughly tests exercise code. By using
7203f8c @pjcj Regenerate README.
authored
34 Devel::Cover you can discover areas of code not exercised by your tests
35 and determine which tests to create to increase coverage. Code coverage
36 can be considered as an indirect measure of quality.
692f58f @pjcj import Devel::Cover 0.01
authored
37
2fae052 @pjcj Be more explicit about what I mean when I call this alpha software.
authored
38 I consider this software to have an alpha status. By that I mean that I
39 reserve the right to alter the interface in a backwards incompatible
40 manner without incrementing the major version number. I specifically do
41 not mean that this software is full of bugs or missing key features.
42 Although I'm making no guarantees on that front either. In short, if
43 you are looking for code coverage software for Perl, you have probably
44 come to the end of your search. For more of my opinions on this
45 subject, see http://pjcj.sytes.net/notes/2007/03/14#alpha
692f58f @pjcj import Devel::Cover 0.01
authored
46
f9ee5ec @pjcj import Devel::Cover 0.20
authored
47 Code coverage data are collected using a pluggable runops function which
a40c898 @pjcj Update README.
authored
48 counts how many times each op is executed. These data are then mapped
49 back to reality using the B compiler modules. There is also a statement
7203f8c @pjcj Regenerate README.
authored
50 profiling facility which needs a better backend to be really useful.
51 This release also includes an experimental mode which replaces ops
52 instead of using a pluggable runops function. This provides a nice
53 speed increase, but needs better testing before it becomes the default.
54 You probably don't care about any of this.
692f58f @pjcj import Devel::Cover 0.01
authored
55
69a8165 @pjcj import Devel::Cover 0.10
authored
56 The cover program can be used to generate coverage reports.
57
ffe2236 @pjcj import Devel::Cover 0.23
authored
58 Statement, branch, condition, subroutine, pod and time coverage
a40c898 @pjcj Update README.
authored
59 information is reported. Statement coverage data should be reasonable,
60 although there may be some statements which are not reported. Branch
61 and condition coverage data should be mostly accurate too, although not
62 always what one might initially expect. Subroutine coverage should be
63 as accurate as statement coverage. Pod coverage comes from
64 Pod::Coverage. If Pod::Coverage::CountParents is available it will be
65 used instead. Coverage data for path coverage are not yet collected.
a9f2eee @pjcj import Devel::Cover 0.04
authored
66
b8eeb86 @pjcj import Devel::Cover 0.33
authored
67 The gcov2perl program can be used to convert gcov files to
68 "Devel::Cover" databases.
2152f1e @pjcj import Devel::Cover 0.14
authored
69
a40c898 @pjcj Update README.
authored
70 You may find that the results don't match your expectations. I would
a9f2eee @pjcj import Devel::Cover 0.04
authored
71 imagine that at least one of them is wrong.
692f58f @pjcj import Devel::Cover 0.01
authored
72
b8eeb86 @pjcj import Devel::Cover 0.33
authored
73 The most appropriate mailing list on which to discuss this module would
a40c898 @pjcj Update README.
authored
74 be perl-qa. Discussion has migrated there from perl-qa-metrics which is
69b1308 @pjcj Update README.
authored
75 now defunct. See <http://lists.perl.org/list/perl-qa.html>.
c8c4341 @pjcj import Devel::Cover 0.15
authored
76
ee899b8 @pjcj Add location of git repository.
authored
77 The Devel::Cover repository can be found at
78 <http://github.com/pjcj/Devel--Cover>.
79
b8eeb86 @pjcj import Devel::Cover 0.33
authored
80 REQUIREMENTS
7203f8c @pjcj Regenerate README.
authored
81 * Perl 5.6.1 or greater. Perl 5.8.2 or greater is recommended.
82
a40c898 @pjcj Update README.
authored
83 Perl 5.7.0 is unsupported. Perl 5.8.2 or greater is recommended.
4116963 @pjcj import Devel::Cover 0.46
authored
84 Whilst Perl 5.6 should mostly work you will probably miss out on
85 coverage information which would be available using a more modern
a40c898 @pjcj Update README.
authored
86 version and will likely run into bugs in perl. Perl 5.8.0 will give
77f12a0 @pjcj Bump version to 0.54.
authored
87 slightly different results to more recent versions due to changes in
88 the op tree.
2152f1e @pjcj import Devel::Cover 0.14
authored
89
7203f8c @pjcj Regenerate README.
authored
90 * The ability to compile XS extensions.
91
b8eeb86 @pjcj import Devel::Cover 0.33
authored
92 This means a working compiler and make program at least.
93
7203f8c @pjcj Regenerate README.
authored
94 * Storable and Digest::MD5
95
b8eeb86 @pjcj import Devel::Cover 0.33
authored
96 Both are in the core in Perl 5.8.0 and above.
97
7203f8c @pjcj Regenerate README.
authored
98 * Template and PPI::HTML or Perl::Tidy
99
2cebf24 @pjcj Update to version 0.58 and regenerate README.
authored
100 if you want syntax highlighted HTML reports.
101
7203f8c @pjcj Regenerate README.
authored
102 * Pod::Coverage
103
b8eeb86 @pjcj import Devel::Cover 0.33
authored
104 if you want Pod coverage.
105
5453136 @pjcj Updated README with Test::More requirement.
authored
106 * Test::More
107
108 in order to run the tests
109
89b4626 @pjcj Document Test::Warn dependency fully.
authored
110 * Test::Warn
111
112 in order to run some of the tests
113
7203f8c @pjcj Regenerate README.
authored
114 * Test::Differences
115
b8eeb86 @pjcj import Devel::Cover 0.33
authored
116 if the tests fail and you would like nice output telling you why.
692f58f @pjcj import Devel::Cover 0.01
authored
117
Something went wrong with that request. Please try again.