From 16ebda50ec3b3ab96d9bbc3c8e8522b269ef1191 Mon Sep 17 00:00:00 2001
From: Marco Pesenti Gritti <marco@gnome.org>
Date: Mon, 07 Feb 2005 21:11:11 +0000
Subject: Add debugging helpers

2005-02-07  Marco Pesenti Gritti  <marco@gnome.org>

        * Makefile.am:
        * configure.ac:
        * doc/debugging.txt:
        * lib/.cvsignore:
        * lib/Makefile.am:
        * lib/ev-debug.c: (log_module), (trap_handler), (ev_debug_init),
        (ev_profiler_new), (ev_should_profile), (ev_profiler_dump),
        (ev_profiler_free), (ev_profiler_start), (ev_profiler_stop):
        * lib/ev-debug.h:

        Add debugging helpers

        * ps/Makefile.am:
        * ps/ps-document.c: (set_up_page), (start_interpreter),
        (stop_interpreter), (document_load), (ps_document_next_page),
        (ps_document_goto_page), (ps_document_set_page_size),
        (ps_document_widget_event), (ps_document_render):
        * shell/Makefile.am:
        * shell/ev-view.c: (expose_bin_window):
        * shell/main.c: (main):

        Add some logs
---
(limited to 'doc')

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.
--
cgit v0.9.1