[xdebug-dev] svn: /xdebug/trunk/ xdebug.ini

derick Wed, 30 Mar 2011 21:40:35 +0000

Revision: http://svn.xdebug.org/cgi-bin/viewvc.cgi?view=rev&revision=3435&root=xdebug

Log:
- Added a "generated file" header.
- Added missing ini entries: xdebug.cli_color, xdebug.coverage_enable,
  xdebug.remote_cookie_expire_time, xdebug.trace_enable_trigger.
- Added the %U modifier to file name formatting specifiers.
- Fixed typoes.

Changed paths:
    U xdebug/trunk/xdebug.ini

Modified: xdebug/trunk/xdebug.ini
===================================================================
--- xdebug/trunk/xdebug.ini 2011-03-30 20:36:20 UTC (rev 3434)
+++ xdebug/trunk/xdebug.ini 2011-03-30 21:40:35 UTC (rev 3435)
@@ -1,3 +1,5 @@
+; This is a generated file, do not modify by hand
+
 ; -----------------------------------------------------------------------------
 ; xdebug.auto_trace
 ;
@@ -13,6 +15,17 @@
 ;xdebug.auto_trace = 0

 ; -----------------------------------------------------------------------------
+; xdebug.cli_color
+;
+; Type: boolean, Default value: 0
+;
+; If this setting is 1, Xdebug will color var_dumps and stack traces output when
+; in CLI mode.
+;
+;
+;xdebug.cli_color = 0
+
+; -----------------------------------------------------------------------------
 ; xdebug.collect_assignments
 ;
 ; Type: boolean, Default value: 0
@@ -106,6 +119,18 @@
 ;xdebug.collect_vars = 0

 ; -----------------------------------------------------------------------------
+; xdebug.coverage_enable
+;
+; Type: boolean, Default value: 1
+;
+; If this setting is set to 0, then Xdebug will not set-up internal structures
+; to allow code coverage. This speeds up Xdebug quite a bit, but of course, Code
+; Coverage Analysis won't work.
+;
+;
+;xdebug.coverage_enable = 1
+
+; -----------------------------------------------------------------------------
 ; xdebug.default_enable
 ;
 ; Type: boolean, Default value: 1
@@ -206,6 +231,35 @@
 ; %l the line number
 ; ========= ===============
 ;
+; To make file/line links work with FireFox (Linux), use the following steps:
+;
+; - Open
+;
+; about:config
+;
+; - Add a new boolean setting "network.protocol-handler.expose.xdebug"
+;
+; - Add the following into a shell script "~/bin/ff-xdebug.sh":
+;
+; #! /bin/sh
+;
+; f=`echo $1 | cut -d @ -f 1 | sed 's/xdebug:\/\///'`
+; l=`echo $1 | cut -d @ -f 2`
+;
+; Add to that one of (depending whether you have komodo or gvim):
+;
+; - komodo $f -l $l
+;
+; - gvim --remote-tab +$l $f
+;
+; - Make the script executable with
+;
+; chmod +x ~/bin/ff-xdebug.sh
+;
+; - Set the xdebug.file_link_format to
+;
+; xdebug://%f@%l
+;
 ;
 ;xdebug.file_link_format =

@@ -293,10 +347,10 @@
 ; Type: integer, Default value: 0
 ;
 ; When this setting is set to 1, you can trigger the generation of profiler
-; files by using the XDEBUG_PROFILE GET/POST parameter, or send a cookie with
-; the name XDEBUG_PROFILE. This will then write the profiler data to defined
+; files by using the XDEBUG_PROFILE GET/POST parameter, or set a cookie with the
+; name XDEBUG_PROFILE. This will then write the profiler data to defined
 ; directory. In order to prevent the profiler to generate profile files for each
-; request, you need to set xdebug.profile_enable to 0.
+; request, you need to set xdebug.profiler_enable to 0.
 ;
 ;
 ;xdebug.profiler_enable_trigger = 0
@@ -346,16 +400,28 @@
 ;
 ; Type: boolean, Default value: 0
 ;
-; If enable, the xdebug.remote_host setting is ignored and Xdebug will try to
+; If enabled, the xdebug.remote_host setting is ignored and Xdebug will try to
 ; connect to the client that made the HTTP request. It checks the
 ; $_SERVER['REMOTE_ADDR'] variable to find out which IP address to use. Please
 ; note that there is **no** filter available, and anybody who can connect to the
-; webserver will then be able to start a debugging session.
+; webserver will then be able to start a debugging session, even if their
+; address does not match xdebug.remote_host.
 ;
 ;
 ;xdebug.remote_connect_back = 0

 ; -----------------------------------------------------------------------------
+; xdebug.remote_cookie_expire_time
+;
+; Type: integer, Default value: 3600
+;
+; This setting can be used to increase (or decrease) the time that the remote
+; debugging session stays alive via the session cookie.
+;
+;
+;xdebug.remote_cookie_expire_time = 3600
+
+; -----------------------------------------------------------------------------
 ; xdebug.remote_enable
 ;
 ; Type: boolean, Default value: 0
@@ -392,7 +458,8 @@
 ; Type: string, Default value: localhost
 ;
 ; Selects the host where the debug client is running, you can either use a host
-; name or an IP address.
+; name or an IP address. This setting is ignored if xdebug.remote_connect_back
+; is enabled.
 ;
 ;
 ;xdebug.remote_host = localhost
@@ -496,6 +563,20 @@
 ;xdebug.show_mem_delta = 0

 ; -----------------------------------------------------------------------------
+; xdebug.trace_enable_trigger
+;
+; Type: boolean, Default value: 0
+;
+; When this setting is set to 1, you can trigger the generation of trace files
+; by using the XDEBUG_TRACE GET/POST parameter, or set a cookie with the name
+; XDEBUG_TRACE. This will then write the trace data to defined directory. In
+; order to prevent Xdebug to generate trace files for each request, you need to
+; set xdebug.auto_trace to 0.
+;
+;
+;xdebug.trace_enable_trigger = 0
+
+; -----------------------------------------------------------------------------
 ; xdebug.trace_format
 ;
 ; Type: integer, Default value: 0
@@ -586,13 +667,21 @@
 ; --------- -------------------------------------- ----------------- ----------------------------------------------------
 ; %R $_SERVER['REQUEST_URI'] trace.%R trace._test_xdebug_test_php_var=1_var2=2.xt
 ; --------- -------------------------------------- ----------------- ----------------------------------------------------
+; %U $_SERVER['UNIQUE_ID'] trace.%U trace.TRX4n38AAAEAAB9gBFkAAAAB.xt
+;
+; 3
+; --------- -------------------------------------- ----------------- ----------------------------------------------------
 ; %S session_id (from $_COOKIE if set) trace.%S trace.c70c1ec2375af58f74b390bbdd2a679d.xt
 ; --------- -------------------------------------- ----------------- ----------------------------------------------------
 ; %% literal % trace.%% trace.%%.xt
 ; ========= ====================================== ================= ====================================================
 ;
-; 2 this one is not available for trace file names.
+; 2 This one is not available for trace file names.
 ;
+; 3 New in version 2.2. This one is set by Apache's mod_unique_id module [1]
+;
+; [1] http://httpd.apache.org/docs/2.2/en/mod/mod_unique_id.html
+;
 ;
 ;xdebug.trace_output_name = trace.%c

Received on Wed Mar 30 2011 - 22:40:35 BST