X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=doc%2Fdevelopment.txt;fp=doc%2Fdevelopment.txt;h=f18070c1e19c7c6682f51ae8e2253dbdd18c18e8;hp=0000000000000000000000000000000000000000;hb=4963668994aa255cd9e938eab6e504b07817f79a;hpb=98ef24741ffe8c7403760763f8b5b9f9154f8054

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