cvs: phpdoc /en/appendices debugger.xml

goba Sat Nov 10 11:33:04 2001 EDT Modified files: /phpdoc/en/appendices debugger.xml Log: Clarify, that this is not general PHP, but always PHP 3 only. Index: phpdoc/en/appendices/debugger.xml diff -u phpdoc/en/appendices/debugger.xml:1.11 phpdoc/en/appendices/debugger.xml:1.12 --- phpdoc/en/appendices/debugger.xml:1.11 Fri Sep 21 18:47:29 2001 +++ phpdoc/en/appendices/debugger.xml Sat Nov 10 11:33:04 2001 @@ -1,5 +1,5 @@ <?xml encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <appendix id="debugger"> <title>The PHP Debugger</title> @@ -17,11 +17,12 @@ <title>Using the Debugger</title> <para> - PHP's internal debugger is useful for tracking down evasive bugs. - The debugger works by connecting to a <acronym>TCP</acronym> port - for every time PHP starts up. All error messages from that - request will be sent to this TCP connection. This information is - intended for "debugging server" that can run inside an + The internal debugger in PHP 3 is useful for tracking down + evasive bugs. The debugger works by connecting to a + <acronym>TCP</acronym> port for every time PHP starts up. + All error messages from that request will be sent to this + TCP connection. This information is intended for + "debugging server" that can run inside an <acronym>IDE</acronym> or programmable editor (such as Emacs). </para> <para> @@ -59,11 +60,11 @@ <sect1 id="debugger-protocol"> <title>Debugger Protocol</title> <para> - The debugger protocol is line-based. Each line has a + The PHP 3 debugger protocol is line-based. Each line has a <emphasis>type</emphasis>, and several lines compose a - <emphasis>message</emphasis>. Each message starts with a line of + <emphasis>message</emphasis>. Each message starts with a line of the type <literal>start</literal> and terminates with a line of - the type <literal>end</literal>. PHP may send lines for different + the type <literal>end</literal>. PHP 3 may send lines for different messages simultaneously. </para> <para> @@ -116,7 +117,7 @@ <term><replaceable>type</replaceable></term> <listitem> <para> - Type of line. Tells the receiving program about what it + Type of line. Tells the receiving program about what it should treat the following data as: <table> <title>Debugger Line Types</title> @@ -132,19 +133,19 @@ <entry><literal>start</literal></entry> <entry> Tells the receiving program that a debugger message - starts here. The contents of + starts here. The contents of <replaceable>data</replaceable> will be the type of error message, listed below. </entry> </row> <row> <entry><literal>message</literal></entry> - <entry>The PHP error message.</entry> + <entry>The PHP 3 error message.</entry> </row> <row> <entry><literal>location</literal></entry> <entry> - File name and line number where the error occured. The + File name and line number where the error occured. The first <literal>location</literal> line will always contain the top-level location. <replaceable>data</replaceable> will contain @@ -157,7 +158,7 @@ <row> <entry> <literal>frames</literal></entry> <entry>Number of frames - in the following stack dump. If there are four frames, + in the following stack dump. If there are four frames, expect information about four levels of called functions. If no "frames" line is given, the depth should be assumed to be 0 (the error occured at top-level). @@ -167,7 +168,7 @@ <entry> <literal>function</literal></entry> <entry> - Name of function where the error occured. Will be + Name of function where the error occured. Will be repeated once for every level in the function call stack. </entry>