From: Vincent Pit Date: Sat, 2 May 2009 11:49:00 +0000 (+0200) Subject: A short note about the API X-Git-Tag: v1.02~3 X-Git-Url: http://git.vpit.fr/?a=commitdiff_plain;h=acae7246c98a654768984b19cab378f97132d5cc;p=perl%2Fmodules%2FTest-Valgrind.git A short note about the API --- diff --git a/lib/Test/Valgrind.pm b/lib/Test/Valgrind.pm index 1b4aa78..15dbd21 100644 --- a/lib/Test/Valgrind.pm +++ b/lib/Test/Valgrind.pm @@ -38,6 +38,9 @@ This module is a front-end to the C API that lets you run Per If they aren't available yet, it will first generate suppressions for the current C interpreter and store them in the portable flavour of F<~/.perl/Test-Valgrind/suppressions/$VERSION>. The actual run will then take place, and tests will be passed or failed according to the result of the analysis. +The complete API is much more versatile than this. +It allows you to run I executable under valgrind, generate the corresponding suppressions and convert the analysis output to TAP so that it can be incorporated into your project's testsuite. + 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 and friends or C. As such, it's complementary to the other very good leak detectors listed in the L section.