]> www.fi.muni.cz Git - evince.git/blob - doc/debugging.txt
Add debugging helpers
[evince.git] / doc / debugging.txt
1 To enable debugging use the configure option --enable-debug.
2
3 LOGGING
4 =======
5
6 At execution time, you must enable the log service. To enable the
7 log service, set the environment variable: EV_LOG_MODULES
8
9 EV_LOG_MODULES variable has the form:
10
11         <moduleName>[:<moduleName>]*
12
13 moduleName is a filename.
14 ex: export EV_LOG_MODULES=ev-window.c:ev-view.c
15 The special log module "all" enables all log modules.
16
17 Use the LOG macro to put debug messages in the code.
18
19 WARNINGS
20 ========
21
22 At execution time, you must enable the service. To enable you to debug
23 warnings, set the environment variable: EV_DEBUG_BREAK
24
25 Possibe value for EV_DEBUG_BREAK variable:
26
27         stack           Prints a stack trace.
28
29         suspend         Use this to stop execution when a warning occurs.
30                         You can then attach a debugger to the process.
31
32         trap            Use this while running epiphany in a debugger.
33                         This makes execution stop and gives back control to
34                         the debugger.
35
36
37 PROFILING
38 =========
39
40 At execution time, you must enable the profiling service. To enable the
41 profiling service, set the environment variable: EV_PROFILING_MODULES
42
43 EV_PROFILE_MODULES variable has the form:
44
45         <moduleName>[:<moduleName>]*
46
47 moduleName is a filename.
48 ex: export EV_PROFILE_MODULES=ephy-window.c:ephy-autocompletion.c
49 The special profiling module "all" enables all profiling modules.
50
51 Use START_PROFILER STOP_PROFILER macros to profile pieces of code.