Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/doc/debugging.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/debugging.txt')
-rw-r--r--doc/debugging.txt51
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/debugging.txt b/doc/debugging.txt
new file mode 100644
index 0000000..11826db
--- /dev/null
+++ b/doc/debugging.txt
@@ -0,0 +1,51 @@
+To enable debugging use the configure option --enable-debug.
+
+LOGGING
+=======
+
+At execution time, you must enable the log service. To enable the
+log service, set the environment variable: EV_LOG_MODULES
+
+EV_LOG_MODULES variable has the form:
+
+ <moduleName>[:<moduleName>]*
+
+moduleName is a filename.
+ex: export EV_LOG_MODULES=ev-window.c:ev-view.c
+The special log module "all" enables all log modules.
+
+Use the LOG macro to put debug messages in the code.
+
+WARNINGS
+========
+
+At execution time, you must enable the service. To enable you to debug
+warnings, set the environment variable: EV_DEBUG_BREAK
+
+Possibe value for EV_DEBUG_BREAK variable:
+
+ stack Prints a stack trace.
+
+ suspend Use this to stop execution when a warning occurs.
+ You can then attach a debugger to the process.
+
+ trap Use this while running epiphany in a debugger.
+ This makes execution stop and gives back control to
+ the debugger.
+
+
+PROFILING
+=========
+
+At execution time, you must enable the profiling service. To enable the
+profiling service, set the environment variable: EV_PROFILING_MODULES
+
+EV_PROFILE_MODULES variable has the form:
+
+ <moduleName>[:<moduleName>]*
+
+moduleName is a filename.
+ex: export EV_PROFILE_MODULES=ephy-window.c:ephy-autocompletion.c
+The special profiling module "all" enables all profiling modules.
+
+Use START_PROFILER STOP_PROFILER macros to profile pieces of code.