Below is the list of changes that have just been committed into a local
mysqldoc repository of stefan. When stefan does a push these changes will
be propagated to the main repository and, within 24 hours after the
push, to the public repository.
For information on how to access the public repository
see http://www.mysql.com/doc/I/n/Installing_source_tree.html
ChangeSet
1.3126 05/07/26 16:58:42 stefan@stripped +9 -0
titles.ent, mysql-apis.xml, mysql-database-administration.xml:
Sync with refman
titles.ent:
Tweak in libmysqld section name
mysql-apis.xml:
Add libmysqld stuff submitted by Russell
mysql-database-administration.xml:
Added index term to PITR section
mysql-apis.xml:
Added Russell's description on how to compile
to the libmysqld intro section
refman-5.0/titles.ent
1.39 05/07/26 16:58:28 stefan@stripped +1 -1
Sync with refman
refman-5.0/mysql-apis.xml
1.18 05/07/26 16:58:27 stefan@stripped +51 -38
Sync with refman
refman-4.1/titles.ent
1.30 05/07/26 16:58:27 stefan@stripped +1 -1
Sync with refman
refman-4.1/mysql-apis.xml
1.16 05/07/26 16:58:26 stefan@stripped +51 -38
Sync with refman
refman/titles.ent
1.41 05/07/26 16:45:06 stefan@stripped +1 -1
Tweak in libmysqld section name
refman/mysql-apis.xml
1.19 05/07/26 16:44:08 stefan@stripped +51 -38
Add libmysqld stuff submitted by Russell
refman-5.0/mysql-database-administration.xml
1.35 05/07/26 15:48:57 stefan@stripped +10 -0
Sync with refman
refman-4.1/mysql-database-administration.xml
1.23 05/07/26 15:48:55 stefan@stripped +10 -0
Sync with refman
refman/mysql-database-administration.xml
1.33 05/07/26 15:48:43 stefan@stripped +10 -0
Added index term to PITR section
refman-5.0/mysql-apis.xml
1.17 05/07/26 15:36:06 stefan@stripped +29 -0
Sync with refman
refman-4.1/mysql-apis.xml
1.15 05/07/26 15:36:03 stefan@stripped +29 -0
Sync with refman
refman/mysql-apis.xml
1.18 05/07/26 15:35:31 stefan@stripped +29 -0
Added Russell's description on how to compile
to the libmysqld intro section
# This is a BitKeeper patch. What follows are the unified diffs for the
# set of deltas contained in the patch. The rest of the patch, the part
# that BitKeeper cares about, is below these diffs.
# User: stefan
# Host: apollon.site
# Root: /home/stefan/bk/mysqldoc
--- 1.14/refman-4.1/mysql-apis.xml 2005-07-20 23:59:38 +02:00
+++ 1.16/refman-4.1/mysql-apis.xml 2005-07-26 16:58:26 +02:00
@@ -12312,6 +12312,35 @@
functions in your code.
</para>
+ <para>
+ To compile a C program to include the necessary files to
+ embed the MySQL server library into a compiled version of a
+ program, use the GNU C compiler
+ (<literal>gcc</literal>). The compiler will need to know
+ where to find various files and need instructions on how to
+ compile the program. Below is an example of how a program
+ could be compiled from the command-line:
+ <programlisting>
+gcc mysql_test.c -o mysql_test -lz \
+`/usr/local/mysql/bin/mysql_config --include --libmysqld-libs`
+</programlisting>
+ </para>
+
+ <para>
+ Immediately following the <literal>gcc</literal> command is
+ the name of the uncompiled C program file. After it, the
+ <option>-o</option> option is given to indicate that the file
+ name that follows is the name that the compiler is to give to
+ the output file, the compiled program. The next line of code
+ tells the compiler to obtain the location of the include files
+ and libraries and other settings for the system on which it's
+ compiled. Because of a problem with
+ <command>mysql_config</command>, the option
+ <option>-lz</option> (for compression) is added here. The
+ <command>mysql_config</command> piece is contained in
+ backticks, not single quotes.
+ </para>
+
</section>
<section id="libmysqld-restrictions">
@@ -12359,8 +12388,11 @@
<listitem>
<para>
- You can't connect to an embedded server from an outside
- process with sockets or TCP/IP.
+ You cannot connect to an embedded server from an outside
+ process with sockets or TCP/IP. However, you can connect
+ to an intermediate application, which in turn can connect
+ to an embedded server on the behalf of a remote client
+ or outside process.
</para>
</listitem>
@@ -12383,44 +12415,49 @@
<secondary>embedded</secondary>
</indexterm>
- <para>
- The following is the recommended way to use option files to
- make it easy to switch between a client/server application and
- one where MySQL is embedded. See
- <xref linkend="option-files"/>.
- </para>
-
- <itemizedlist>
-
- <listitem>
- <para>
- Put common options in the <literal>[server]</literal>
- section. These are read by both MySQL versions.
- </para>
- </listitem>
+ <indexterm type="concept">
+ <primary>options</primary>
+ <secondary>embedded server</secondary>
+ </indexterm>
- <listitem>
- <para>
- Put client/server-specific options in the
- <literal>[mysqld]</literal> section.
- </para>
- </listitem>
+ <indexterm type="concept">
+ <primary>options</primary>
+ <secondary>libmysqld</secondary>
+ </indexterm>
- <listitem>
- <para>
- Put embedded MySQL-specific options in the
- <literal>[embedded]</literal> section.
- </para>
- </listitem>
+ <indexterm type="concept">
+ <primary>libmysqld</primary>
+ <secondary>options</secondary>
+ </indexterm>
- <listitem>
- <para>
- Put application-specific options in a
- <literal>[ApplicationName_SERVER]</literal> section.
- </para>
- </listitem>
+ <para>
+ 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
+ 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.
+ </para>
- </itemizedlist>
+ <para>
+ Using option files can make it easier to switch between a
+ client/server application and one where MySQL is embedded.
+ Put common options under the <literal>[server]</literal>
+ group. These are read by both MySQL versions.
+ Client/server-specific options should go under the
+ <literal>[mysqld]</literal> section. Put options specific to
+ the embedded MySQL server library in the
+ <literal>[embedded]</literal> section. Options specific to
+ applications go under section labeled
+ <literal>[ApplicationName_SERVER]</literal>.
+ See <xref linkend="option-files"/>.
+ </para>
</section>
@@ -12457,8 +12494,13 @@
<listitem>
<para>
- We have to change <literal>InnoDB</literal> to not be so
- verbose when using in the embedded version.
+ We have to change InnoDB not to be so verbose when using
+ the embedded version. If your database does not contain
+ InnoDB tables, to suppress related messages you can add
+ the <option>--skip-innodb</option> option to the options
+ file under the group <literal>[libmysqd_server]</literal>,
+ or when initializing the server with
+ <command>mysql_server_init()</command>.
</para>
</listitem>
--- 1.22/refman-4.1/mysql-database-administration.xml 2005-07-26 10:13:37 +02:00
+++ 1.23/refman-4.1/mysql-database-administration.xml 2005-07-26 15:48:55 +02:00
@@ -18403,7 +18403,17 @@
</section>
<section id="point-in-time-recovery">
+
<title id="title-point-in-time-recovery">&title-point-in-time-recovery;</title>
+
+ <indexterm type="concept">
+ <primary>point in time recovery</primary>
+ </indexterm>
+ <indexterm type="concept">
+ <primary>recovery</primary>
+ <secondary>point in time</secondary>
+ </indexterm>
+
<para>
If a MySQL server has the binary log enabled, you can use the
<command>mysqlbinlog</command> utility to recover data starting
--- 1.29/refman-4.1/titles.ent 2005-07-26 10:13:39 +02:00
+++ 1.30/refman-4.1/titles.ent 2005-07-26 16:58:27 +02:00
@@ -838,7 +838,7 @@
<!ENTITY title-grant "<literal>GRANT</literal> and <literal>REVOKE</literal> Syntax"><!-- "<literal>GRANT</literal> and <literal>REVOKE</literal> Syntax" -->
<!ENTITY title-mysql-install-wizard-introduction "Introduction"><!-- "Introduction" -->
<!ENTITY title-show-master-status "<literal>SHOW MASTER STATUS</literal> Syntax"><!-- "<literal>SHOW MASTER STATUS</literal> Syntax" -->
-<!ENTITY title-libmysqld-options "Using Option Files with the Embedded Server"><!-- "Using Option Files with the Embedded Server" -->
+<!ENTITY title-libmysqld-options "Options with the Embedded Server"><!-- "Options with the Embedded Server" -->
<!ENTITY title-myodbc-unix-tarball-installation "Installing MyODBC from a Binary Tarball Distribution"><!-- "Installing MyODBC from a Binary Tarball Distribution" -->
<!ENTITY title-mysql-select-db "<literal>mysql_select_db()</literal>"><!-- "<literal>mysql_select_db()</literal>" -->
<!ENTITY title-counting-rows "Counting Rows"><!-- "Counting Rows" -->
--- 1.16/refman-5.0/mysql-apis.xml 2005-07-20 23:59:38 +02:00
+++ 1.18/refman-5.0/mysql-apis.xml 2005-07-26 16:58:27 +02:00
@@ -12360,6 +12360,35 @@
functions in your code.
</para>
+ <para>
+ To compile a C program to include the necessary files to
+ embed the MySQL server library into a compiled version of a
+ program, use the GNU C compiler
+ (<literal>gcc</literal>). The compiler will need to know
+ where to find various files and need instructions on how to
+ compile the program. Below is an example of how a program
+ could be compiled from the command-line:
+ <programlisting>
+gcc mysql_test.c -o mysql_test -lz \
+`/usr/local/mysql/bin/mysql_config --include --libmysqld-libs`
+</programlisting>
+ </para>
+
+ <para>
+ Immediately following the <literal>gcc</literal> command is
+ the name of the uncompiled C program file. After it, the
+ <option>-o</option> option is given to indicate that the file
+ name that follows is the name that the compiler is to give to
+ the output file, the compiled program. The next line of code
+ tells the compiler to obtain the location of the include files
+ and libraries and other settings for the system on which it's
+ compiled. Because of a problem with
+ <command>mysql_config</command>, the option
+ <option>-lz</option> (for compression) is added here. The
+ <command>mysql_config</command> piece is contained in
+ backticks, not single quotes.
+ </para>
+
</section>
<section id="libmysqld-restrictions">
@@ -12407,8 +12436,11 @@
<listitem>
<para>
- You can't connect to an embedded server from an outside
- process with sockets or TCP/IP.
+ You cannot connect to an embedded server from an outside
+ process with sockets or TCP/IP. However, you can connect
+ to an intermediate application, which in turn can connect
+ to an embedded server on the behalf of a remote client
+ or outside process.
</para>
</listitem>
@@ -12431,44 +12463,49 @@
<secondary>embedded</secondary>
</indexterm>
- <para>
- The following is the recommended way to use option files to
- make it easy to switch between a client/server application and
- one where MySQL is embedded. See
- <xref linkend="option-files"/>.
- </para>
-
- <itemizedlist>
-
- <listitem>
- <para>
- Put common options in the <literal>[server]</literal>
- section. These are read by both MySQL versions.
- </para>
- </listitem>
+ <indexterm type="concept">
+ <primary>options</primary>
+ <secondary>embedded server</secondary>
+ </indexterm>
- <listitem>
- <para>
- Put client/server-specific options in the
- <literal>[mysqld]</literal> section.
- </para>
- </listitem>
+ <indexterm type="concept">
+ <primary>options</primary>
+ <secondary>libmysqld</secondary>
+ </indexterm>
- <listitem>
- <para>
- Put embedded MySQL-specific options in the
- <literal>[embedded]</literal> section.
- </para>
- </listitem>
+ <indexterm type="concept">
+ <primary>libmysqld</primary>
+ <secondary>options</secondary>
+ </indexterm>
- <listitem>
- <para>
- Put application-specific options in a
- <literal>[ApplicationName_SERVER]</literal> section.
- </para>
- </listitem>
+ <para>
+ 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
+ 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.
+ </para>
- </itemizedlist>
+ <para>
+ Using option files can make it easier to switch between a
+ client/server application and one where MySQL is embedded.
+ Put common options under the <literal>[server]</literal>
+ group. These are read by both MySQL versions.
+ Client/server-specific options should go under the
+ <literal>[mysqld]</literal> section. Put options specific to
+ the embedded MySQL server library in the
+ <literal>[embedded]</literal> section. Options specific to
+ applications go under section labeled
+ <literal>[ApplicationName_SERVER]</literal>.
+ See <xref linkend="option-files"/>.
+ </para>
</section>
@@ -12505,8 +12542,13 @@
<listitem>
<para>
- We have to change <literal>InnoDB</literal> to not be so
- verbose when using in the embedded version.
+ We have to change InnoDB not to be so verbose when using
+ the embedded version. If your database does not contain
+ InnoDB tables, to suppress related messages you can add
+ the <option>--skip-innodb</option> option to the options
+ file under the group <literal>[libmysqd_server]</literal>,
+ or when initializing the server with
+ <command>mysql_server_init()</command>.
</para>
</listitem>
--- 1.34/refman-5.0/mysql-database-administration.xml 2005-07-26 10:13:40 +02:00
+++ 1.35/refman-5.0/mysql-database-administration.xml 2005-07-26 15:48:57 +02:00
@@ -18083,7 +18083,17 @@
</section>
<section id="point-in-time-recovery">
+
<title id="title-point-in-time-recovery">&title-point-in-time-recovery;</title>
+
+ <indexterm type="concept">
+ <primary>point in time recovery</primary>
+ </indexterm>
+ <indexterm type="concept">
+ <primary>recovery</primary>
+ <secondary>point in time</secondary>
+ </indexterm>
+
<para>
If a MySQL server has the binary log enabled, you can use the
<command>mysqlbinlog</command> utility to recover data starting
--- 1.38/refman-5.0/titles.ent 2005-07-26 10:13:43 +02:00
+++ 1.39/refman-5.0/titles.ent 2005-07-26 16:58:28 +02:00
@@ -843,7 +843,7 @@
<!ENTITY title-grant "<literal>GRANT</literal> and <literal>REVOKE</literal> Syntax"><!-- "<literal>GRANT</literal> and <literal>REVOKE</literal> Syntax" -->
<!ENTITY title-mysql-install-wizard-introduction "Introduction"><!-- "Introduction" -->
<!ENTITY title-show-master-status "<literal>SHOW MASTER STATUS</literal> Syntax"><!-- "<literal>SHOW MASTER STATUS</literal> Syntax" -->
-<!ENTITY title-libmysqld-options "Using Option Files with the Embedded Server"><!-- "Using Option Files with the Embedded Server" -->
+<!ENTITY title-libmysqld-options "Options with the Embedded Server"><!-- "Options with the Embedded Server" -->
<!ENTITY title-myodbc-unix-tarball-installation "Installing MyODBC from a Binary Tarball Distribution"><!-- "Installing MyODBC from a Binary Tarball Distribution" -->
<!ENTITY title-mysql-select-db "<literal>mysql_select_db()</literal>"><!-- "<literal>mysql_select_db()</literal>" -->
<!ENTITY title-counting-rows "Counting Rows"><!-- "Counting Rows" -->
--- 1.17/refman/mysql-apis.xml 2005-07-21 01:36:18 +02:00
+++ 1.19/refman/mysql-apis.xml 2005-07-26 16:44:08 +02:00
@@ -12383,6 +12383,35 @@
functions in your code.
</para>
+ <para>
+ To compile a C program to include the necessary files to
+ embed the MySQL server library into a compiled version of a
+ program, use the GNU C compiler
+ (<literal>gcc</literal>). The compiler will need to know
+ where to find various files and need instructions on how to
+ compile the program. Below is an example of how a program
+ could be compiled from the command-line:
+ <programlisting>
+gcc mysql_test.c -o mysql_test -lz \
+`/usr/local/mysql/bin/mysql_config --include --libmysqld-libs`
+</programlisting>
+ </para>
+
+ <para>
+ Immediately following the <literal>gcc</literal> command is
+ the name of the uncompiled C program file. After it, the
+ <option>-o</option> option is given to indicate that the file
+ name that follows is the name that the compiler is to give to
+ the output file, the compiled program. The next line of code
+ tells the compiler to obtain the location of the include files
+ and libraries and other settings for the system on which it's
+ compiled. Because of a problem with
+ <command>mysql_config</command>, the option
+ <option>-lz</option> (for compression) is added here. The
+ <command>mysql_config</command> piece is contained in
+ backticks, not single quotes.
+ </para>
+
</section>
<section id="libmysqld-restrictions">
@@ -12430,8 +12459,11 @@
<listitem>
<para>
- You can't connect to an embedded server from an outside
- process with sockets or TCP/IP.
+ You cannot connect to an embedded server from an outside
+ process with sockets or TCP/IP. However, you can connect
+ to an intermediate application, which in turn can connect
+ to an embedded server on the behalf of a remote client
+ or outside process.
</para>
</listitem>
@@ -12454,44 +12486,49 @@
<secondary>embedded</secondary>
</indexterm>
- <para>
- The following is the recommended way to use option files to
- make it easy to switch between a client/server application and
- one where MySQL is embedded. See
- <xref linkend="option-files"/>.
- </para>
-
- <itemizedlist>
-
- <listitem>
- <para>
- Put common options in the <literal>[server]</literal>
- section. These are read by both MySQL versions.
- </para>
- </listitem>
+ <indexterm type="concept">
+ <primary>options</primary>
+ <secondary>embedded server</secondary>
+ </indexterm>
- <listitem>
- <para>
- Put client/server-specific options in the
- <literal>[mysqld]</literal> section.
- </para>
- </listitem>
+ <indexterm type="concept">
+ <primary>options</primary>
+ <secondary>libmysqld</secondary>
+ </indexterm>
- <listitem>
- <para>
- Put embedded MySQL-specific options in the
- <literal>[embedded]</literal> section.
- </para>
- </listitem>
+ <indexterm type="concept">
+ <primary>libmysqld</primary>
+ <secondary>options</secondary>
+ </indexterm>
- <listitem>
- <para>
- Put application-specific options in a
- <literal>[ApplicationName_SERVER]</literal> section.
- </para>
- </listitem>
+ <para>
+ 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
+ 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.
+ </para>
- </itemizedlist>
+ <para>
+ Using option files can make it easier to switch between a
+ client/server application and one where MySQL is embedded.
+ Put common options under the <literal>[server]</literal>
+ group. These are read by both MySQL versions.
+ Client/server-specific options should go under the
+ <literal>[mysqld]</literal> section. Put options specific to
+ the embedded MySQL server library in the
+ <literal>[embedded]</literal> section. Options specific to
+ applications go under section labeled
+ <literal>[ApplicationName_SERVER]</literal>.
+ See <xref linkend="option-files"/>.
+ </para>
</section>
@@ -12528,8 +12565,13 @@
<listitem>
<para>
- We have to change <literal>InnoDB</literal> to not be so
- verbose when using in the embedded version.
+ We have to change InnoDB not to be so verbose when using
+ the embedded version. If your database does not contain
+ InnoDB tables, to suppress related messages you can add
+ the <option>--skip-innodb</option> option to the options
+ file under the group <literal>[libmysqd_server]</literal>,
+ or when initializing the server with
+ <command>mysql_server_init()</command>.
</para>
</listitem>
--- 1.32/refman/mysql-database-administration.xml 2005-07-26 10:12:56 +02:00
+++ 1.33/refman/mysql-database-administration.xml 2005-07-26 15:48:43 +02:00
@@ -18511,7 +18511,17 @@
</section>
<section id="point-in-time-recovery">
+
<title id="title-point-in-time-recovery">&title-point-in-time-recovery;</title>
+
+ <indexterm type="concept">
+ <primary>point in time recovery</primary>
+ </indexterm>
+ <indexterm type="concept">
+ <primary>recovery</primary>
+ <secondary>point in time</secondary>
+ </indexterm>
+
<para>
If a MySQL server has the binary log enabled, you can use the
<command>mysqlbinlog</command> utility to recover data starting
--- 1.40/refman/titles.ent 2005-07-26 10:13:23 +02:00
+++ 1.41/refman/titles.ent 2005-07-26 16:45:06 +02:00
@@ -842,7 +842,7 @@
<!ENTITY title-grant "<literal>GRANT</literal> and <literal>REVOKE</literal> Syntax"><!-- "<literal>GRANT</literal> and <literal>REVOKE</literal> Syntax" -->
<!ENTITY title-mysql-install-wizard-introduction "Introduction"><!-- "Introduction" -->
<!ENTITY title-show-master-status "<literal>SHOW MASTER STATUS</literal> Syntax"><!-- "<literal>SHOW MASTER STATUS</literal> Syntax" -->
-<!ENTITY title-libmysqld-options "Using Option Files with the Embedded Server"><!-- "Using Option Files with the Embedded Server" -->
+<!ENTITY title-libmysqld-options "Options with the Embedded Server"><!-- "Options with the Embedded Server" -->
<!ENTITY title-myodbc-unix-tarball-installation "Installing MyODBC from a Binary Tarball Distribution"><!-- "Installing MyODBC from a Binary Tarball Distribution" -->
<!ENTITY title-mysql-select-db "<literal>mysql_select_db()</literal>"><!-- "<literal>mysql_select_db()</literal>" -->
<!ENTITY title-counting-rows "Counting Rows"><!-- "Counting Rows" -->
| Thread |
|---|
| • bk commit - mysqldoc@docsrva tree (stefan:1.3126) | stefan | 26 Jul |