README

   1 NAME
   2     Test::Valgrind - Test your code through valgrind.
   3
   4 VERSION
   5     Version 0.01
   6
   7 SYNOPSIS
   8         use Test::More;
   9         eval 'use Test::Valgrind';
  10         plan skip_all => 'Test::Valgrind is required to test your distribution with valgrind';
  11
  12         # Code to inspect for memory leaks/errors.
  13
  14 DESCRIPTION
  15     This module lets you run some code through the valgrind memory debugger,
  16     to test it for memory errors and leaks. Just add "use Test::Valgrind" at
  17     the beginning of the code you want to test. Behind the hood,
  18     "Test::Valgrind::import" forks so that the child can basically "exec
  19     'valgrind', $^X, $0" (except that of course $0 isn't right there). The
  20     parent then parses the report output by valgrind and pass or fail tests
  21     accordingly.
  22
  23 CONFIGURATION
  24     You can pass parameters to "import" as a list of key / value pairs,
  25     where valid keys are :
  26
  27     "supp => $file"
  28         Also use suppressions from $file besides perl's.
  29
  30     "no_supp => $bool"
  31         If true, do not use any suppressions.
  32
  33     "callers => $number"
  34         Specify the maximum stack depth studied when valgrind encounters an
  35         error. Raising this number improves granularity. Default is 50.
  36
  37     "extra => [ @args ]"
  38         Add @args to valgrind parameters.
  39
  40     "diag => $bool"
  41         If true, print the raw output of valgrind as diagnostics (may be
  42         quite verbose).
  43
  44     "no_test => $bool"
  45         If true, do not actually output the plan and the tests results.
  46
  47 CAVEATS
  48     You can't use this module to test code given by the "-e" command-line
  49     switch. This module is not really secure. It's definitely not taint
  50     safe. That shouldn't be a problem for test files. If your tests output
  51     to STDERR, everything will be eaten in the process.
  52
  53 DEPENDENCIES
  54     Valgrind 3.1.0 (<http://valgrind.org>).
  55
  56     Carp, POSIX (core modules since perl 5) and Test::More (since 5.6.2).
  57
  58 AUTHOR
  59     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
  60
  61     You can contact me by mail or on #perl @ FreeNode (vincent or
  62     Prof_Vince).
  63
  64 BUGS
  65     Please report any bugs or feature requests to "bug-test-valgrind at
  66     rt.cpan.org", or through the web interface at
  67     <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Valgrind>. I will
  68     be notified, and then you'll automatically be notified of progress on
  69     your bug as I make changes.
  70
  71 SUPPORT
  72     You can find documentation for this module with the perldoc command.
  73
  74         perldoc Test::Valgrind
  75
  76 COPYRIGHT & LICENSE
  77     Copyright 2008 Vincent Pit, all rights reserved.
  78
  79     This program is free software; you can redistribute it and/or modify it
  80     under the same terms as Perl itself.
  81