svn: /phpdoc/en/trunk/reference/mysqlnd/ config.xml

abedford Mon, 15 Nov 2010 16:10:25 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=305372 Log: Added information on mysqlnd.debug option format string, and new profiling option. Changed paths: U phpdoc/en/trunk/reference/mysqlnd/config.xml Modified: phpdoc/en/trunk/reference/mysqlnd/config.xml =================================================================== --- phpdoc/en/trunk/reference/mysqlnd/config.xml 2010-11-15 14:51:26 UTC (rev 305371) +++ phpdoc/en/trunk/reference/mysqlnd/config.xml 2010-11-15 16:10:25 UTC (rev 305372) @@ -109,14 +109,111 @@ </varlistentry> <varlistentry xml:id="mysqlnd.debug"> <term> - <parameter>mysqlnd.debug</parameter> <type>boolean</type> + <parameter>mysqlnd.debug</parameter> <type>string</type> </term> <listitem> <para> - Records everything from all extensions using - <literal>mysqlnd</literal>. Only available with a debug build of - PHP. + Records communication from all extensions using + <literal>mysqlnd</literal> to the specified log file. </para> + <para> + The format of the directive is <literal>mysqlnd.debug = + "option1[,parameter_option1][:option2[,parameter_option2]]"</literal>. + </para> + <para> + The options for the format string are as follows: + </para> + <itemizedlist> + <listitem> + <para> + A[,file] - Appends trace output to specified file. Also ensures + that data is written after each write. This is done by closing + and reopening the trace file (this is slow). It helps ensure a + complete log file should the application crash. + </para> + </listitem> + <listitem> + <para> + a[,file] - Appends trace output to the specified file. + </para> + </listitem> + <listitem> + <para> + d - Enables output from DBUG_&lt;N&gt; macros for the current + state. May be followed by a list of keywords which selects + output only for the DBUG macros with that keyword. An empty list + of keywords implies output for all macros. + </para> + </listitem> + <listitem> + <para> + f[,functions] - Limits debugger actions to the specified list of + functions. An empty list of functions implies that all functions + are selected. + </para> + </listitem> + <listitem> + <para> + F - Marks each debugger output line with the name of the source + file containing the macro causing the output. + </para> + </listitem> + <listitem> + <para> + i - Marks each debugger output line with the PID of the current + process. + </para> + </listitem> + <listitem> + <para> + L - Marks each debugger output line with the name of the source + file line number of the macro causing the output. + </para> + </listitem> + <listitem> + <para> + n - Marks each debugger output line with the current function + nesting depth + </para> + </listitem> + <listitem> + <para> + o[,file] - Similar to a[,file] but overwrites old file, and does + not append. + </para> + </listitem> + <listitem> + <para> + O[,file] - Similar to A[,file] but overwrites old file, and does + not append. + </para> + </listitem> + <listitem> + <para> + t[,N] - Enables function control flow tracing. The maximum + nesting depth is specified by N, and defaults to 200. + </para> + </listitem> + <listitem> + <para> + x - This option activates profiling. + </para> + </listitem> + </itemizedlist> + <para> + Example: + </para> +<programlisting> +d:t:x:O,/tmp/mysqlnd.trace +</programlisting> + <note> + <para> + This feature is only available with a debug build of PHP. Works + on Microsoft Windows if using a debug build of PHP and PHP was + built using Microsoft Visual C version 9 and above. + </para> + </note> + <para></para> </listitem> </varlistentry> <varlistentry xml:id="mysqlnd.net_read_timeout">