[babeltrace.git] / doc / development.txt

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
Commit	Line	Data
49636689 JD	1	This document describes some principles that should be respected when
	2	developing in Babeltrace.
	3
	4	Memory usage :
	5	Since Babeltrace exports a library, we need to make sure that all allocated
	6	memory is freed, we do not want any memory leaks.
	7	Since Babeltrace uses the glib, it is necessary to assist a little valgrind
	8	when trying to identify memory leaks.
	9	So the proper invocation of Babeltrace with Valgrind is :
	10	G_SLICE=always-malloc G_DEBUG=gc-friendly valgrind --leak-check=full babeltrace