Doc: valgrind with babeltrace (glib workaround)

Signed-off-by: Julien Desfossez <jdesfossez@efficios.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 597c43e79922f8d31576f2a7c06a8d44dcd692a5..6077f6232f096646f3bba32198a9f95d02cb6b72 100644 (file)
--- 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 (file)
index 0000000..f18070c
--- /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