Author: paul
Date: 2007-01-31 18:32:14 +0100 (Wed, 31 Jan 2007)
New Revision: 4713
Log:
r15588@frost: paul | 2007-01-31 11:30:17 -0600
Emphasize mysql_library_{init,end}, de-emphasize mysql_server_{init,end}.
Modified:
trunk/refman-4.1/apis.xml
trunk/refman-5.0/apis.xml
trunk/refman-5.1/apis-c.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:19042
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:15581
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:13520
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:19042
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:15588
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:13520
Modified: trunk/refman-4.1/apis.xml
===================================================================
--- trunk/refman-4.1/apis.xml 2007-01-31 16:58:39 UTC (rev 4712)
+++ trunk/refman-4.1/apis.xml 2007-01-31 17:32:14 UTC (rev 4713)
Changed blocks: 4, Lines Added: 37, Lines Deleted: 10; 3124 bytes
@@ -4590,16 +4590,33 @@
</para>
<para>
- This is a synonym for the
- <literal>mysql_server_end()</literal> function. It was added
- in MySQL 4.1.10.
+ This function finalizes the MySQL library. You should call it
+ when you are done using the library (for example, after
+ disconnecting from the server). The action taken by the call
+ depends on whether your application is linked to the MySQL
+ client library or the MySQL embedded server library. For a
+ client program linked against the
+ <literal>libmysqlclient</literal> library by using the
+ <option>-lmysqlclient</option> flag,
+ <literal>mysql_library_end()</literal> performs some memory
+ management to clean up. For an embedded server application
+ linked against the <literal>libmysqld</literal> library by
+ using the <option>-lmysqld</option> flag,
+ <literal>mysql_library_end()</literal> shuts down the embedded
+ server and then cleans up.
</para>
<para>
- See <xref linkend="c-api-function-overview"/>, for usage
- information.
+ See <xref linkend="c-api-function-overview"/>, and
+ <xref linkend="mysql-library-init"/>, for usage information.
</para>
+ <para>
+ <literal>mysql_library_end()</literal> was added in MySQL
+ 4.1.10. For older versions of MySQL, call
+ <literal>mysql_server_end()</literal> instead.
+ </para>
+
</section>
<section id="mysql-library-init">
@@ -4621,8 +4638,7 @@
<para>
This is a synonym for the
- <literal>mysql_server_init()</literal> function. It was added
- in MySQL 4.1.10.
+ <literal>mysql_server_init()</literal> function.
</para>
<para>
@@ -4630,6 +4646,12 @@
information.
</para>
+ <para>
+ <literal>mysql_library_init()</literal> was added in MySQL
+ 4.1.10. For older versions of MySQL, call
+ <literal>mysql_server_init()</literal> instead.
+ </para>
+
</section>
<section id="mysql-list-dbs">
@@ -12864,12 +12886,17 @@
</para>
<para>
- This function <emphasis role="bold">must</emphasis> be called
- once in the program after all other MySQL functions. It shuts
- down the embedded server.
+ This function finalizes the MySQL library. You should call it
+ when you are done using the library.
</para>
<para>
+ As of MySQL 4.1.10, <literal>mysql_server_end()</literal> is
+ deprecated and <literal>mysql_library_end()</literal> should
+ be used instead. See <xref linkend="mysql-library-end"/>.
+ </para>
+
+ <para>
<emphasis role="bold">Return Values</emphasis>
</para>
Modified: trunk/refman-5.0/apis.xml
===================================================================
--- trunk/refman-5.0/apis.xml 2007-01-31 16:58:39 UTC (rev 4712)
+++ trunk/refman-5.0/apis.xml 2007-01-31 17:32:14 UTC (rev 4713)
Changed blocks: 3, Lines Added: 38, Lines Deleted: 11; 3273 bytes
@@ -4199,16 +4199,33 @@
</para>
<para>
- This is a synonym for the
- <literal>mysql_server_end()</literal> function. It was added
- in MySQL 5.0.3.
+ This function finalizes the MySQL library. You should call it
+ when you are done using the library (for example, after
+ disconnecting from the server). The action taken by the call
+ depends on whether your application is linked to the MySQL
+ client library or the MySQL embedded server library. For a
+ client program linked against the
+ <literal>libmysqlclient</literal> library by using the
+ <option>-lmysqlclient</option> flag,
+ <literal>mysql_library_end()</literal> performs some memory
+ management to clean up. For an embedded server application
+ linked against the <literal>libmysqld</literal> library by
+ using the <option>-lmysqld</option> flag,
+ <literal>mysql_library_end()</literal> shuts down the embedded
+ server and then cleans up.
</para>
<para>
- See <xref linkend="c-api-function-overview"/>, for usage
- information.
+ See <xref linkend="c-api-function-overview"/>, and
+ <xref linkend="mysql-library-init"/>, for usage information.
</para>
+ <para>
+ <literal>mysql_library_end()</literal> was added in MySQL
+ 5.0.3. For older versions of MySQL, call
+ <literal>mysql_server_end()</literal> instead.
+ </para>
+
</section>
<section id="mysql-library-init">
@@ -4230,15 +4247,20 @@
<para>
This is a synonym for the
- <literal>mysql_server_init()</literal> function. It was added
- in MySQL 5.0.3. See <xref linkend="mysql-server-init"/>.
+ <literal>mysql_server_init()</literal> function.
</para>
<para>
- See <xref linkend="c-api-function-overview"/> for usage
+ See <xref linkend="c-api-function-overview"/>, for usage
information.
</para>
+ <para>
+ <literal>mysql_library_init()</literal> was added in MySQL
+ 5.0.3. For older versions of MySQL, call
+ <literal>mysql_server_init()</literal> instead.
+ </para>
+
</section>
<section id="mysql-list-dbs">
@@ -12513,12 +12535,17 @@
</para>
<para>
- This function <emphasis role="bold">must</emphasis> be called
- once in the program after all other MySQL functions. It shuts
- down the embedded server.
+ This function finalizes the MySQL library. You should call it
+ when you are done using the library.
</para>
<para>
+ As of MySQL 5.0.3, <literal>mysql_server_end()</literal> is
+ deprecated and <literal>mysql_library_end()</literal> should
+ be used instead. See <xref linkend="mysql-library-end"/>.
+ </para>
+
+ <para>
<emphasis role="bold">Return Values</emphasis>
</para>
Modified: trunk/refman-5.1/apis-c.xml
===================================================================
--- trunk/refman-5.1/apis-c.xml 2007-01-31 16:58:39 UTC (rev 4712)
+++ trunk/refman-5.1/apis-c.xml 2007-01-31 17:32:14 UTC (rev 4713)
Changed blocks: 3, Lines Added: 21, Lines Deleted: 8; 2205 bytes
@@ -4081,13 +4081,25 @@
</para>
<para>
- This is a synonym for the <literal>mysql_server_end()</literal>
- function.
+ This function finalizes the MySQL library. You should call it
+ when you are done using the library (for example, after
+ disconnecting from the server). The action taken by the call
+ depends on whether your application is linked to the MySQL
+ client library or the MySQL embedded server library. For a
+ client program linked against the
+ <literal>libmysqlclient</literal> library by using the
+ <option>-lmysqlclient</option> flag,
+ <literal>mysql_library_end()</literal> performs some memory
+ management to clean up. For an embedded server application
+ linked against the <literal>libmysqld</literal> library by using
+ the <option>-lmysqld</option> flag,
+ <literal>mysql_library_end()</literal> shuts down the embedded
+ server and then cleans up.
</para>
<para>
- See <xref linkend="c-api-function-overview"/>, for usage
- information.
+ See <xref linkend="c-api-function-overview"/>, and
+ <xref linkend="mysql-library-init"/>, for usage information.
</para>
</section>
@@ -4111,7 +4123,7 @@
<para>
This is a synonym for the <literal>mysql_server_init()</literal>
- function. See <xref linkend="mysql-server-init"/>.
+ function.
</para>
<para>
@@ -12302,9 +12314,10 @@
</para>
<para>
- This function <emphasis role="bold">must</emphasis> be called
- once in the program after all other MySQL functions. It shuts
- down the embedded server.
+ This function finalizes the MySQL library. However,
+ <literal>mysql_server_end()</literal> is deprecated and
+ <literal>mysql_library_end()</literal> should be used instead.
+ See <xref linkend="mysql-library-end"/>.
</para>
<para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r4713 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | paul | 31 Jan |
