Author: paul
Date: 2007-01-30 22:23:22 +0100 (Tue, 30 Jan 2007)
New Revision: 4696
Log:
r19040@polar: paul | 2007-01-30 13:35:24 -0600
Prefer references to mysql_library_{init,end} over
mysql_server_{init,end} when possible.
Modified:
trunk/refman-4.1/apis.xml
trunk/refman-5.0/apis.xml
trunk/refman-5.1/apis-c.xml
trunk/refman-5.1/apis-libmysqld.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:18940
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:19040
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 19:22:44 UTC (rev 4695)
+++ trunk/refman-4.1/apis.xml 2007-01-30 21:23:22 UTC (rev 4696)
Changed blocks: 11, Lines Added: 20, Lines Deleted: 20; 5781 bytes
@@ -100,12 +100,12 @@
<entry><emphasis role="bold">When to Call</emphasis></entry>
</row>
<row>
- <entry><literal>mysql_server_init()</literal></entry>
+ <entry><literal>mysql_library_init()</literal></entry>
<entry>Should be called before any other MySQL function is called, preferably
early in the <literal>main()</literal> function.</entry>
</row>
<row>
- <entry><literal>mysql_server_end()</literal></entry>
+ <entry><literal>mysql_library_end()</literal></entry>
<entry>Should be called before your program exits.</entry>
</row>
<row>
@@ -128,12 +128,12 @@
<para>
The
- <literal>mysql_server_<replaceable>xxx</replaceable>()</literal>
+ <literal>mysql_library_<replaceable>xxx</replaceable>()</literal>
functions are also included in
<filename>libmysqlclient.a</filename> to allow you to change
between the embedded and the client/server version by just
linking your application with the right library. See
- <xref linkend="mysql-server-init"/>.
+ <xref linkend="mysql-library-init"/>.
</para>
<para>
@@ -302,14 +302,14 @@
Any options that may be given with the <command>mysqld</command>
server daemon, may be used with an embedded server library.
Server options may be given in an array as an argument to the
- <literal>mysql_server_init()</literal>, which initializes the
+ <literal>mysql_library_init()</literal>, which initializes the
server. They also may be given in an option file like
<filename>my.cnf</filename>. To specify an option file for a C
program, use the <option>--defaults-file</option> option as one
of the elements of the second argument of the
- <literal>mysql_server_init()</literal> function. See
- <xref linkend="mysql-server-init"/>, for more information on the
- <literal>mysql_server_init()</literal> function.
+ <literal>mysql_library_init()</literal> function. See
+ <xref linkend="mysql-library-init"/>, for more information on the
+ <literal>mysql_library_init()</literal> function.
</para>
<para>
@@ -369,7 +369,7 @@
int main(void)
{
- mysql_server_init(num_elements, server_options, server_groups);
+ mysql_library_init(num_elements, server_options, server_groups);
mysql = mysql_init(NULL);
mysql_options(mysql, MYSQL_READ_DEFAULT_GROUP, "libmysqld_client");
mysql_options(mysql, MYSQL_OPT_USE_EMBEDDED_CONNECTION, NULL);
@@ -386,7 +386,7 @@
mysql_free_result(results);
mysql_close(mysql);
- mysql_server_end();
+ mysql_library_end();
return 0;
}
@@ -442,10 +442,10 @@
{
MYSQL *one, *two;
- /* mysql_server_init() must be called before any other mysql
+ /* mysql_library_init() must be called before any other mysql
* functions.
*
- * You can use mysql_server_init(0, NULL, NULL), and it
+ * You can use mysql_library_init(0, NULL, NULL), and it
* initializes the server using groups = {
* "server", "embedded", NULL
* }.
@@ -464,7 +464,7 @@
* If you link this client against the normal mysqlclient
* library, this function is just a stub that does nothing.
*/
- mysql_server_init(argc, argv, (char **)server_groups);
+ mysql_library_init(argc, argv, (char **)server_groups);
one = db_connect("test");
two = db_connect(NULL);
@@ -476,7 +476,7 @@
mysql_close(one);
/* This must be called after all other mysql functions */
- mysql_server_end();
+ mysql_library_end();
exit(EXIT_SUCCESS);
}
@@ -1510,11 +1510,11 @@
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-library-end">mysql_library_end()</link></emphasis></entry>
- <entry>Finalize MySQL C API library.</entry>
+ <entry>Finalize the MySQL C API library.</entry>
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-library-init">mysql_library_init()</link></emphasis></entry>
- <entry>Initialize MySQL C API library.</entry>
+ <entry>Initialize the MySQL C API library.</entry>
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-list-dbs">mysql_list_dbs()</link></emphasis></entry>
@@ -1602,11 +1602,11 @@
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-server-end">mysql_server_end()</link></emphasis></entry>
- <entry>Finalize embedded server library.</entry>
+ <entry>Finalize the MySQL C API library.</entry>
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-server-init">mysql_server_init()</link></emphasis></entry>
- <entry>Initialize embedded server library.</entry>
+ <entry>Initialize the MySQL C API library.</entry>
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-set-local-infile-default">mysql_set_local_infile_default()</link></emphasis></entry>
@@ -12802,13 +12802,13 @@
};
int main(void) {
- if (mysql_server_init(sizeof(server_args) / sizeof(char *),
+ if (mysql_library_init(sizeof(server_args) / sizeof(char *),
server_args, server_groups))
exit(1);
/* Use any MySQL API functions here */
- mysql_server_end();
+ mysql_library_end();
return EXIT_SUCCESS;
}
Modified: trunk/refman-5.0/apis.xml
===================================================================
--- trunk/refman-5.0/apis.xml 2007-01-30 19:22:44 UTC (rev 4695)
+++ trunk/refman-5.0/apis.xml 2007-01-30 21:23:22 UTC (rev 4696)
Changed blocks: 6, Lines Added: 12, Lines Deleted: 12; 3950 bytes
@@ -104,12 +104,12 @@
<entry><emphasis role="bold">When to Call</emphasis></entry>
</row>
<row>
- <entry><literal>mysql_server_init()</literal></entry>
+ <entry><literal>mysql_library_init()</literal></entry>
<entry>Should be called before any other MySQL function is called, preferably
early in the <literal>main()</literal> function.</entry>
</row>
<row>
- <entry><literal>mysql_server_end()</literal></entry>
+ <entry><literal>mysql_library_end()</literal></entry>
<entry>Should be called before your program exits.</entry>
</row>
<row>
@@ -131,12 +131,12 @@
<para>
The
- <literal>mysql_server_<replaceable>xxx</replaceable>()</literal>
+ <literal>mysql_library_<replaceable>xxx</replaceable>()</literal>
functions are also included in
<filename>libmysqlclient.a</filename> to allow you to change
between the embedded and the client/server version by just linking
your application with the right library. See
- <xref linkend="mysql-server-init"/>.
+ <xref linkend="mysql-library-init"/>.
</para>
<para>
@@ -1048,11 +1048,11 @@
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-library-end">mysql_library_end()</link></emphasis></entry>
- <entry>Finalize MySQL C API library.</entry>
+ <entry>Finalize the MySQL C API library.</entry>
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-library-init">mysql_library_init()</link></emphasis></entry>
- <entry>Initialize MySQL C API library.</entry>
+ <entry>Initialize the MySQL C API library.</entry>
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-list-dbs">mysql_list_dbs()</link></emphasis></entry>
@@ -1140,11 +1140,11 @@
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-server-end">mysql_server_end()</link></emphasis></entry>
- <entry>Finalize embedded server library.</entry>
+ <entry>Finalize the MySQL C API library.</entry>
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-server-init">mysql_server_init()</link></emphasis></entry>
- <entry>Initialize embedded server library.</entry>
+ <entry>Initialize the MySQL C API library.</entry>
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-set-local-infile-default">mysql_set_local_infile_default()</link></emphasis></entry>
@@ -12451,13 +12451,13 @@
};
int main(void) {
- if (mysql_server_init(sizeof(server_args) / sizeof(char *),
+ if (mysql_library_init(sizeof(server_args) / sizeof(char *),
server_args, server_groups))
exit(1);
/* Use any MySQL API functions here */
- mysql_server_end();
+ mysql_library_end();
return EXIT_SUCCESS;
}
@@ -12874,11 +12874,11 @@
<para>
To avoid aborting the program when a connection terminates,
MySQL blocks <literal>SIGPIPE</literal> on the first call to
- <literal>mysql_server_init()</literal>,
+ <literal>mysql_library_init()</literal>,
<literal>mysql_init()</literal>, or
<literal>mysql_connect()</literal>. If you want to use your own
<literal>SIGPIPE</literal> handler, you should first call
- <literal>mysql_server_init()</literal> and then install your
+ <literal>mysql_library_init()</literal> and then install your
handler.
</para>
Modified: trunk/refman-5.1/apis-c.xml
===================================================================
--- trunk/refman-5.1/apis-c.xml 2007-01-30 19:22:44 UTC (rev 4695)
+++ trunk/refman-5.1/apis-c.xml 2007-01-30 21:23:22 UTC (rev 4696)
Changed blocks: 4, Lines Added: 8, Lines Deleted: 8; 2662 bytes
@@ -901,11 +901,11 @@
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-library-end">mysql_library_end()</link></emphasis></entry>
- <entry>Finalize MySQL C API library.</entry>
+ <entry>Finalize the MySQL C API library.</entry>
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-library-init">mysql_library_init()</link></emphasis></entry>
- <entry>Initialize MySQL C API library.</entry>
+ <entry>Initialize the MySQL C API library.</entry>
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-list-dbs">mysql_list_dbs()</link></emphasis></entry>
@@ -993,11 +993,11 @@
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-server-end">mysql_server_end()</link></emphasis></entry>
- <entry>Finalize embedded server library.</entry>
+ <entry>Finalize the MySQL C API library.</entry>
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-server-init">mysql_server_init()</link></emphasis></entry>
- <entry>Initialize embedded server library.</entry>
+ <entry>Initialize the MySQL C API library.</entry>
</row>
<row>
<entry><emphasis role="bold"><link linkend="mysql-set-local-infile-default">mysql_set_local_infile_default()</link></emphasis></entry>
@@ -12263,13 +12263,13 @@
};
int main(void) {
- if (mysql_server_init(sizeof(server_args) / sizeof(char *),
+ if (mysql_library_init(sizeof(server_args) / sizeof(char *),
server_args, server_groups))
exit(1);
/* Use any MySQL API functions here */
- mysql_server_end();
+ mysql_library_end();
return EXIT_SUCCESS;
}
@@ -12682,11 +12682,11 @@
<para>
To avoid aborting the program when a connection terminates, MySQL
blocks <literal>SIGPIPE</literal> on the first call to
- <literal>mysql_server_init()</literal>,
+ <literal>mysql_library_init()</literal>,
<literal>mysql_init()</literal>, or
<literal>mysql_connect()</literal>. If you want to use your own
<literal>SIGPIPE</literal> handler, you should first call
- <literal>mysql_server_init()</literal> and then install your
+ <literal>mysql_library_init()</literal> and then install your
handler.
</para>
Modified: trunk/refman-5.1/apis-libmysqld.xml
===================================================================
--- trunk/refman-5.1/apis-libmysqld.xml 2007-01-30 19:22:44 UTC (rev 4695)
+++ trunk/refman-5.1/apis-libmysqld.xml 2007-01-30 21:23:22 UTC (rev 4696)
Changed blocks: 8, Lines Added: 14, Lines Deleted: 14; 3840 bytes
@@ -56,12 +56,12 @@
<entry><emphasis role="bold">When to Call</emphasis></entry>
</row>
<row>
- <entry><literal>mysql_server_init()</literal></entry>
+ <entry><literal>mysql_library_init()</literal></entry>
<entry>Should be called before any other MySQL function is called, preferably
early in the <literal>main()</literal> function.</entry>
</row>
<row>
- <entry><literal>mysql_server_end()</literal></entry>
+ <entry><literal>mysql_library_end()</literal></entry>
<entry>Should be called before your program exits.</entry>
</row>
<row>
@@ -83,12 +83,12 @@
<para>
The
- <literal>mysql_server_<replaceable>xxx</replaceable>()</literal>
+ <literal>mysql_library_<replaceable>xxx</replaceable>()</literal>
functions are also included in
<filename>libmysqlclient.a</filename> to allow you to change
between the embedded and the client/server version by just linking
your application with the right library. See
- <xref linkend="mysql-server-init"/>.
+ <xref linkend="mysql-library-init"/>.
</para>
<para>
@@ -240,14 +240,14 @@
Any options that may be given with the <command>mysqld</command>
server daemon, may be used with an embedded server library. Server
options may be given in an array as an argument to the
- <literal>mysql_server_init()</literal>, which initializes the
+ <literal>mysql_library_init()</literal>, which initializes the
server. They also may be given in an option file like
<filename>my.cnf</filename>. To specify an option file for a C
program, use the <option>--defaults-file</option> option as one of
the elements of the second argument of the
- <literal>mysql_server_init()</literal> function. See
- <xref linkend="mysql-server-init"/>, for more information on the
- <literal>mysql_server_init()</literal> function.
+ <literal>mysql_library_init()</literal> function. See
+ <xref linkend="mysql-library-init"/>, for more information on the
+ <literal>mysql_library_init()</literal> function.
</para>
<para>
@@ -309,7 +309,7 @@
int main(void)
{
- mysql_server_init(num_elements, server_options, server_groups);
+ mysql_library_init(num_elements, server_options, server_groups);
mysql = mysql_init(NULL);
mysql_options(mysql, MYSQL_READ_DEFAULT_GROUP, "libmysqld_client");
mysql_options(mysql, MYSQL_OPT_USE_EMBEDDED_CONNECTION, NULL);
@@ -326,7 +326,7 @@
mysql_free_result(results);
mysql_close(mysql);
- mysql_server_end();
+ mysql_library_end();
return 0;
}
@@ -382,10 +382,10 @@
{
MYSQL *one, *two;
- /* mysql_server_init() must be called before any other mysql
+ /* mysql_library_init() must be called before any other mysql
* functions.
*
- * You can use mysql_server_init(0, NULL, NULL), and it
+ * You can use mysql_library_init(0, NULL, NULL), and it
* initializes the server using groups = {
* "server", "embedded", NULL
* }.
@@ -404,7 +404,7 @@
* If you link this client against the normal mysqlclient
* library, this function is just a stub that does nothing.
*/
- mysql_server_init(argc, argv, (char **)server_groups);
+ mysql_library_init(argc, argv, (char **)server_groups);
one = db_connect("test");
two = db_connect(NULL);
@@ -416,7 +416,7 @@
mysql_close(one);
/* This must be called after all other mysql functions */
- mysql_server_end();
+ mysql_library_end();
exit(EXIT_SUCCESS);
}
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r4696 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | paul | 30 Jan |
