Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Add more documentation about cover --test.

And a bit about the requirements to build Devel::Cover.

Based on a patch from Kirk Kimmel.
  • Loading branch information...
commit 096fe897e15d9c1458a38f127bd0aab2b2bd6b90 1 parent c6f1710
@pjcj authored
Showing with 18 additions and 7 deletions.
  1. +11 −4 bin/cover
  2. +7 −3 lib/Devel/Cover.pm
View
15 bin/cover
@@ -428,10 +428,17 @@ Specify -select and -ignore options to report on specific files.
Specify -coverage options to report on specific criteria. By default
all available information on all criteria in all files will be reported.
-The -test option will delete the databases and run make test to generate
-new coverage data before reporting on it. The -gcov option will try to
-run gcov on any XS code. This requires that you are using gcc of
-course. If you are this option will be turned on by default.
+The -test option will delete the databases and run your tests to generate
+new coverage data before reporting on it. Devel::Cover knows how to work
+with standard Perl Makefiles as well as Module::Build based distributions.
+For detailed instructions see the documentation for ExtUtils::MakeMaker at
+https://metacpan.org/module/ExtUtils::MakeMaker or for Module::Build at
+https://metacpan.org/module/Module::Build both of which come as standard
+in recent Perl distributions.
+
+The -gcov option will try to run gcov on any XS code. This requires that
+you are using gcc of course. If you are using the -test option will be
+turned on by default.
=head1 EXIT STATUS
View
10 lib/Devel/Cover.pm
@@ -1371,12 +1371,16 @@ Perl 5.7.0 is unsupported. Perl 5.8.8 or greater is recommended. Perl
5.8.7 has problems and may crash. Whilst Perl 5.6 should mostly work
you will probably miss out on coverage information which would be
available using a more modern version and will likely run into bugs in
-perl. Perl 5.8.0 will give slightly different results to more recent
-versions due to changes in the op tree.
+perl. Different versions of perl may give slightly different results
+due to changes in the op tree.
=item * The ability to compile XS extensions.
-This means a working compiler and make program at least.
+This means a working C compiler and make program at least. If you built perl
+from source you will have these already and they will be used automatically.
+If your perl was built in some other way, for example you may have installed
+it using your Operating System's packaging mechanism, you will need to ensure
+that the appropriate tools are installed.
=item * L<Storable> and L<Digest::MD5>
Please sign in to comment.
Something went wrong with that request. Please try again.