aboutsummaryrefslogtreecommitdiffstats
path: root/doc/debugging.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/debugging.txt')
-rw-r--r--doc/debugging.txt35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/debugging.txt b/doc/debugging.txt
new file mode 100644
index 000000000..f991c81e9
--- /dev/null
+++ b/doc/debugging.txt
@@ -0,0 +1,35 @@
+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: EPHY_LOG_MODULES
+variable.
+
+EPHY_LOG_MODULES variable has the form:
+
+ <moduleName>[:<moduleName>]*
+
+moduleName is a filename.
+ex: export EPHY_LOG_MODULES=ephy-window.c:ephy-autocompletion.c
+The special log module "all" enables all log modules.
+
+Use the LOG macro to put debug messages in the code.
+
+PROFILING
+=========
+
+At execution time, you must enable the profiling service. To enable the
+profiling service, set the environment variable: EPHY_PROFILING_MODULES
+variable.
+
+EPHY_PROFILE_MODULES variable has the form:
+
+ <moduleName>[:<moduleName>]*
+
+moduleName is a filename.
+ex: export EPHY_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.