Author: paul
Date: 2010-12-01 22:11:04 +0100 (Wed, 01 Dec 2010)
New Revision: 24166
Log:
r66327@frost: paul | 2010-12-01 15:02:11 -0500
CMake updates
Modified:
trunk/dynamic-docs/build-configure/cmake.xml
trunk/refman-5.5/installing-source-core.xml
trunk/refman-5.6/installing-source-core.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 07c7e7b4-24e3-4b51-89d0-6dc09fec6bec:/mysqldoc-local/mysqldoc/trunk:35498
07c7e7b4-24e3-4b51-89d0-6dc09fec6bec:/mysqldoc-local/trunk:44896
4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:43968
4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/trunk:44480
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:66326
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:39036
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/trunk:39546
+ 07c7e7b4-24e3-4b51-89d0-6dc09fec6bec:/mysqldoc-local/mysqldoc/trunk:35498
07c7e7b4-24e3-4b51-89d0-6dc09fec6bec:/mysqldoc-local/trunk:44896
4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:43968
4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/trunk:44480
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:66327
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:39036
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/trunk:39546
Modified: trunk/dynamic-docs/build-configure/cmake.xml
===================================================================
--- trunk/dynamic-docs/build-configure/cmake.xml 2010-12-01 21:10:59 UTC (rev 24165)
+++ trunk/dynamic-docs/build-configure/cmake.xml 2010-12-01 21:11:04 UTC (rev 24166)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 1166 bytes
@@ -463,7 +463,7 @@
<xrefto id="option_cmake_install_sharedir"/>
<formatbase format="INSTALL_SHAREDIR">
- <description>aclocal.m4 installation directory</description>
+ <description>aclocal/mysql.m4 installation directory</description>
</formatbase>
<values>
@@ -534,6 +534,26 @@
</buildoption>
+ <buildoption id="mysql_maintainer_mode">
+
+ <xrefto id="option_cmake_mysql_maintainer_mode"/>
+
+ <formatbase format="MYSQL_MAINTAINER_MODE">
+ <description>Whether to enable MySQL maintainer-specific development environment</description>
+ </formatbase>
+
+ <values>
+ <default>OFF</default>
+ </values>
+
+ <versions>
+ <manual version="5.5"/>
+ <introduced version="5.5.7"/>
+ <manual version="5.6"/>
+ </versions>
+
+ </buildoption>
+
<buildoption id="mysql_tcp_port">
<xrefto id="option_cmake_mysql_tcp_port"/>
Modified: trunk/refman-5.5/installing-source-core.xml
===================================================================
--- trunk/refman-5.5/installing-source-core.xml 2010-12-01 21:10:59 UTC (rev 24165)
+++ trunk/refman-5.5/installing-source-core.xml 2010-12-01 21:11:04 UTC (rev 24166)
Changed blocks: 13, Lines Added: 112, Lines Deleted: 20; 8263 bytes
@@ -179,9 +179,7 @@
<command>tar</command> to unpack it. If your
<command>tar</command> program understands the
<literal>z</literal> option, it can both uncompress and unpack
- the file. Alternatively, use <command>CMake</command>, which has
- <command>tar</command> capability, including
- <literal>z</literal> option support.
+ the file.
</para>
<para>
@@ -257,8 +255,9 @@
<command>bison</command> is the <filename>C:\Program
Files\GnuWin32</filename> directory. Some utilities may fail to
find <command>bison</command> because of the space in the
- directory name. You can resolve this by installing into a
- directory that does not contain a space; for example
+ directory name. Also, Visual Studio may simply hang if there are
+ spaces in the path. You can resolve these problems by installing
+ into a directory that does not contain a space; for example
<filename>C:\GnuWin32</filename>.
</para>
</listitem>
@@ -342,7 +341,7 @@
<para>
To install MySQL from a source distribution, your system must
- satisfy the the tool requirements listed at
+ satisfy the tool requirements listed at
<xref linkend="source-installation"/>.
</para>
@@ -374,9 +373,9 @@
similar to the process for installing from a generic binary
distribution that is detailed in
<xref linkend="binary-installation"/>, except that it includes
- steps for configure and compile the distribution. For example,
- with a compressed <command>tar</command> file source distribution
- on Unix, the basic installation command sequence is:
+ steps to configure and compile the distribution. For example, with
+ a compressed <command>tar</command> file source distribution on
+ Unix, the basic installation command sequence is:
</para>
<programlisting>
@@ -583,6 +582,58 @@
the instructions in <xref linkend="bug-reports"/>.
</para>
+ <para>
+ To reconfigure, run <command>CMake</command> again. If you do
+ this, take note of the following:
+ </para>
+
+ <indexterm>
+ <primary>running CMake after prior invocation</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>CMake</primary>
+ <secondary>running after prior invocation</secondary>
+ </indexterm>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ If <command>CMake</command> is run after it has previously
+ been run, it may use information that was gathered during its
+ previous invocation. This information is stored in
+ <filename>CMakeCache.txt</filename>. When
+ <command>CMake</command> starts up, it looks for that file and
+ reads its contents if it exists, on the assumption that the
+ information is still correct. That assumption is invalid when
+ you reconfigure.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Each time you run <command>CMake</command>, you must run
+ <command>make</command> again to recompile. However, you may
+ want to remove old object files from previous builds first
+ because they were compiled using different configuration
+ options.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ To prevent old configuration information or object files from
+ being used, run these commands before re-running
+ <command>CMake</command>:
+ </para>
+
+<programlisting>
+shell> <userinput>rm CMakeCache.txt</userinput>
+shell> <userinput>make clean</userinput>
+</programlisting>
+
<bridgehead>
Build the Distribution
</bridgehead>
@@ -762,8 +813,13 @@
</para>
<para>
+ Information about using Bazaar with MySQL can be found at
+ <ulink url="http://forge.mysql.com/wiki/MySQL_Bazaar_Howto"/>.
+ </para>
+
+ <para>
To install MySQL from a development source tree, your system must
- satisfy the the tool requirements listed at
+ satisfy the tool requirements listed at
<xref linkend="source-installation"/>, including the requirements
for Bazaar and <command>bison</command>.
</para>
@@ -1422,7 +1478,7 @@
</para>
<para>
- Where to install <filename>aclocal.m4</filename>.
+ Where to install <filename>aclocal/mysql.m4</filename>.
</para>
</listitem>
@@ -1515,6 +1571,16 @@
</bridgehead>
<para>
+ Storage engines are built as plugins. You can build a plugin as a
+ static module (compiled into the server) or a dynamic module
+ (built as a dynamic library that must be installed into the server
+ using the <literal role="stmt">INSTALL PLUGIN</literal> statement
+ or the <option role="mysqld">--plugin-load</option> option before
+ it can be used). Some plugins might not support static or dynamic
+ building.
+ </para>
+
+ <para>
The <literal role="se">MyISAM</literal>,
<literal role="se">MERGE</literal>,
<literal role="se">MEMORY</literal>, and
@@ -1525,7 +1591,7 @@
<para>
To compile a storage engine statically into the server, use
<literal>-DWITH_<replaceable>engine</replaceable>_STORAGE_ENGINE=1</literal>.
- Some allowable <replaceable>engine</replaceable> values are
+ Some permissible <replaceable>engine</replaceable> values are
<literal>ARCHIVE</literal>, <literal>BLACKHOLE</literal>,
<literal>EXAMPLE</literal>, <literal>FEDERATED</literal>,
<literal>INNOBASE</literal> (<literal role="se">InnoDB</literal>),
@@ -1558,10 +1624,7 @@
<literal>-DWITHOUT_<replaceable>engine</replaceable>_STORAGE_ENGINE</literal>
are specified for a given storage engine, the engine is built as a
shared module, or excluded if it cannot be built as a shared
- module. A shared module must be installed using the
- <literal role="stmt">INSTALL PLUGIN</literal> statement or the
- <option role="mysqld">--plugin-load</option> option before it can
- be used.
+ module.
</para>
<bridgehead>
@@ -1722,6 +1785,28 @@
</listitem>
<listitem>
+ <para id="option_cmake_mysql_maintainer_mode">
+ <indexterm>
+ <primary>CMake</primary>
+ <secondary>MYSQL_MAINTAINER_MODE option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MYSQL_MAINTAINER_MODE option</primary>
+ <secondary>CMake</secondary>
+ </indexterm>
+
+ <literal>-DMYSQL_MAINTAINER_MODE=<replaceable>bool</replaceable></literal>
+ </para>
+
+ <para>
+ Whether to enable a MySQL maintainer-specific development
+ environment. If enabled, this option causes compiler warnings
+ to become errors.
+ </para>
+ </listitem>
+
+ <listitem>
<para id="option_cmake_mysql_tcp_port">
<indexterm>
<primary>CMake</primary>
@@ -2060,10 +2145,8 @@
</indexterm>
<para>
- All MySQL programs compile cleanly for us with no warnings on
- Solaris or Linux using <command>gcc</command>. On other systems,
- warnings may occur due to differences in system include files. For
- other problems, check the following list.
+ On some systems, warnings may occur due to differences in system
+ include files. For other problems, check the following list.
</para>
<para>
@@ -2181,6 +2264,15 @@
<listitem>
<para>
+ If compilation fails, check whether the
+ <option role="cmake">MYSQL_MAINTAINER_MODE</option> option is
+ enabled. This mode causes compiler warnings to become errors,
+ so disabling it may enable compilation to proceed.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
If your compile fails with errors such as any of the
following, you must upgrade your version of
<command>make</command> to GNU <command>make</command>:
Modified: trunk/refman-5.6/installing-source-core.xml
===================================================================
--- trunk/refman-5.6/installing-source-core.xml 2010-12-01 21:10:59 UTC (rev 24165)
+++ trunk/refman-5.6/installing-source-core.xml 2010-12-01 21:11:04 UTC (rev 24166)
Changed blocks: 13, Lines Added: 112, Lines Deleted: 20; 8263 bytes
@@ -166,9 +166,7 @@
<command>tar</command> to unpack it. If your
<command>tar</command> program understands the
<literal>z</literal> option, it can both uncompress and unpack
- the file. Alternatively, use <command>CMake</command>, which has
- <command>tar</command> capability, including
- <literal>z</literal> option support.
+ the file.
</para>
<para>
@@ -244,8 +242,9 @@
<command>bison</command> is the <filename>C:\Program
Files\GnuWin32</filename> directory. Some utilities may fail to
find <command>bison</command> because of the space in the
- directory name. You can resolve this by installing into a
- directory that does not contain a space; for example
+ directory name. Also, Visual Studio may simply hang if there are
+ spaces in the path. You can resolve these problems by installing
+ into a directory that does not contain a space; for example
<filename>C:\GnuWin32</filename>.
</para>
</listitem>
@@ -329,7 +328,7 @@
<para>
To install MySQL from a source distribution, your system must
- satisfy the the tool requirements listed at
+ satisfy the tool requirements listed at
<xref linkend="source-installation"/>.
</para>
@@ -361,9 +360,9 @@
similar to the process for installing from a generic binary
distribution that is detailed in
<xref linkend="binary-installation"/>, except that it includes
- steps for configure and compile the distribution. For example,
- with a compressed <command>tar</command> file source distribution
- on Unix, the basic installation command sequence is:
+ steps to configure and compile the distribution. For example, with
+ a compressed <command>tar</command> file source distribution on
+ Unix, the basic installation command sequence is:
</para>
<programlisting>
@@ -570,6 +569,58 @@
the instructions in <xref linkend="bug-reports"/>.
</para>
+ <para>
+ To reconfigure, run <command>CMake</command> again. If you do
+ this, take note of the following:
+ </para>
+
+ <indexterm>
+ <primary>running CMake after prior invocation</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>CMake</primary>
+ <secondary>running after prior invocation</secondary>
+ </indexterm>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ If <command>CMake</command> is run after it has previously
+ been run, it may use information that was gathered during its
+ previous invocation. This information is stored in
+ <filename>CMakeCache.txt</filename>. When
+ <command>CMake</command> starts up, it looks for that file and
+ reads its contents if it exists, on the assumption that the
+ information is still correct. That assumption is invalid when
+ you reconfigure.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Each time you run <command>CMake</command>, you must run
+ <command>make</command> again to recompile. However, you may
+ want to remove old object files from previous builds first
+ because they were compiled using different configuration
+ options.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ To prevent old configuration information or object files from
+ being used, run these commands before re-running
+ <command>CMake</command>:
+ </para>
+
+<programlisting>
+shell> <userinput>rm CMakeCache.txt</userinput>
+shell> <userinput>make clean</userinput>
+</programlisting>
+
<bridgehead>
Build the Distribution
</bridgehead>
@@ -749,8 +800,13 @@
</para>
<para>
+ Information about using Bazaar with MySQL can be found at
+ <ulink url="http://forge.mysql.com/wiki/MySQL_Bazaar_Howto"/>.
+ </para>
+
+ <para>
To install MySQL from a development source tree, your system must
- satisfy the the tool requirements listed at
+ satisfy the tool requirements listed at
<xref linkend="source-installation"/>, including the requirements
for Bazaar and <command>bison</command>.
</para>
@@ -1409,7 +1465,7 @@
</para>
<para>
- Where to install <filename>aclocal.m4</filename>.
+ Where to install <filename>aclocal/mysql.m4</filename>.
</para>
</listitem>
@@ -1502,6 +1558,16 @@
</bridgehead>
<para>
+ Storage engines are built as plugins. You can build a plugin as a
+ static module (compiled into the server) or a dynamic module
+ (built as a dynamic library that must be installed into the server
+ using the <literal role="stmt">INSTALL PLUGIN</literal> statement
+ or the <option role="mysqld">--plugin-load</option> option before
+ it can be used). Some plugins might not support static or dynamic
+ building.
+ </para>
+
+ <para>
The <literal role="se">MyISAM</literal>,
<literal role="se">MERGE</literal>,
<literal role="se">MEMORY</literal>, and
@@ -1512,7 +1578,7 @@
<para>
To compile a storage engine statically into the server, use
<literal>-DWITH_<replaceable>engine</replaceable>_STORAGE_ENGINE=1</literal>.
- Some allowable <replaceable>engine</replaceable> values are
+ Some permissible <replaceable>engine</replaceable> values are
<literal>ARCHIVE</literal>, <literal>BLACKHOLE</literal>,
<literal>EXAMPLE</literal>, <literal>FEDERATED</literal>,
<literal>INNOBASE</literal> (<literal role="se">InnoDB</literal>),
@@ -1545,10 +1611,7 @@
<literal>-DWITHOUT_<replaceable>engine</replaceable>_STORAGE_ENGINE</literal>
are specified for a given storage engine, the engine is built as a
shared module, or excluded if it cannot be built as a shared
- module. A shared module must be installed using the
- <literal role="stmt">INSTALL PLUGIN</literal> statement or the
- <option role="mysqld">--plugin-load</option> option before it can
- be used.
+ module.
</para>
<bridgehead>
@@ -1709,6 +1772,28 @@
</listitem>
<listitem>
+ <para id="option_cmake_mysql_maintainer_mode">
+ <indexterm>
+ <primary>CMake</primary>
+ <secondary>MYSQL_MAINTAINER_MODE option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>MYSQL_MAINTAINER_MODE option</primary>
+ <secondary>CMake</secondary>
+ </indexterm>
+
+ <literal>-DMYSQL_MAINTAINER_MODE=<replaceable>bool</replaceable></literal>
+ </para>
+
+ <para>
+ Whether to enable a MySQL maintainer-specific development
+ environment. If enabled, this option causes compiler warnings
+ to become errors.
+ </para>
+ </listitem>
+
+ <listitem>
<para id="option_cmake_mysql_tcp_port">
<indexterm>
<primary>CMake</primary>
@@ -2047,10 +2132,8 @@
</indexterm>
<para>
- All MySQL programs compile cleanly for us with no warnings on
- Solaris or Linux using <command>gcc</command>. On other systems,
- warnings may occur due to differences in system include files. For
- other problems, check the following list.
+ On some systems, warnings may occur due to differences in system
+ include files. For other problems, check the following list.
</para>
<para>
@@ -2168,6 +2251,15 @@
<listitem>
<para>
+ If compilation fails, check whether the
+ <option role="cmake">MYSQL_MAINTAINER_MODE</option> option is
+ enabled. This mode causes compiler warnings to become errors,
+ so disabling it may enable compilation to proceed.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
If your compile fails with errors such as any of the
following, you must upgrade your version of
<command>make</command> to GNU <command>make</command>:
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r24166 - in trunk: . dynamic-docs/build-configure refman-5.5 refman-5.6 | paul.dubois | 1 Dec |
