From ce40a03aae0ffe34f498c66f8beb022566531bc3 Mon Sep 17 00:00:00 2001 From: Arun Raghavan Date: Fri, 12 Oct 2012 22:04:11 +0530 Subject: [PATCH] Add documentation on running clients with Valgrind Quick documentation on how Valgrind can be run in clients without triggering false positives. https://bugs.freedesktop.org/show_bug.cgi?id=55933 --- README.valgrind | 24 ++++++++++++++++++++++++ 1 files changed, 24 insertions(+), 0 deletions(-) create mode 100644 README.valgrind diff --git a/README.valgrind b/README.valgrind new file mode 100644 index 0000000..c13f530 --- /dev/null +++ b/README.valgrind @@ -0,0 +1,24 @@ +Running D-Bus clients with Valgrind +==== + +When running programs using libdbus in Valgrind, some special care needs to be +taken so as to avoid incorrect detection of leaks in libdbus. To avoid these +false positives, do the following: + +* Grab a copy of the D-Bus source code + +* Run configure with the --enable-developer and --with-valgrind options + +* Run make + +* Either make sure your code calls dbus_shutdown() (at least while running in + Valgrind) or set DBUS_MESSAGE_CACHE=0 in your environment + +* Run Valgrind on your program with the /path/to/dbus/source/dbus/.libs in your + LD_LIBRARY_PATH + +Your Valgrind log should now be free of any (spurious) libdbus-related leaks. + +For the curious, the DBUS_MESSAGE_CACHE=0 is required because by +default, libdbus uses a recyclable pool of message structs. These help +performance a bit. -- 1.7.8.6