From ae759bff511cfbd28bdb668a532ba9169d05af2d Mon Sep 17 00:00:00 2001 From: Havoc Pennington Date: Tue, 29 Apr 2003 21:56:37 +0000 Subject: 2003-04-29 Havoc Pennington * dbus-1.pc.in, dbus-glib-1.pc.in: rename these from dbus-1.0.pc.in, dbus-glib-1.0.pc.in. As these change with the parallel install API version, not with the D-BUS package version. * HACKING: move some of README over here * README: updates, and document API/ABI policy * configure.in: reindentation --- HACKING | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) (limited to 'HACKING') diff --git a/HACKING b/HACKING index d8fc1f92..3bd2e094 100644 --- a/HACKING +++ b/HACKING @@ -98,3 +98,47 @@ To make a release of D-BUS, do the following: - post to message-bus-list@freedesktop.org announcing the release. + +Environment variables +=== + +These are the environment variables that are used by the D-BUS client library + +DBUS_VERBOSE=1 +Turns on printing verbose messages. This only works if D-BUS has been +compiled with --enable-verbose-mode + +DBUS_MALLOC_FAIL_NTH=n +Can be set to a number, causing every nth call to dbus_alloc or +dbus_realloc to fail. This only works if D-BUS has been compiled with +--enable-tests. + +DBUS_MALLOC_FAIL_GREATER_THAN=n +Can be set to a number, causing every call to dbus_alloc or +dbus_realloc to fail if the number of bytes to be allocated is greater +than the specified number. This only works if D-BUS has been compiled with +--enable-tests. + +Tests +=== + +These are the test programs that are built if dbus is compiled using +--enable-tests. + +dbus/dbus-test +This is the main unit test program that tests all aspects of the D-BUS +client library. + +dbus/bus-test +This it the unit test program for the message bus. + +test/break-loader +A test that tries to break the message loader by passing it randomly +created invalid messages. + +"make check" runs all the deterministic test programs (i.e. not break-loader). + +"make check-coverage" is available if you configure with --enable-gcov and +gives a complete report on test suite coverage. You can also run +"test/decode-gcov foo.c" on any source file to get annotated source, +after running make check with a gcov-enabled tree. -- cgit