Author: mcbrown
Date: 2007-09-07 18:15:07 +0200 (Fri, 07 Sep 2007)
New Revision: 7756
Log:
Updating and rewriting sections of the Windows build.
Modified:
trunk/refman-5.0/installing-cs.xml
Modified: trunk/refman-5.0/installing-cs.xml
===================================================================
--- trunk/refman-5.0/installing-cs.xml 2007-09-07 15:48:37 UTC (rev 7755)
+++ trunk/refman-5.0/installing-cs.xml 2007-09-07 16:15:07 UTC (rev 7756)
Changed blocks: 11, Lines Added: 240, Lines Deleted: 241; 24153 bytes
@@ -9818,7 +9818,8 @@
<listitem>
<para>
- CMake, which can be downloaded from
+ To build from the standard source distribution, you will
+ need CMake, which can be downloaded from
<ulink url="http://www.cmake.org"/>. After installing,
modify your path to include the <literal>cmake</literal>
binary.
@@ -9839,7 +9840,7 @@
also install an appropriate Platform SDK. More information
and links to downloads for various Windows platforms is
available from
- <ulink url="http://msdn.microsoft.com/platformsdk/"/>.
+ <ulink url="http://www.microsoft.com/downloads/details.aspx?familyid=0baf2b35-c656-4969-ace8-e4c0c0716adb/"/>.
</para>
</listitem>
@@ -9883,63 +9884,52 @@
</para>
<para>
- You also need a MySQL source distribution for Windows, which can
- be obtained two ways:
+ There are three solutions available for building from the source
+ code on Windows:
</para>
<itemizedlist>
<listitem>
<para>
- Obtain a Windows source distribution packaged by MySQL AB
- for the particular version of MySQL in which you are
- interested. These are available from
- <ulink url="&base-url-downloads;"/>.
+ Build from the standard MySQL source distribution. For this
+ you will need CMake and Visual C++ Express Edition or Visual
+ Studio. Using this method you can select the storage engines
+ that are included in your build. To use this method, see
+ <xref
+ linkend="windows-source-build-cmake"/>.
</para>
</listitem>
<listitem>
<para>
- Package a source distribution yourself from the latest
- BitKeeper developer source tree. If you plan to do this, and
- you are not using the CMake build method, you must create
- the package on a Unix system and then transfer it to your
- Windows system. (Some of the configuration and build steps
- require tools that work only on Unix.) Thus, if you are not
- using CMake, the BitKeeper approach requires:
+ Build from the MySQL Windows source distribution. The
+ Windows source distribution includes ready-made Visual
+ Studio solution files that enable support for all storage
+ engines (except <literal>NDB</literal>). To build using
+ using method you only need Visual C++ Express Edition or
+ Visual Studio. To use this method, see
+ <xref
+ linkend="windows-vc-plus-plus-build"/>.
</para>
+ </listitem>
- <itemizedlist>
-
- <listitem>
- <para>
- A system running Unix, or a Unix-like system such as
- Linux.
- </para>
- </listitem>
-
- <listitem>
- <para>
- BitKeeper installed on that system. See
- <xref linkend="installing-source-tree"/>, for
- instructions how to download and install BitKeeper.
- </para>
- </listitem>
-
- </itemizedlist>
+ <listitem>
+ <para>
+ Build directly from the BitKeeper source repository. For
+ this you will need CMake, Visual C++ Express Edition or
+ Visual Studio, and <literal>bison</literal>. For this method
+ you need to create the distribution on a Unix system and
+ then copy the generated files to your Windows build
+ environment. To use this method, see
+ <xref
+ linkend="windows-bitkeeper-build"/>.
+ </para>
</listitem>
</itemizedlist>
<para>
- If you are using a Windows source distribution, you can go
- directly to <xref linkend="windows-source-build-cmake"/>, or
- <xref linkend="windows-vc-plus-plus-build"/>. To build from the
- BitKeeper tree without CMake, proceed to
- <xref linkend="windows-bitkeeper-build"/>.
- </para>
-
- <para>
If you find something not working as expected, or you have
suggestions about ways to improve the current build process on
Windows, please send a message to the <literal>win32</literal>
@@ -9948,7 +9938,7 @@
<section id="windows-source-build-cmake" role="cs">
- <title>Building MySQL from Source Using CMake and Visual Studio</title>
+ <title>Building MySQL from the Standard Source Distribution</title>
&cs-only;
<indexterm>
@@ -9969,7 +9959,7 @@
<note>
<para>
- To compile from the source code on Windows you must use the
+ To compile from the source code usin CMake you must use the
standard source distribution (for example,
<filename>mysql-<replaceable>5.0.45</replaceable>.tar.gz</filename>).
You build from the same distribution as used to build MySQL
@@ -10112,7 +10102,7 @@
</para>
<programlisting>
-C:\workdir><userinput>win\configure WITH_INNOBASE_STORAGE_ENGINE</userinput>
+C:\workdir><userinput>win\configure WITH_INNOBASE_STORAGE_ENGINE</userinput> »
<userinput>WITH_PARTITION_STORAGE_ENGINE MYSQL_SERVER_SUFFIX=-pro</userinput>
</programlisting>
</listitem>
@@ -10124,7 +10114,8 @@
<filename>win\build-vs71.bat</filename> file, depending on
the version of Visual Studio you have installed. The
script invokes CMake, which generates the
- <filename>mysql.sln</filename> solution file.
+ <filename>mysql.sln</filename> solution file you will need
+ to build MySQL using Visual Studio..
</para>
<para>
@@ -10151,6 +10142,10 @@
</para>
<para>
+ The build process will take some time. Please be patient.
+ </para>
+
+ <para>
Remember the configuration that you use in this step. It
is important later when you run the test script because
that script needs to know which configuration you used.
@@ -10159,172 +10154,36 @@
<listitem>
<para>
- Test the server. The server built using the preceding
- instructions expects that the MySQL base directory and
- data directory are <filename>C:\mysql</filename> and
- <filename>C:\mysql\data</filename> by default. If you want
- to test your server using the source tree root directory
- and its data directory as the base directory and data
- directory, you need to tell the server their pathnames.
- You can either do this on the command line with the
- <option>--basedir</option> and <option>--datadir</option>
- options, or by placing appropriate options in an option
- file. (See <xref linkend="option-files"/>.) If you have an
- existing data directory elsewhere that you want to use,
- you can specify its pathname instead.
+ You should test you build before installation. See
+ <xref
+ linkend="windows-source-buildtest"/>.
</para>
-
- <para>
- When the server is running in standalone fashion or as a
- service based on your configuration, try to connect to it
- from the <command>mysql</command> interactive command-line
- utility.
- </para>
-
- <para>
- You can also run the standard test script,
- <command>mysql-test-run.pl</command>. This script is
- written in Perl, so you'll need either Cygwin or
- ActiveState Perl to run it. You may also need to install
- the modules required by the script. To run the test
- script, change location into the
- <filename>mysql-test</filename> directory under the work
- directory, set the <literal>MTR_VS_CONFIG</literal>
- environment variable to the configuration you selected
- earlier (or use the <literal>--vs-config</literal>
- option), and invoke <command>mysql-test-run.pl</command>.
- For example (using Cygwin and the <command>bash</command>
- shell):
- </para>
-
-<programlisting>
-shell> <literal>cd mysql-test</literal>
-shell> <literal>export MTS_VS_CONFIG=debug</literal>
-shell> <literal>./mysqltest-run.pl --force --timer</literal>
-shell> <literal>./mysqltest-run.pl --force --timer --ps-protocol</literal>
-</programlisting>
</listitem>
- </orderedlist>
-
- <para>
- When you are satisfied that the programs you have built are
- working correctly, stop the server. Now you can install the
- distribution. One way to do this is to use the
- <command>make_win_bin_dist</command> script in the
- <filename>scripts</filename> directory of the MySQL source
- distribution (see <xref linkend="make-win-bin-dist"/>). This
- is a shell script, so you must have Cygwin installed if you
- want to use it. It creates a Zip archive of the built
- executables and support files that you can unpack in the
- location at which you want to install MySQL.
- </para>
-
- <para>
- It is also possible to install MySQL by copying directories
- and files directly:
- </para>
-
- <orderedlist>
-
<listitem>
<para>
- Create the directories where you want to install MySQL.
- For example, to install into
- <filename>C:\mysql</filename>, use these commands:
+ To install, use the instructions in
+ <xref
+ linkend="windows-source-install"/>.
</para>
-
-<programlisting>
-C:\> <userinput>mkdir C:\mysql</userinput>
-C:\> <userinput>mkdir C:\mysql\bin</userinput>
-C:\> <userinput>mkdir C:\mysql\data</userinput>
-C:\> <userinput>mkdir C:\mysql\share</userinput>
-C:\> <userinput>mkdir C:\mysql\scripts</userinput>
-</programlisting>
-
- <para>
- If you want to compile other clients and link them to
- MySQL, you should also create several additional
- directories:
- </para>
-
-<programlisting>
-C:\> <userinput>mkdir C:\mysql\include</userinput>
-C:\> <userinput>mkdir C:\mysql\lib</userinput>
-C:\> <userinput>mkdir C:\mysql\lib\debug</userinput>
-C:\> <userinput>mkdir C:\mysql\lib\opt</userinput>
-</programlisting>
-
- <para>
- If you want to benchmark MySQL, create this directory:
- </para>
-
-<programlisting>
-C:\> <userinput>mkdir C:\mysql\sql-bench</userinput>
-</programlisting>
-
- <para>
- Benchmarking requires Perl support. See
- <xref linkend="perl-support"/>.
- </para>
</listitem>
- <listitem>
- <para>
- From the work directory, copy into the
- <filename>C:\mysql</filename> directory the following
- directories:
- </para>
-
-<programlisting>
-C:\> <userinput>cd \workdir</userinput>
-C:\workdir> <userinput>copy client_release\*.exe C:\mysql\bin</userinput>
-C:\workdir> <userinput>copy client_debug\mysqld.exe C:\mysql\bin\mysqld-debug.exe</userinput>
-C:\workdir> <userinput>xcopy scripts\*.* C:\mysql\scripts /E</userinput>
-C:\workdir> <userinput>xcopy share\*.* C:\mysql\share /E</userinput>
-</programlisting>
-
- <para>
- If you want to compile other clients and link them to
- MySQL, you should also copy several libraries and header
- files:
- </para>
-
-<programlisting>
-C:\workdir> <userinput>copy lib_debug\mysqlclient.lib C:\mysql\lib\debug</userinput>
-C:\workdir> <userinput>copy lib_debug\libmysql.* C:\mysql\lib\debug</userinput>
-C:\workdir> <userinput>copy lib_debug\zlib.* C:\mysql\lib\debug</userinput>
-C:\workdir> <userinput>copy lib_release\mysqlclient.lib C:\mysql\lib\opt</userinput>
-C:\workdir> <userinput>copy lib_release\libmysql.* C:\mysql\lib\opt</userinput>
-C:\workdir> <userinput>copy lib_release\zlib.* C:\mysql\lib\opt</userinput>
-C:\workdir> <userinput>copy include\*.h C:\mysql\include</userinput>
-C:\workdir> <userinput>copy libmysql\libmysql.def C:\mysql\include</userinput>
-</programlisting>
-
- <para>
- If you want to benchmark MySQL, you should also do this:
- </para>
-
-<programlisting>
-C:\workdir> <userinput>xcopy sql-bench\*.* C:\mysql\bench /E</userinput>
-</programlisting>
- </listitem>
-
</orderedlist>
- <para>
- After installation, set up and start the server in the same
- way as for binary Windows distributions. See
- <xref linkend="windows-installation"/>.
- </para>
-
</section>
<section id="windows-vc-plus-plus-build" role="cs">
- <title>Building MySQL from Source Using VC++</title>
+ <title>Building MySQL from a Windows Source Distribution</title>
&cs-only;
+<para>
+ The Windows source distribution includes the necessary
+ solution file and the <literal>vcproj</literal> files required
+ to build each component. Using this method you are not able to
+ select the storage engines that are included in your build.
+ </para>
+
<note>
<para>
VC++ workspace files for MySQL 4.1 and above are compatible
@@ -10413,61 +10272,22 @@
<listitem>
<para>
- Test the server. The server built using the preceding
- instructions expects that the MySQL base directory and
- data directory are <filename>C:\mysql</filename> and
- <filename>C:\mysql\data</filename> by default. If you want
- to test your server using the source tree root directory
- and its data directory as the base directory and data
- directory, you need to tell the server their pathnames.
- You can either do this on the command line with the
- <option>--basedir</option> and <option>--datadir</option>
- options, or by placing appropriate options in an option
- file. (See <xref linkend="option-files"/>.) If you have an
- existing data directory elsewhere that you want to use,
- you can specify its pathname instead.
+ You should test you build before installation. See
+ <xref
+ linkend="windows-source-buildtest"/>.
</para>
</listitem>
<listitem>
<para>
- Start your server from the
- <filename>client_release</filename> or
- <filename>client_debug</filename> directory, depending on
- which server you built or want to use. The general server
- startup instructions are in
- <xref linkend="windows-installation"/>. You must adapt the
- instructions appropriately if you want to use a different
- base directory or data directory.
+ To install, use the instructions in
+ <xref
+ linkend="windows-source-install"/>.
</para>
</listitem>
- <listitem>
- <para>
- When the server is running in standalone fashion or as a
- service based on your configuration, try to connect to it
- from the <command>mysql</command> interactive command-line
- utility that exists in your
- <filename>client_release</filename> or
- <filename>client_debug</filename> directory.
- </para>
- </listitem>
-
</orderedlist>
- <para>
- When you are satisfied that the programs you have built are
- working correctly, stop the server. Then install MySQL using
- the instructions at the end of
- <xref linkend="windows-source-build-cmake"/>.
- </para>
-
- <para>
- After installation, set up and start the server in the same
- way as for binary Windows distributions. See
- <xref linkend="windows-installation"/>.
- </para>
-
</section>
<section id="borland-c-plus-plus" role="cs">
@@ -10499,9 +10319,188 @@
</section>
+ <section id="windows-source-install">
+
+ <title>Installing MySQL from a Source Build on Windows</title>
+
+ <para>
+ When you are satisfied that the program you have built is
+ working correctly, stop the server. Now you can install the
+ distribution. There are two ways to do this, either by using
+ the supplied installation script or by copying the files
+ individually by hand.
+ </para>
+
+ <para>
+ To use the script method you must have Cygwin installed as the
+ script is a Shell script. To execute the installation process,
+ run the <command>make_win_bin_dist</command> script in the
+ <filename>scripts</filename> directory of the MySQL source
+ distribution (see <xref linkend="make-win-bin-dist"/>). This
+ is a shell script, so you must have Cygwin installed if you
+ want to use it. It creates a Zip archive of the built
+ executables and support files that you can unpack to your
+ desired installation location.
+ </para>
+
+ <para>
+ It is also possible to install MySQL by copying directories
+ and files manually:
+ </para>
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ Create the directories where you want to install MySQL.
+ For example, to install into
+ <filename>C:\mysql</filename>, use these commands:
+ </para>
+
+<programlisting>
+C:\> <userinput>mkdir C:\mysql</userinput>
+C:\> <userinput>mkdir C:\mysql\bin</userinput>
+C:\> <userinput>mkdir C:\mysql\data</userinput>
+C:\> <userinput>mkdir C:\mysql\share</userinput>
+C:\> <userinput>mkdir C:\mysql\scripts</userinput>
+</programlisting>
+
+ <para>
+ If you want to compile other clients and link them to
+ MySQL, you should also create several additional
+ directories:
+ </para>
+
+<programlisting>
+C:\> <userinput>mkdir C:\mysql\include</userinput>
+C:\> <userinput>mkdir C:\mysql\lib</userinput>
+C:\> <userinput>mkdir C:\mysql\lib\debug</userinput>
+C:\> <userinput>mkdir C:\mysql\lib\opt</userinput>
+</programlisting>
+
+ <para>
+ If you want to benchmark MySQL, create this directory:
+ </para>
+
+<programlisting>
+C:\> <userinput>mkdir C:\mysql\sql-bench</userinput>
+</programlisting>
+
+ <para>
+ Benchmarking requires Perl support. See
+ <xref linkend="perl-support"/>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ From the work directory, copy into the
+ <filename>C:\mysql</filename> directory the following
+ directories:
+ </para>
+
+<programlisting>
+C:\> <userinput>cd \workdir</userinput>
+C:\workdir> <userinput>copy client_release\*.exe C:\mysql\bin</userinput>
+C:\workdir> <userinput>copy client_debug\mysqld.exe C:\mysql\bin\mysqld-debug.exe</userinput>
+C:\workdir> <userinput>xcopy scripts\*.* C:\mysql\scripts /E</userinput>
+C:\workdir> <userinput>xcopy share\*.* C:\mysql\share /E</userinput>
+</programlisting>
+
+ <para>
+ If you want to compile other clients and link them to
+ MySQL, you should also copy several libraries and header
+ files:
+ </para>
+
+<programlisting>
+C:\workdir> <userinput>copy lib_debug\mysqlclient.lib C:\mysql\lib\debug</userinput>
+C:\workdir> <userinput>copy lib_debug\libmysql.* C:\mysql\lib\debug</userinput>
+C:\workdir> <userinput>copy lib_debug\zlib.* C:\mysql\lib\debug</userinput>
+C:\workdir> <userinput>copy lib_release\mysqlclient.lib C:\mysql\lib\opt</userinput>
+C:\workdir> <userinput>copy lib_release\libmysql.* C:\mysql\lib\opt</userinput>
+C:\workdir> <userinput>copy lib_release\zlib.* C:\mysql\lib\opt</userinput>
+C:\workdir> <userinput>copy include\*.h C:\mysql\include</userinput>
+C:\workdir> <userinput>copy libmysql\libmysql.def C:\mysql\include</userinput>
+</programlisting>
+
+ <para>
+ If you want to benchmark MySQL, you should also do this:
+ </para>
+
+<programlisting>
+C:\workdir> <userinput>xcopy sql-bench\*.* C:\mysql\bench /E</userinput>
+</programlisting>
+ </listitem>
+
+ </orderedlist>
+
+ <para>
+ After installation, set up and start the server in the same
+ way as for binary Windows distributions. See
+ <xref linkend="windows-installation"/>.
+ </para>
+
+ </section>
+
+ <section id="windows-source-testbuild">
+
+ <title>Testing a Windows Source Build</title>
+
+ <para>
+ You should test the server that you have built from source
+ before using the distribution.
+ </para>
+
+ <para>
+ To test the server you need to run the built
+ <command>mysqld</command>. By default, using the source build
+ examples, the MySQL base directory and data directory are
+ <filename>C:\mysql</filename> and
+ <filename>C:\mysql\data</filename>. If you want to test your
+ server using the source tree root directory and its data
+ directory as the base directory and data directory, you need
+ to tell the server their pathnames. You can either do this on
+ the command line with the <option>--basedir</option> and
+ <option>--datadir</option> options, or by placing appropriate
+ options in an option file. (See
+ <xref linkend="option-files"/>.) If you have an existing data
+ directory elsewhere that you want to use, you can specify its
+ pathname instead.
+ </para>
+
+ <para>
+ When the server is running in standalone fashion or as a
+ service based on your configuration, try to connect to it from
+ the <command>mysql</command> interactive command-line utility.
+ </para>
+
+ <para>
+ You can also run the standard test script,
+ <command>mysql-test-run.pl</command>. This script is written
+ in Perl, so you'll need either Cygwin or ActiveState Perl to
+ run it. You may also need to install the modules required by
+ the script. To run the test script, change location into the
+ <filename>mysql-test</filename> directory under the work
+ directory, set the <literal>MTR_VS_CONFIG</literal>
+ environment variable to the configuration you selected earlier
+ (or use the <literal>--vs-config</literal> option), and invoke
+ <command>mysql-test-run.pl</command>. For example (using
+ Cygwin and the <command>bash</command> shell):
+ </para>
+
+<programlisting>
+shell> <literal>cd mysql-test</literal>
+shell> <literal>export MTS_VS_CONFIG=debug</literal>
+shell> <literal>./mysqltest-run.pl --force --timer</literal>
+shell> <literal>./mysqltest-run.pl --force --timer --ps-protocol</literal>
+</programlisting>
+
+ </section>
+
<section id="windows-bitkeeper-build" role="cs">
- <title>Creating a Windows Source Package from the Latest Development Source</title>
+ <title>Creating a Windows Source Package from the BitKeeper Repository</title>
&cs-only;
<indexterm>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r7756 - trunk/refman-5.0 | mcbrown | 7 Sep |
