Add a README.dev file with some info about valgrind and a suppression…

…s file for valgrind
maxmind · Oct 1, 2013 · 66143e6 · 66143e6
1 parent 8eabb0e
commit 66143e6
Show file tree

Hide file tree

Showing 2 changed files with 492 additions and 0 deletions.
diff --git a/README.dev.md b/README.dev.md
@@ -0,0 +1,13 @@
+== Running valgrind
+
+This distro ships with a valgrind suppressions file that suppresses leaks that
+occur from inside the Perl core as well as leaks from other modules.
+
+You can valgrind with a command like this:
+
+    ./Build && \
+    valgrind --leak-check=full --num-callers=50 --suppressions=./valgrind.supp \
+        -- perl -Mblib -I ../MaxMind-DB-Reader-perl/lib/ t/MaxMind/DB/Reader.t
+
+This assumes you have the MaxMind-DB-Reader-perl repo checked out in the
+parent directory.