This is 1.15

[perl/modules/Test-Valgrind.git] / lib / Test / Valgrind.pm

diff --git a/lib/Test/Valgrind.pm b/lib/Test/Valgrind.pm
index a5883e4377b1d8aaacda9e1ac341502b34b16e92..ed3a1976bedd63d99446b4d1a3fc35c61bc64893 100644 (file)
--- a/lib/Test/Valgrind.pm
+++ b/lib/Test/Valgrind.pm
@@ -9,11 +9,11 @@ Test::Valgrind - Generate suppressions, analyse and test any command with valgri
 
 =head1 VERSION
 
-Version 1.12
+Version 1.15
 
 =cut
 
-our $VERSION = '1.12';
+our $VERSION = '1.15';
 
 =head1 SYNOPSIS
 
@@ -49,7 +49,9 @@ As such, it's complementary to the other very good leak detectors listed in the
 
 =head1 METHODS
 
-=head2 C<analyse [ %options ]>
+=head2 C<analyse>
+
+    Test::Valgrind->analyse(%options);
 
 Run a C<valgrind> analysis configured by C<%options> :
 
@@ -106,11 +108,11 @@ Ignored if you supply your own custom C<action>, otherwise defaults to false.
 
 =item *
 
-C<< extra_supps => \@files >>
+C<< regen_def_supp => $bool >>
 
-Also use suppressions from C<@files> besides C<perl>'s.
+If true, forcefully regenerate the default suppression file.
 
-Defaults to empty.
+Defaults to false.
 
 =item *
 
@@ -120,6 +122,14 @@ If true, do not use the default suppression file.
 
 Defaults to false.
 
+=item *
+
+C<< extra_supps => \@files >>
+
+Also use suppressions from C<@files> besides C<perl>'s.
+
+Defaults to empty.
+
 =back
 
 =cut
@@ -166,7 +176,7 @@ sub analyse {
  my $sess = eval {
   Test::Valgrind::Session->new(
    min_version => $tool->requires_version,
-   map { $_ => delete $args{$_} } qw/extra_supps no_def_supp/
+   map { $_ => delete $args{$_} } qw<regen_def_supp no_def_supp extra_supps>
   );
  };
  unless ($sess) {
@@ -194,7 +204,9 @@ sub analyse {
  return $status;
 }
 
-=head2 C<import [ %options ]>
+=head2 C<import>
+
+    use Test::Valgrind %options;
 
 In the parent process, L</import> calls L</analyse> with the arguments it received itself - except that if no C<file> option was supplied, it tries to pick the first caller context that looks like a script.
 When the analysis ends, it exits with the status returned by the action (for the default TAP-generator action, it's the number of failed tests).
@@ -363,13 +375,13 @@ H.Merijn Brand, for daring to test this thing.
 
 David Cantrell, for providing shell access to one of his smokers where the tests were failing.
 
-The debian-perl team, for offering all the feedback they could regarding the build issues they met.
+The Debian-perl team, for offering all the feedback they could regarding the build issues they met.
 
 All you people that showed interest in this module, which motivated me into completely rewriting it.
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2008,2009,2010 Vincent Pit, all rights reserved.
+Copyright 2008,2009,2010,2011,2013,2015 Vincent Pit, all rights reserved.
 
 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.