From 4963668994aa255cd9e938eab6e504b07817f79a Mon Sep 17 00:00:00 2001 From: Julien Desfossez Date: Tue, 16 Oct 2012 14:47:09 -0400 Subject: [PATCH] Doc: valgrind with babeltrace (glib workaround) Signed-off-by: Julien Desfossez Signed-off-by: Mathieu Desnoyers --- doc/Makefile.am | 2 ++ doc/development.txt | 10 ++++++++++ 2 files changed, 12 insertions(+) create mode 100644 doc/development.txt diff --git a/doc/Makefile.am b/doc/Makefile.am index 597c43e7..6077f623 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,3 +1,5 @@ dist_man_MANS = babeltrace.1 babeltrace-log.1 dist_doc_DATA = API.txt + +EXTRA_DIST = development.txt diff --git a/doc/development.txt b/doc/development.txt new file mode 100644 index 00000000..f18070c1 --- /dev/null +++ b/doc/development.txt @@ -0,0 +1,10 @@ +This document describes some principles that should be respected when +developing in Babeltrace. + +Memory usage : +Since Babeltrace exports a library, we need to make sure that all allocated +memory is freed, we do not want any memory leaks. +Since Babeltrace uses the glib, it is necessary to assist a little valgrind +when trying to identify memory leaks. +So the proper invocation of Babeltrace with Valgrind is : +G_SLICE=always-malloc G_DEBUG=gc-friendly valgrind --leak-check=full babeltrace -- 2.34.1