Docs: add high-level debug info doc
[babeltrace.git] / doc / development.txt
CommitLineData
49636689
JD
1This document describes some principles that should be respected when
2developing in Babeltrace.
3
4Memory usage :
6aa249b5 5
49636689
JD
6Since Babeltrace exports a library, we need to make sure that all allocated
7memory is freed, we do not want any memory leaks.
8Since Babeltrace uses the glib, it is necessary to assist a little valgrind
9when trying to identify memory leaks.
6aa249b5
MD
10
11libpopt has issues with inconsistency between versions. Namely, libpopt
120.16 allocates memory for the string returned by poptgetArg(), but not
13libpopt 0.13. Therefore, we are providing a warning suppression file
14that covers this case in the extras/ directory of the source code.
15
49636689 16So the proper invocation of Babeltrace with Valgrind is :
6aa249b5
MD
17
18G_SLICE=always-malloc G_DEBUG=gc-friendly \
19 valgrind --leak-check=full \
20 --suppressions=path_to_babeltrace_src/extras/valgrind/popt.supp \
21 babeltrace
This page took 0.023252 seconds and 4 git commands to generate.