Author: paul
Date: 2007-01-30 22:23:52 +0100 (Tue, 30 Jan 2007)
New Revision: 4698
Log:
r19042@polar: paul | 2007-01-30 15:12:57 -0600
Less chattiness about mysql_server_xxx.
Other minor rewording.
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:19041
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:15513
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:15513
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-30 21:23:37 UTC (rev 4697)
+++ trunk/refman-4.1/apis.xml 2007-01-30 21:23:52 UTC (rev 4698)
Changed blocks: 4, Lines Added: 18, Lines Deleted: 24; 3920 bytes
@@ -1681,11 +1681,12 @@
<listitem>
<para>
Initialize the MySQL library by calling
- <literal>mysql_library_init()</literal>. The library can be
- either the <literal>mysqlclient</literal> C client library
- or the <literal>mysqld</literal> embedded server library,
- depending on whether the application was linked with the
- <option>-libmysqlclient</option> or
+ <literal>mysql_library_init()</literal>. This function
+ exists in both the <literal>mysqlclient</literal> C client
+ library and the <literal>mysqld</literal> embedded server
+ library, so it is used whether you build a regular client
+ program by linking with the <option>-libmysqlclient</option>
+ flag, or an embedded server application by linking with the
<option>-libmysqld</option> flag.
</para>
</listitem>
@@ -1738,15 +1739,8 @@
<para>
<literal>mysql_library_init()</literal> and
<literal>mysql_library_end()</literal> are available as of MySQL
- 4.1.10. These are actually <literal>#define</literal> symbols
- that make them equivalent to
+ 4.1.10. For older versions of MySQL, you can call
<literal>mysql_server_init()</literal> and
- <literal>mysql_server_end()</literal>, but the names more
- clearly indicate that they should be called when beginning and
- ending use of a MySQL library no matter whether the application
- uses the <literal>mysqlclient</literal> or
- <literal>mysqld</literal> library. For older versions of MySQL,
- you can call <literal>mysql_server_init()</literal> and
<literal>mysql_server_end()</literal> instead.
</para>
@@ -1754,9 +1748,9 @@
In a non-multi-threaded environment, the call to
<literal>mysql_library_init()</literal> may be omitted, because
<literal>mysql_init()</literal> will invoke it automatically as
- necessary. However, a race condition is possible if
- <literal>mysql_library_init()</literal> is invoked by
- <literal>mysql_init()</literal> in a multi-threaded environment:
+ necessary. However, in a multi-threaded environment, a race
+ condition is possible if <literal>mysql_library_init()</literal>
+ is invoked by <literal>mysql_init()</literal>:
<literal>mysql_library_init()</literal> is not thread-safe, so
it should be called prior to any other client library call.
</para>
@@ -12759,14 +12753,14 @@
<para>
In a non-multi-threaded environment, the call to
- <literal>mysql_server_init()</literal> may be omitted, because
- <literal>mysql_init()</literal> will invoke it automatically
- as necessary. However, a race condition is possible if
- <literal>mysql_server_init()</literal> is invoked by
- <literal>mysql_init()</literal> in a multi-threaded
- environment: <literal>mysql_server_init()</literal> is not
- thread-safe, so it should be called prior to any other client
- library call.
+ <literal>mysql_library_init()</literal> may be omitted,
+ because <literal>mysql_init()</literal> will invoke it
+ automatically as necessary. However, in a multi-threaded
+ environment, a race condition is possible if
+ <literal>mysql_library_init()</literal> is invoked by
+ <literal>mysql_init()</literal>:
+ <literal>mysql_library_init()</literal> is not thread-safe, so
+ it should be called prior to any other client library call.
</para>
<para>
Modified: trunk/refman-5.0/apis.xml
===================================================================
--- trunk/refman-5.0/apis.xml 2007-01-30 21:23:37 UTC (rev 4697)
+++ trunk/refman-5.0/apis.xml 2007-01-30 21:23:52 UTC (rev 4698)
Changed blocks: 4, Lines Added: 18, Lines Deleted: 24; 3918 bytes
@@ -1219,11 +1219,12 @@
<listitem>
<para>
Initialize the MySQL library by calling
- <literal>mysql_library_init()</literal>. The library can be
- either the <literal>mysqlclient</literal> C client library
- or the <literal>mysqld</literal> embedded server library,
- depending on whether the application was linked with the
- <option>-libmysqlclient</option> or
+ <literal>mysql_library_init()</literal>. This function
+ exists in both the <literal>mysqlclient</literal> C client
+ library and the <literal>mysqld</literal> embedded server
+ library, so it is used whether you build a regular client
+ program by linking with the <option>-libmysqlclient</option>
+ flag, or an embedded server application by linking with the
<option>-libmysqld</option> flag.
</para>
</listitem>
@@ -1276,15 +1277,8 @@
<para>
<literal>mysql_library_init()</literal> and
<literal>mysql_library_end()</literal> are available as of MySQL
- 5.0.3. These actually are <literal>#define</literal> symbols
- that make them equivalent to
+ 5.0.3. For older versions of MySQL, you can call
<literal>mysql_server_init()</literal> and
- <literal>mysql_server_end()</literal>, but the names more
- clearly indicate that they should be called when beginning and
- ending use of a MySQL library no matter whether the application
- uses the <literal>mysqlclient</literal> or
- <literal>mysqld</literal> library. For older versions of MySQL,
- you can call <literal>mysql_server_init()</literal> and
<literal>mysql_server_end()</literal> instead.
</para>
@@ -1292,9 +1286,9 @@
In a non-multi-threaded environment, the call to
<literal>mysql_library_init()</literal> may be omitted, because
<literal>mysql_init()</literal> will invoke it automatically as
- necessary. However, a race condition is possible if
- <literal>mysql_library_init()</literal> is invoked by
- <literal>mysql_init()</literal> in a multi-threaded environment:
+ necessary. However, in a multi-threaded environment, a race
+ condition is possible if <literal>mysql_library_init()</literal>
+ is invoked by <literal>mysql_init()</literal>:
<literal>mysql_library_init()</literal> is not thread-safe, so
it should be called prior to any other client library call.
</para>
@@ -12408,14 +12402,14 @@
<para>
In a non-multi-threaded environment, the call to
- <literal>mysql_server_init()</literal> may be omitted, because
- <literal>mysql_init()</literal> will invoke it automatically
- as necessary. However, a race condition is possible if
- <literal>mysql_server_init()</literal> is invoked by
- <literal>mysql_init()</literal> in a multi-threaded
- environment: <literal>mysql_server_init()</literal> is not
- thread-safe, so it should be called prior to any other client
- library call.
+ <literal>mysql_library_init()</literal> may be omitted,
+ because <literal>mysql_init()</literal> will invoke it
+ automatically as necessary. However, in a multi-threaded
+ environment, a race condition is possible if
+ <literal>mysql_library_init()</literal> is invoked by
+ <literal>mysql_init()</literal>:
+ <literal>mysql_library_init()</literal> is not thread-safe, so
+ it should be called prior to any other client library call.
</para>
<para>
Modified: trunk/refman-5.1/apis-c.xml
===================================================================
--- trunk/refman-5.1/apis-c.xml 2007-01-30 21:23:37 UTC (rev 4697)
+++ trunk/refman-5.1/apis-c.xml 2007-01-30 21:23:52 UTC (rev 4698)
Changed blocks: 3, Lines Added: 15, Lines Deleted: 28; 3612 bytes
@@ -1072,11 +1072,12 @@
<listitem>
<para>
Initialize the MySQL library by calling
- <literal>mysql_library_init()</literal>. The library can be
- either the <literal>mysqlclient</literal> C client library or
- the <literal>mysqld</literal> embedded server library,
- depending on whether the application was linked with the
- <option>-libmysqlclient</option> or
+ <literal>mysql_library_init()</literal>. This function exists
+ in both the <literal>mysqlclient</literal> C client library
+ and the <literal>mysqld</literal> embedded server library, so
+ it is used whether you build a regular client program by
+ linking with the <option>-libmysqlclient</option> flag, or an
+ embedded server application by linking with the
<option>-libmysqld</option> flag.
</para>
</listitem>
@@ -1126,26 +1127,12 @@
</para>
<para>
- <literal>mysql_library_init()</literal> and
- <literal>mysql_library_end()</literal> are actually
- <literal>#define</literal> symbols that make them equivalent to
- <literal>mysql_server_init()</literal> and
- <literal>mysql_server_end()</literal>, but the names more clearly
- indicate that they should be called when beginning and ending use
- of a MySQL library no matter whether the application uses the
- <literal>mysqlclient</literal> or <literal>mysqld</literal>
- library. For older versions of MySQL, you can call
- <literal>mysql_server_init()</literal> and
- <literal>mysql_server_end()</literal> instead.
- </para>
-
- <para>
In a non-multi-threaded environment, the call to
<literal>mysql_library_init()</literal> may be omitted, because
<literal>mysql_init()</literal> will invoke it automatically as
- necessary. However, a race condition is possible if
- <literal>mysql_library_init()</literal> is invoked by
- <literal>mysql_init()</literal> in a multi-threaded environment:
+ necessary. However, in a multi-threaded environment, a race
+ condition is possible if <literal>mysql_library_init()</literal>
+ is invoked by <literal>mysql_init()</literal>:
<literal>mysql_library_init()</literal> is not thread-safe, so it
should be called prior to any other client library call.
</para>
@@ -12222,13 +12209,13 @@
<para>
In a non-multi-threaded environment, the call to
- <literal>mysql_server_init()</literal> may be omitted, because
+ <literal>mysql_library_init()</literal> may be omitted, because
<literal>mysql_init()</literal> will invoke it automatically as
- necessary. However, a race condition is possible if
- <literal>mysql_server_init()</literal> is invoked by
- <literal>mysql_init()</literal> in a multi-threaded environment:
- <literal>mysql_server_init()</literal> is not thread-safe, so it
- should be called prior to any other client library call.
+ necessary. However, in a multi-threaded environment, a race
+ condition is possible if <literal>mysql_library_init()</literal>
+ is invoked by <literal>mysql_init()</literal>:
+ <literal>mysql_library_init()</literal> is not thread-safe, so
+ it should be called prior to any other client library call.
</para>
<para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r4698 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | paul | 30 Jan |
