Author: mcbrown
Date: 2007-12-04 15:01:08 +0100 (Tue, 04 Dec 2007)
New Revision: 9092
Log:
Removing 'blank' intro section for the embedded mysqld section and uprting the overview, which is really an introduction anyway.
Modified:
trunk/refman-4.1/apis.xml
trunk/refman-4.1/renamed-nodes.txt
trunk/refman-5.1/apis-libmysqld.xml
trunk/refman-5.1/renamed-nodes.txt
trunk/refman-6.0/apis-libmysqld.xml
trunk/refman-6.0/renamed-nodes.txt
Modified: trunk/refman-4.1/apis.xml
===================================================================
--- trunk/refman-4.1/apis.xml 2007-12-04 13:19:25 UTC (rev 9091)
+++ trunk/refman-4.1/apis.xml 2007-12-04 14:01:08 UTC (rev 9092)
Changed blocks: 1, Lines Added: 76, Lines Deleted: 81; 7601 bytes
@@ -59,95 +59,90 @@
<primary>embedded MySQL server library</primary>
</indexterm>
- <section id="libmysqld-overview">
+ <title>Overview of the Embedded MySQL Server Library</title>
- <title>Overview of the Embedded MySQL Server Library</title>
+ <para>
+ The embedded MySQL server library makes it possible to run a
+ full-featured MySQL server inside a client application. The main
+ benefits are increased speed and more simple management for
+ embedded applications.
+ </para>
- <para>
- The embedded MySQL server library makes it possible to run a
- full-featured MySQL server inside a client application. The main
- benefits are increased speed and more simple management for
- embedded applications.
- </para>
+ <para>
+ The embedded server library is based on the client/server version
+ of MySQL, which is written in C/C++. Consequently, the embedded
+ server also is written in C/C++. There is no embedded server
+ available in other languages.
+ </para>
- <para>
- The embedded server library is based on the client/server
- version of MySQL, which is written in C/C++. Consequently, the
- embedded server also is written in C/C++. There is no embedded
- server available in other languages.
- </para>
+ <para>
+ The API is identical for the embedded MySQL version and the
+ client/server version. To change an old threaded application to
+ use the embedded library, you normally only have to add calls to
+ the following functions:
+ </para>
- <para>
- The API is identical for the embedded MySQL version and the
- client/server version. To change an old threaded application to
- use the embedded library, you normally only have to add calls to
- the following functions:
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="25*"/>
+ <colspec colwidth="70*"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold">Function</emphasis></entry>
+ <entry><emphasis role="bold">When to Call</emphasis></entry>
+ </row>
+ <row>
+ <entry><function role="capi">mysql_library_init()</function></entry>
+ <entry>Should be called before any other MySQL function is called, preferably
+ early in the <literal>main()</literal> function.</entry>
+ </row>
+ <row>
+ <entry><function role="capi">mysql_library_end()</function></entry>
+ <entry>Should be called before your program exits.</entry>
+ </row>
+ <row>
+ <entry><function role="capi">mysql_thread_init()</function></entry>
+ <entry>Should be called in each thread you create that accesses MySQL.</entry>
+ </row>
+ <row>
+ <entry><function role="capi">mysql_thread_end()</function></entry>
+ <entry>Should be called before calling <literal>pthread_exit()</literal></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <informaltable>
- <tgroup cols="2">
- <colspec colwidth="25*"/>
- <colspec colwidth="70*"/>
- <tbody>
- <row>
- <entry><emphasis role="bold">Function</emphasis></entry>
- <entry><emphasis role="bold">When to Call</emphasis></entry>
- </row>
- <row>
- <entry><function role="capi">mysql_library_init()</function></entry>
- <entry>Should be called before any other MySQL function is called, preferably
- early in the <literal>main()</literal> function.</entry>
- </row>
- <row>
- <entry><function role="capi">mysql_library_end()</function></entry>
- <entry>Should be called before your program exits.</entry>
- </row>
- <row>
- <entry><function role="capi">mysql_thread_init()</function></entry>
- <entry>Should be called in each thread you create that accesses MySQL.</entry>
- </row>
- <row>
- <entry><function role="capi">mysql_thread_end()</function></entry>
- <entry>Should be called before calling <literal>pthread_exit()</literal></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ <para>
+ Then you must link your code with <filename>libmysqld.a</filename>
+ instead of <filename>libmysqlclient.a</filename>. To ensure binary
+ compatibility between your application and the server library, be
+ sure to compile your application against headers for the same
+ series of MySQL that was used to compile the server library. For
+ example, if <literal>libmysqld</literal> was compiled against
+ MySQL 4.1 headers, do not compile your application against MySQL
+ 5.1 headers, or vice versa.
+ </para>
- <para>
- Then you must link your code with
- <filename>libmysqld.a</filename> instead of
- <filename>libmysqlclient.a</filename>. To ensure binary
- compatibility between your application and the server library,
- be sure to compile your application against headers for the same
- series of MySQL that was used to compile the server library. For
- example, if <literal>libmysqld</literal> was compiled against
- MySQL 4.1 headers, do not compile your application against MySQL
- 5.1 headers, or vice versa.
- </para>
+ <para>
+ The
+ <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-library-init"/>.
+ </para>
- <para>
- The
- <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-library-init"/>.
- </para>
+ <para>
+ One difference between the embedded server and the standalone
+ server is that for the embedded server, authentication for
+ connections is disabled by default. To use authentication for the
+ embedded server, specify the
+ <option>--with-embedded-privilege-control</option> option when you
+ invoke <command>configure</command> to configure your MySQL
+ distribution. This option is available as of MySQL 4.1.3.
+ </para>
- <para>
- One difference between the embedded server and the standalone
- server is that for the embedded server, authentication for
- connections is disabled by default. To use authentication for
- the embedded server, specify the
- <option>--with-embedded-privilege-control</option> option when
- you invoke <command>configure</command> to configure your MySQL
- distribution. This option is available as of MySQL 4.1.3.
- </para>
-
- </section>
-
<section id="libmysqld-compiling">
<title>Compiling Programs with <literal>libmysqld</literal></title>
Modified: trunk/refman-4.1/renamed-nodes.txt
===================================================================
--- trunk/refman-4.1/renamed-nodes.txt 2007-12-04 13:19:25 UTC (rev 9091)
+++ trunk/refman-4.1/renamed-nodes.txt 2007-12-04 14:01:08 UTC (rev 9092)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 0; 445 bytes
@@ -310,3 +310,4 @@
without-dsn myodbc-configuration-connection-without-dsn
write-conflict myodbc-usagenotes-apptips
year-2000-compliance y2k-issues
+libmysqld-overview libmysqld 2008-03-31
Modified: trunk/refman-5.1/apis-libmysqld.xml
===================================================================
--- trunk/refman-5.1/apis-libmysqld.xml 2007-12-04 13:19:25 UTC (rev 9091)
+++ trunk/refman-5.1/apis-libmysqld.xml 2007-12-04 14:01:08 UTC (rev 9092)
Changed blocks: 1, Lines Added: 74, Lines Deleted: 80; 7223 bytes
@@ -15,94 +15,88 @@
<primary>embedded MySQL server library</primary>
</indexterm>
- <section id="libmysqld-overview">
+ <title>Overview of the Embedded MySQL Server Library</title>
- <title>Overview of the Embedded MySQL Server Library</title>
+ <para>
+ The embedded MySQL server library makes it possible to run a
+ full-featured MySQL server inside a client application. The main
+ benefits are increased speed and more simple management for embedded
+ applications.
+ </para>
- <para>
- The embedded MySQL server library makes it possible to run a
- full-featured MySQL server inside a client application. The main
- benefits are increased speed and more simple management for
- embedded applications.
- </para>
+ <para>
+ The embedded server library is based on the client/server version of
+ MySQL, which is written in C/C++. Consequently, the embedded server
+ also is written in C/C++. There is no embedded server available in
+ other languages.
+ </para>
- <para>
- The embedded server library is based on the client/server version
- of MySQL, which is written in C/C++. Consequently, the embedded
- server also is written in C/C++. There is no embedded server
- available in other languages.
- </para>
+ <para>
+ The API is identical for the embedded MySQL version and the
+ client/server version. To change an old threaded application to use
+ the embedded library, you normally only have to add calls to the
+ following functions:
+ </para>
- <para>
- The API is identical for the embedded MySQL version and the
- client/server version. To change an old threaded application to
- use the embedded library, you normally only have to add calls to
- the following functions:
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="25*"/>
+ <colspec colwidth="70*"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold">Function</emphasis></entry>
+ <entry><emphasis role="bold">When to Call</emphasis></entry>
+ </row>
+ <row>
+ <entry><function role="capi">mysql_library_init()</function></entry>
+ <entry>Should be called before any other MySQL function is called, preferably
+ early in the <function>main()</function> function.</entry>
+ </row>
+ <row>
+ <entry><function role="capi">mysql_library_end()</function></entry>
+ <entry>Should be called before your program exits.</entry>
+ </row>
+ <row>
+ <entry><function role="capi">mysql_thread_init()</function></entry>
+ <entry>Should be called in each thread you create that accesses MySQL.</entry>
+ </row>
+ <row>
+ <entry><function role="capi">mysql_thread_end()</function></entry>
+ <entry>Should be called before calling <function>pthread_exit()</function></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <informaltable>
- <tgroup cols="2">
- <colspec colwidth="25*"/>
- <colspec colwidth="70*"/>
- <tbody>
- <row>
- <entry><emphasis role="bold">Function</emphasis></entry>
- <entry><emphasis role="bold">When to Call</emphasis></entry>
- </row>
- <row>
- <entry><function role="capi">mysql_library_init()</function></entry>
- <entry>Should be called before any other MySQL function is called, preferably
- early in the <function>main()</function> function.</entry>
- </row>
- <row>
- <entry><function role="capi">mysql_library_end()</function></entry>
- <entry>Should be called before your program exits.</entry>
- </row>
- <row>
- <entry><function role="capi">mysql_thread_init()</function></entry>
- <entry>Should be called in each thread you create that accesses MySQL.</entry>
- </row>
- <row>
- <entry><function role="capi">mysql_thread_end()</function></entry>
- <entry>Should be called before calling <function>pthread_exit()</function></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ <para>
+ Then you must link your code with <filename>libmysqld.a</filename>
+ instead of <filename>libmysqlclient.a</filename>. To ensure binary
+ compatibility between your application and the server library, be
+ sure to compile your application against headers for the same series
+ of MySQL that was used to compile the server library. For example,
+ if <literal>libmysqld</literal> was compiled against MySQL 4.1
+ headers, do not compile your application against MySQL 5.1 headers,
+ or vice versa.
+ </para>
- <para>
- Then you must link your code with <filename>libmysqld.a</filename>
- instead of <filename>libmysqlclient.a</filename>. To ensure binary
- compatibility between your application and the server library, be
- sure to compile your application against headers for the same
- series of MySQL that was used to compile the server library. For
- example, if <literal>libmysqld</literal> was compiled against
- MySQL 4.1 headers, do not compile your application against MySQL
- 5.1 headers, or vice versa.
- </para>
+ <para>
+ The
+ <function>mysql_library_<replaceable>xxx</replaceable>()</function>
+ 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-library-init"/>.
+ </para>
- <para>
- The
- <function>mysql_library_<replaceable>xxx</replaceable>()</function>
- 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-library-init"/>.
- </para>
+ <para>
+ One difference between the embedded server and the standalone server
+ is that for the embedded server, authentication for connections is
+ disabled by default. To use authentication for the embedded server,
+ specify the <option>--with-embedded-privilege-control</option>
+ option when you invoke <command>configure</command> to configure
+ your MySQL distribution.
+ </para>
- <para>
- One difference between the embedded server and the standalone
- server is that for the embedded server, authentication for
- connections is disabled by default. To use authentication for the
- embedded server, specify the
- <option>--with-embedded-privilege-control</option> option when you
- invoke <command>configure</command> to configure your MySQL
- distribution.
- </para>
-
- </section>
-
<section id="libmysqld-compiling">
<title>Compiling Programs with <literal>libmysqld</literal></title>
Modified: trunk/refman-5.1/renamed-nodes.txt
===================================================================
--- trunk/refman-5.1/renamed-nodes.txt 2007-12-04 13:19:25 UTC (rev 9091)
+++ trunk/refman-5.1/renamed-nodes.txt 2007-12-04 14:01:08 UTC (rev 9092)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 0; 445 bytes
@@ -397,3 +397,4 @@
without-dsn myodbc-configuration-connection-without-dsn
write-conflict myodbc-usagenotes-apptips
year-2000-compliance y2k-issues
+libmysqld-overview libmysqld 2008-03-31
Modified: trunk/refman-6.0/apis-libmysqld.xml
===================================================================
--- trunk/refman-6.0/apis-libmysqld.xml 2007-12-04 13:19:25 UTC (rev 9091)
+++ trunk/refman-6.0/apis-libmysqld.xml 2007-12-04 14:01:08 UTC (rev 9092)
Changed blocks: 1, Lines Added: 74, Lines Deleted: 80; 7223 bytes
@@ -15,94 +15,88 @@
<primary>embedded MySQL server library</primary>
</indexterm>
- <section id="libmysqld-overview">
+ <title>Overview of the Embedded MySQL Server Library</title>
- <title>Overview of the Embedded MySQL Server Library</title>
+ <para>
+ The embedded MySQL server library makes it possible to run a
+ full-featured MySQL server inside a client application. The main
+ benefits are increased speed and more simple management for embedded
+ applications.
+ </para>
- <para>
- The embedded MySQL server library makes it possible to run a
- full-featured MySQL server inside a client application. The main
- benefits are increased speed and more simple management for
- embedded applications.
- </para>
+ <para>
+ The embedded server library is based on the client/server version of
+ MySQL, which is written in C/C++. Consequently, the embedded server
+ also is written in C/C++. There is no embedded server available in
+ other languages.
+ </para>
- <para>
- The embedded server library is based on the client/server version
- of MySQL, which is written in C/C++. Consequently, the embedded
- server also is written in C/C++. There is no embedded server
- available in other languages.
- </para>
+ <para>
+ The API is identical for the embedded MySQL version and the
+ client/server version. To change an old threaded application to use
+ the embedded library, you normally only have to add calls to the
+ following functions:
+ </para>
- <para>
- The API is identical for the embedded MySQL version and the
- client/server version. To change an old threaded application to
- use the embedded library, you normally only have to add calls to
- the following functions:
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="25*"/>
+ <colspec colwidth="70*"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold">Function</emphasis></entry>
+ <entry><emphasis role="bold">When to Call</emphasis></entry>
+ </row>
+ <row>
+ <entry><function role="capi">mysql_library_init()</function></entry>
+ <entry>Should be called before any other MySQL function is called, preferably
+ early in the <function>main()</function> function.</entry>
+ </row>
+ <row>
+ <entry><function role="capi">mysql_library_end()</function></entry>
+ <entry>Should be called before your program exits.</entry>
+ </row>
+ <row>
+ <entry><function role="capi">mysql_thread_init()</function></entry>
+ <entry>Should be called in each thread you create that accesses MySQL.</entry>
+ </row>
+ <row>
+ <entry><function role="capi">mysql_thread_end()</function></entry>
+ <entry>Should be called before calling <function>pthread_exit()</function></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <informaltable>
- <tgroup cols="2">
- <colspec colwidth="25*"/>
- <colspec colwidth="70*"/>
- <tbody>
- <row>
- <entry><emphasis role="bold">Function</emphasis></entry>
- <entry><emphasis role="bold">When to Call</emphasis></entry>
- </row>
- <row>
- <entry><function role="capi">mysql_library_init()</function></entry>
- <entry>Should be called before any other MySQL function is called, preferably
- early in the <function>main()</function> function.</entry>
- </row>
- <row>
- <entry><function role="capi">mysql_library_end()</function></entry>
- <entry>Should be called before your program exits.</entry>
- </row>
- <row>
- <entry><function role="capi">mysql_thread_init()</function></entry>
- <entry>Should be called in each thread you create that accesses MySQL.</entry>
- </row>
- <row>
- <entry><function role="capi">mysql_thread_end()</function></entry>
- <entry>Should be called before calling <function>pthread_exit()</function></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ <para>
+ Then you must link your code with <filename>libmysqld.a</filename>
+ instead of <filename>libmysqlclient.a</filename>. To ensure binary
+ compatibility between your application and the server library, be
+ sure to compile your application against headers for the same series
+ of MySQL that was used to compile the server library. For example,
+ if <literal>libmysqld</literal> was compiled against MySQL 4.1
+ headers, do not compile your application against MySQL 5.1 headers,
+ or vice versa.
+ </para>
- <para>
- Then you must link your code with <filename>libmysqld.a</filename>
- instead of <filename>libmysqlclient.a</filename>. To ensure binary
- compatibility between your application and the server library, be
- sure to compile your application against headers for the same
- series of MySQL that was used to compile the server library. For
- example, if <literal>libmysqld</literal> was compiled against
- MySQL 4.1 headers, do not compile your application against MySQL
- 5.1 headers, or vice versa.
- </para>
+ <para>
+ The
+ <function>mysql_library_<replaceable>xxx</replaceable>()</function>
+ 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-library-init"/>.
+ </para>
- <para>
- The
- <function>mysql_library_<replaceable>xxx</replaceable>()</function>
- 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-library-init"/>.
- </para>
+ <para>
+ One difference between the embedded server and the standalone server
+ is that for the embedded server, authentication for connections is
+ disabled by default. To use authentication for the embedded server,
+ specify the <option>--with-embedded-privilege-control</option>
+ option when you invoke <command>configure</command> to configure
+ your MySQL distribution.
+ </para>
- <para>
- One difference between the embedded server and the standalone
- server is that for the embedded server, authentication for
- connections is disabled by default. To use authentication for the
- embedded server, specify the
- <option>--with-embedded-privilege-control</option> option when you
- invoke <command>configure</command> to configure your MySQL
- distribution.
- </para>
-
- </section>
-
<section id="libmysqld-compiling">
<title>Compiling Programs with <literal>libmysqld</literal></title>
Modified: trunk/refman-6.0/renamed-nodes.txt
===================================================================
--- trunk/refman-6.0/renamed-nodes.txt 2007-12-04 13:19:25 UTC (rev 9091)
+++ trunk/refman-6.0/renamed-nodes.txt 2007-12-04 14:01:08 UTC (rev 9092)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 0; 464 bytes
@@ -22,3 +22,4 @@
character-sets charset-configuration 2009-01-01
languages error-message-language 2009-01-01
localization internationalization-localization 2009-01-01
+libmysqld-overview libmysqld 2008-03-31
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r9092 - in trunk: refman-4.1 refman-5.1 refman-6.0 | mcbrown | 4 Dec |
