Update VPIT::TestHelpers to 15e8aee3

[perl/modules/Test-Valgrind.git] / README

diff --git a/README b/README
index 72776c2f01a09a7a9cdc2beecff05d3ea7e04a14..95c8a4a4a94ef19213f2dd7604b574137436bc76 100644 (file)
--- a/README
+++ b/README
@@ -3,7 +3,7 @@ NAME
     with valgrind.
 
 VERSION
-    Version 1.12
+    Version 1.19
 
 SYNOPSIS
         # From the command-line
@@ -48,7 +48,9 @@ DESCRIPTION
     ALSO" section.
 
 METHODS
-  "analyse [ %options ]"
+  "analyse"
+        Test::Valgrind->analyse(%options);
+
     Run a "valgrind" analysis configured by %options :
 
     *   "command => $command"
@@ -82,7 +84,7 @@ METHODS
         error. Raising this number improves granularity.
 
         Ignored if you supply your own custom "tool", otherwise defaults to
-        12.
+        24 (the maximum allowed by "valgrind").
 
     *   "diag => $bool"
 
@@ -91,11 +93,11 @@ METHODS
         Ignored if you supply your own custom "action", otherwise defaults
         to false.
 
-    *   "extra_supps => \@files"
+    *   "regen_def_supp => $bool"
 
-        Also use suppressions from @files besides "perl"'s.
+        If true, forcefully regenerate the default suppression file.
 
-        Defaults to empty.
+        Defaults to false.
 
     *   "no_def_supp => $bool"
 
@@ -103,7 +105,22 @@ METHODS
 
         Defaults to false.
 
-  "import [ %options ]"
+    *   "allow_no_supp => $bool"
+
+        If true, force running the analysis even if the suppression files do
+        not refer to any "perl"-related symbol.
+
+        Defaults to false.
+
+    *   "extra_supps => \@files"
+
+        Also use suppressions from @files besides "perl"'s.
+
+        Defaults to empty.
+
+  "import"
+        use Test::Valgrind %options;
+
     In the parent process, "import" calls "analyse" with the arguments it
     received itself - except that if no "file" option was supplied, it tries
     to pick the first caller context that looks like a script. When the
@@ -139,7 +156,7 @@ CAVEATS
     the "diag" option, in which case it will be reprinted as diagnostics.
 
 DEPENDENCIES
-    XML::Twig, version, File::HomeDir, Env::Sanctify, Perl::Destruct::Level.
+    XML::Twig, File::HomeDir, Env::Sanctify, Perl::Destruct::Level.
 
 SEE ALSO
     All the "Test::Valgrind::*" API, including Test::Valgrind::Command,
@@ -170,7 +187,7 @@ SUPPORT
         perldoc Test::Valgrind
 
 ACKNOWLEDGEMENTS
-    Rafaël Garcia-Suarez, for writing and instructing me about the existence
+    Rafaël Garcia-Suarez, for writing and instructing me about the existence
     of Perl::Destruct::Level (Elizabeth Mattijsen is a close second).
 
     H.Merijn Brand, for daring to test this thing.
@@ -178,14 +195,15 @@ ACKNOWLEDGEMENTS
     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 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.
 
 COPYRIGHT & LICENSE
-    Copyright 2008-2009 Vincent Pit, all rights reserved.
+    Copyright 2008,2009,2010,2011,2013,2015,2016 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.