ringbuffer_extend() for adding extra space to the last added entry
[nobug.git] / doc / additional.txt
blob0350f97070bb263016117a051cff1e60c807f28d
1 HEAD~ Checking for Additional Tools;;
3 Various peripheral tools can be used by NoBug depending on the requirements
4 of the application and the detail desired by the user.  Such tools can provide
5 additional, detailed information on the application and its behaviour.
6 However, some applications may not require such detail and the associated
7 overhead in information, and users may decide to omit excess information by
8 excluding such tools.
10 At the moment NoBug supports the optional inclusion of gdb, valgrind and support
11 for multi-threaded applications and the information that can be provided by
12 these tools.  However, support for other tools may be supplied in the future,
13 e.g. the dbx debugger on OpenSolaris. 
15 Such tools can be easily queried on the system and if they are available on a
16 particular system, they can be used by NoBug to provide even more information on
17 the application using NoBug.  If such tools are not available or are not
18 required by the user for one reason or other, then NoBug will happily function
19 as usual, just without the extra information.
21 Testing the availability of such tools on a particular system can be achieved
22 using autoconf, as illustrated in the following:
24 `*NOBUG_USE_VALGRIND*`::
25    `1`:: Use valgrind
26    `0`:: Do not use valgrind
28 `*NOBUG_USE_PTHREAD*`::
29    `1`:: Support for multi-thread applications
30    `0`:: Single-threaded applications
32 `*NOBUG_USE_EXECINFO*`::
33    `1`:: Backtrace information
34    `0`:: No backtrace information
36 These macros are then automatically defined when the configuration system
37 provides the associated `HAVE_*` macros, but can then be overridden by the user,
38 depending on the user's requirements.