reference/mysqli/mysqli/debug.xml
637983e27b0678e3006a879c4d1a50b2e82e8dd3
...
...
@@ -10,13 +10,13 @@
10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
12
<para>&style.oop;</para>
13
-
<methodsynopsis role="oop">
14
-
<modifier>public</modifier> <type>bool</type><methodname>mysqli::debug</methodname>
13
+
<methodsynopsis role="mysqli">
14
+
<modifier>public</modifier> <type>true</type><methodname>mysqli::debug</methodname>
15
15
<methodparam><type>string</type><parameter>options</parameter></methodparam>
16
16
</methodsynopsis>
17
17
<para>&style.procedural;</para>
18
-
<methodsynopsis role="procedural">
19
-
<type>bool</type><methodname>mysqli_debug</methodname>
18
+
<methodsynopsis>
19
+
<type>true</type><methodname>mysqli_debug</methodname>
20
20
<methodparam><type>string</type><parameter>options</parameter></methodparam>
21
21
</methodsynopsis>
22
22
<para>
...
...
@@ -34,6 +34,71 @@
34
34
<para>
35
35
A string representing the debugging operation to perform
36
36
</para>
37
+
<para>
38
+
The debug control string is a sequence of colon separated fields as follows:
39
+
<literal><![CDATA[<field_1>:<field_2>:<field_N>]]></literal>
40
+
Each field consists of a mandatory flag character followed by an optional <literal>,</literal> and comma separated list of modifiers:
41
+
<literal>flag[,modifier,modifier,...,modifier]</literal>
42
+
</para>
43
+
<para>
44
+
<table>
45
+
<title>Recognized Flag Characters</title>
46
+
<tgroup cols="2">
47
+
<thead>
48
+
<row>
49
+
<entry><parameter>options</parameter> character</entry>
50
+
<entry>Description</entry>
51
+
</row>
52
+
</thead>
53
+
<tbody>
54
+
<row>
55
+
<entry>O</entry>
56
+
<entry><constant>MYSQLND_DEBUG_FLUSH</constant></entry>
57
+
</row>
58
+
<row>
59
+
<entry>A/a</entry>
60
+
<entry><constant>MYSQLND_DEBUG_APPEND</constant></entry>
61
+
</row>
62
+
<row>
63
+
<entry>F</entry>
64
+
<entry><constant>MYSQLND_DEBUG_DUMP_FILE</constant></entry>
65
+
</row>
66
+
<row>
67
+
<entry>i</entry>
68
+
<entry><constant>MYSQLND_DEBUG_DUMP_PID</constant></entry>
69
+
</row>
70
+
<row>
71
+
<entry>L</entry>
72
+
<entry><constant>MYSQLND_DEBUG_DUMP_LINE</constant></entry>
73
+
</row>
74
+
<row>
75
+
<entry>m</entry>
76
+
<entry><constant>MYSQLND_DEBUG_TRACE_MEMORY_CALLS</constant></entry>
77
+
</row>
78
+
<row>
79
+
<entry>n</entry>
80
+
<entry><constant>MYSQLND_DEBUG_DUMP_LEVEL</constant></entry>
81
+
</row>
82
+
<row>
83
+
<entry>o</entry>
84
+
<entry>output to file</entry>
85
+
</row>
86
+
<row>
87
+
<entry>T</entry>
88
+
<entry><constant>MYSQLND_DEBUG_DUMP_TIME</constant></entry>
89
+
</row>
90
+
<row>
91
+
<entry>t</entry>
92
+
<entry><constant>MYSQLND_DEBUG_DUMP_TRACE</constant></entry>
93
+
</row>
94
+
<row>
95
+
<entry>x</entry>
96
+
<entry><constant>MYSQLND_DEBUG_PROFILE_CALLS</constant></entry>
97
+
</row>
98
+
</tbody>
99
+
</tgroup>
100
+
</table>
101
+
</para>
37
102
</listitem>
38
103
</varlistentry>
39
104
</variablelist>
...
...
@@ -43,7 +108,31 @@
43
108
<refsect1 role="returnvalues">
44
109
&reftitle.returnvalues;
45
110
<para>
46
-
Returns &true;.
111
+
&return.true.always;
112
+
</para>
113
+
</refsect1>
114
+

115
+
<refsect1 role="changelog">
116
+
&reftitle.changelog;
117
+
<para>
118
+
<informaltable>
119
+
<tgroup cols="2">
120
+
<thead>
121
+
<row>
122
+
<entry>&Version;</entry>
123
+
<entry>&Description;</entry>
124
+
</row>
125
+
</thead>
126
+
<tbody>
127
+
<row>
128
+
<entry>8.0.0</entry>
129
+
<entry>
130
+
This function now always returns &true;. Previously it returned &false; on failure.
131
+
</entry>
132
+
</row>
133
+
</tbody>
134
+
</tgroup>
135
+
</informaltable>
47
136
</para>
48
137
</refsect1>
49
138

50
139