]> git.vpit.fr Git - perl/modules/Test-Valgrind.git/commitdiff
Document alternatives
authorVincent Pit <vince@profvince.com>
Mon, 25 Aug 2008 21:55:46 +0000 (23:55 +0200)
committerVincent Pit <vince@profvince.com>
Mon, 25 Aug 2008 21:55:46 +0000 (23:55 +0200)
lib/Test/Valgrind.pm

index fa79775c2efb2be24be053fc42c19e09e822de5f..e52bd57eac65207a33d2f2cb036c42fd3b939a07 100644 (file)
@@ -39,6 +39,8 @@ You can also use it from the command-line to test a given script :
 
     perl -MTest::Valgrind leaky.pl
 
+Due to the nature of perl's memory allocator, this module can't track leaks of Perl objects. This includes non-mortalized scalars and memory cycles. However, it can track leaks of chunks of memory allocated in XS extensions with C<Newx> and friends or C<malloc>. As such, it's complementary to the other very good leak detectors listed in the L</SEE ALSO> section.
+
 =head1 CONFIGURATION
 
 You can pass parameters to C<import> as a list of key / value pairs, where valid keys are :
@@ -225,6 +227,10 @@ L<Carp>, L<POSIX> (core modules since perl 5) and L<Test::More> (since 5.6.2).
 
 L<Perl::Destruct::Level>.
 
+=head1 SEE ALSO
+
+L<Devel::Leak>, L<Devel::LeakTrace>, L<Devel::LeakTrace::Fast>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.