svn commit - mysqldoc@docsrva: r4878 - in trunk: . refman-4.1 refman-5.0 refman-5.1

[paul]

Author: paul
Date: 2007-02-09 19:57:39 +0100 (Fri, 09 Feb 2007)
New Revision: 4878

Log:
 r16059@frost:  paul | 2007-02-09 12:55:00 -0600
 General cleanup of Windows source-build instructions, harmonization
 of unnecessary differences between versions.


Modified:
   trunk/refman-4.1/installing.xml
   trunk/refman-5.0/installing-cs.xml
   trunk/refman-5.1/installing.xml

Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:19608
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:16057
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:19608
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:16059
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/installing.xml
===================================================================
--- trunk/refman-4.1/installing.xml	2007-02-09 18:01:59 UTC (rev 4877)
+++ trunk/refman-4.1/installing.xml	2007-02-09 18:57:39 UTC (rev 4878)
Changed blocks: 10, Lines Added: 34, Lines Deleted: 30; 6205 bytes

@@ -4212,16 +4212,16 @@
 </programlisting>
 
       <formalpara role="mnmas">
+
         <title>MySQL Enterprise</title>
 
-
-
         <para>
           For expert advice on the start-up options appropriate to your
           circumstances, subscribe to the MySQL Network Monitoring and
           Advisory Service. For more information see,
           <ulink url="&base-url-enterprise;advisors.html"/>.
         </para>
+
       </formalpara>
 
       <para>

@@ -9486,45 +9486,45 @@
 
       <para>
         These instructions describe how to build binaries from source
-        for MySQL 4.1 and up on Windows. Instructions are provided for
+        for MySQL &current-series; on Windows. Instructions are provided
         building binaries from a standard source distribution or from
         the BitKeeper tree that contains the latest development source.
       </para>
 
       <para>
         <emphasis role="bold">Note</emphasis>: The instructions here are
-        strictly for users who want to test MySQL on Windows from the
-        latest source distribution or from the BitKeeper tree. For
-        production use, MySQL AB does not advise using a MySQL server
-        built by yourself from source. Normally, it is best to use
-        precompiled binary distributions of MySQL that are built
+        strictly for users who want to test MySQL on Microsoft Windows
+        from the latest source distribution or from the BitKeeper tree.
+        For production use, MySQL AB does not advise using a MySQL
+        server built by yourself from source. Normally, it is best to
+        use precompiled binary distributions of MySQL that are built
         specifically for optimal performance on Windows by MySQL AB.
-        Instructions for installing a binary distributions are available
+        Instructions for installing binary distributions are available
         in <xref linkend="windows-installation"/>.
       </para>
 
       <para>
-        To build MySQL on Windows from source, you need the following
-        compiler and resources available on your Windows system:
+        To build MySQL on Windows from source, you must satisfy the
+        following system, compiler, and resource requirements:
       </para>
 
       <itemizedlist>
 
         <listitem>
           <para>
-            Visual Studio .Net 2003 (7.1) compiler system
+            Windows XP, Windows 2000, or newer version
           </para>
         </listitem>
 
         <listitem>
           <para>
-            Between 3GB and 5GB disk space.
+            Visual Studio .Net 2003 (7.1) compiler system
           </para>
         </listitem>
 
         <listitem>
           <para>
-            Windows XP, Windows 2000 or higher.
+            3GB to 5GB of disk space
           </para>
         </listitem>
 

@@ -9536,11 +9536,11 @@
       </para>
 
       <para>
-        You also need a MySQL source distribution for Windows. For MySQL
-        4.1 and up, there are two ways to obtain a source distribution:
+        You also need a MySQL source distribution for Windows, which can
+        be obtained two ways:
       </para>
 
-      <orderedlist>
+      <itemizedlist>
 
         <listitem>
           <para>

@@ -9553,12 +9553,12 @@
 
         <listitem>
           <para>
-            You can package a source distribution yourself from the
-            latest BitKeeper developer source tree. If you plan to do
-            this, 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.) The BitKeeper approach thus requires:
+            Package a source distribution yourself from the latest
+            BitKeeper developer source tree. If you plan to do this, 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.) The
+            BitKeeper approach thus requires:
           </para>
 
           <itemizedlist>

@@ -9581,7 +9581,7 @@
           </itemizedlist>
         </listitem>
 
-      </orderedlist>
+      </itemizedlist>
 
       <para>
         If you are using a Windows source distribution, you can go

@@ -9599,7 +9599,7 @@
 
       <section id="windows-vc-plus-plus-build">
 
-        <title>Building MySQL Using VC++</title>
+        <title>Building MySQL from Source Using VC++</title>
 
         <para>
           <emphasis role="bold">Note</emphasis>: VC++ workspace files

@@ -9636,7 +9636,7 @@
 
           <listitem>
             <para>
-              From the <guimenu>File menu</guimenu>, select
+              From the <guimenu>File</guimenu> menu, select
               <guimenuitem>Open Solution...</guimenuitem>.
             </para>
           </listitem>

@@ -9828,8 +9828,8 @@
         </orderedlist>
 
         <para>
-          Set up and start the server in the same way as for the binary
-          Windows distribution. See
+          Set up and start the server in the same way as for binary
+          Windows distributions. See
           <xref linkend="windows-installation"/>.
         </para>
 

@@ -9839,6 +9839,10 @@
 
         <title>Creating a Windows Source Package from the Latest Development
Source</title>
 
+        <indexterm>
+          <primary>make_win_src_distribution</primary>
+        </indexterm>
+
         <para>
           To create a Windows source package from the current BitKeeper
           source tree, use the instructions here. This procedure must be

@@ -11355,16 +11359,16 @@
         </para>
 
         <formalpara role="mnmas">
+
           <title>MySQL Enterprise</title>
 
-
-
           <para>
             For expert advice on start-up options appropriate to your
             circumstances, subscribe to The MySQL Network Monitoring and
             Advisory Service. For more information see,
             <ulink url="&base-url-enterprise;advisors.html"/>.
           </para>
+
         </formalpara>
 
         <itemizedlist>


Modified: trunk/refman-5.0/installing-cs.xml
===================================================================
--- trunk/refman-5.0/installing-cs.xml	2007-02-09 18:01:59 UTC (rev 4877)
+++ trunk/refman-5.0/installing-cs.xml	2007-02-09 18:57:39 UTC (rev 4878)
Changed blocks: 11, Lines Added: 34, Lines Deleted: 31; 6243 bytes

@@ -4334,16 +4334,16 @@
 </programlisting>
 
           <formalpara role="mnmas">
+
             <title>MySQL Enterprise</title>
 
-
-
             <para>
               For expert advice on the start-up options appropriate to
               your circumstances, subscribe to the MySQL Network
               Monitoring and Advisory Service. For more information see,
               <ulink url="&base-url-enterprise;advisors.html"/>.
             </para>
+
           </formalpara>
 
           <para>

@@ -7516,8 +7516,7 @@
             <command>mysqld</command> to be disabled. For Windows, the
             <command>configure.js</command> script recognizes the
             <literal>DISABLE_GRANT_OPTIONS</literal> flag, which has the
-            same effect. The capability is available as of MySQL
-            5.0.34.
+            same effect. The capability is available as of MySQL 5.0.34.
           </para>
         </listitem>
 

@@ -8582,38 +8581,38 @@
 
       <para>
         <emphasis role="bold">Note</emphasis>: The instructions here are
-        strictly for users who want to test MySQL on Windows from the
-        latest source distribution or from the BitKeeper tree. For
-        production use, MySQL AB does not advise using a MySQL server
-        built by yourself from source. Normally, it is best to use
-        precompiled binary distributions of MySQL that are built
+        strictly for users who want to test MySQL on Microsoft Windows
+        from the latest source distribution or from the BitKeeper tree.
+        For production use, MySQL AB does not advise using a MySQL
+        server built by yourself from source. Normally, it is best to
+        use precompiled binary distributions of MySQL that are built
         specifically for optimal performance on Windows by MySQL AB.
-        Instructions for installing a binary distributions are available
+        Instructions for installing binary distributions are available
         in <xref linkend="windows-installation"/>.
       </para>
 
       <para>
-        To build MySQL on Windows from source, you need the following
-        compiler and resources available on your Windows system:
+        To build MySQL on Windows from source, you must satisfy the
+        following system, compiler, and resource requirements:
       </para>
 
       <itemizedlist>
 
         <listitem>
           <para>
-            Visual Studio .Net 2003 (7.1) compiler system
+            Windows XP, Windows 2000, or newer version
           </para>
         </listitem>
 
         <listitem>
           <para>
-            Between 3GB and 5GB disk space.
+            Visual Studio .Net 2003 (7.1) compiler system
           </para>
         </listitem>
 
         <listitem>
           <para>
-            Windows XP, Windows 2000 or higher.
+            3GB to 5GB of disk space
           </para>
         </listitem>
 

@@ -8625,11 +8624,11 @@
       </para>
 
       <para>
-        You also need a MySQL source distribution for Windows. There are
-        two ways to obtain a source distribution:
+        You also need a MySQL source distribution for Windows, which can
+        be obtained two ways:
       </para>
 
-      <orderedlist>
+      <itemizedlist>
 
         <listitem>
           <para>

@@ -8642,12 +8641,12 @@
 
         <listitem>
           <para>
-            You can package a source distribution yourself from the
-            latest BitKeeper developer source tree. If you plan to do
-            this, 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.) The BitKeeper approach thus requires:
+            Package a source distribution yourself from the latest
+            BitKeeper developer source tree. If you plan to do this, 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.) The
+            BitKeeper approach thus requires:
           </para>
 
           <itemizedlist>

@@ -8670,7 +8669,7 @@
           </itemizedlist>
         </listitem>
 
-      </orderedlist>
+      </itemizedlist>
 
       <para>
         If you are using a Windows source distribution, you can go

@@ -8688,7 +8687,7 @@
 
       <section id="windows-vc-plus-plus-build" role="cs">
 
-        <title>Building MySQL Using VC++</title>
+        <title>Building MySQL from Source Using VC++</title>
     &cs-only;
 
         <para>

@@ -8727,7 +8726,7 @@
 
           <listitem>
             <para>
-              From the <guimenu>File menu</guimenu>, select
+              From the <guimenu>File</guimenu> menu, select
               <guimenuitem>Open Solution...</guimenuitem>.
             </para>
           </listitem>

@@ -8919,8 +8918,8 @@
         </orderedlist>
 
         <para>
-          Set up and start the server in the same way as for the binary
-          Windows distribution. See
+          Set up and start the server in the same way as for binary
+          Windows distributions. See
           <xref linkend="windows-installation"/>.
         </para>
 

@@ -8931,6 +8930,10 @@
         <title>Creating a Windows Source Package from the Latest Development
Source</title>
     &cs-only;
 
+        <indexterm>
+          <primary>make_win_src_distribution</primary>
+        </indexterm>
+
         <para>
           To create a Windows source package from the current BitKeeper
           source tree, use the instructions here. This procedure must be

@@ -10437,16 +10440,16 @@
         </para>
 
         <formalpara role="mnmas">
+
           <title>MySQL Enterprise</title>
 
-
-
           <para>
             For expert advice on start-up options appropriate to your
             circumstances, subscribe to The MySQL Network Monitoring and
             Advisory Service. For more information see,
             <ulink url="&base-url-enterprise;advisors.html"/>.
           </para>
+
         </formalpara>
 
         <itemizedlist>


Modified: trunk/refman-5.1/installing.xml
===================================================================
--- trunk/refman-5.1/installing.xml	2007-02-09 18:01:59 UTC (rev 4877)
+++ trunk/refman-5.1/installing.xml	2007-02-09 18:57:39 UTC (rev 4878)
Changed blocks: 13, Lines Added: 58, Lines Deleted: 43; 8671 bytes

@@ -4202,16 +4202,16 @@
 </programlisting>
 
       <formalpara role="mnmas">
+
         <title>MySQL Enterprise</title>
 
-
-
         <para>
           For expert advice on the start-up options appropriate to your
           circumstances, subscribe to the MySQL Network Monitoring and
           Advisory Service. For more information see,
           <ulink url="&base-url-enterprise;advisors.html"/>.
         </para>
+
       </formalpara>
 
       <para>

@@ -9426,7 +9426,7 @@
         server built by yourself from source. Normally, it is best to
         use precompiled binary distributions of MySQL that are built
         specifically for optimal performance on Windows by MySQL AB.
-        Instructions for installing a binary distributions are available
+        Instructions for installing binary distributions are available
         in <xref linkend="windows-installation"/>.
       </para>
 

@@ -9439,23 +9439,16 @@
 
         <listitem>
           <para>
-            CMake, which can be downloaded from
-            <ulink url="http://www.cmake.org">http://www.cmake.org</ulink>.
-            After installing, modify your path to include the cmake
-            binary.
+            Windows 2000, Windows XP, or newer version.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            If compiling from from a BitKeeper tree or making changes to
-            the parser you need <literal>bison</literal> for Windows,
-            which can be downloaded from
-            <ulink
url="http://gnuwin32.sourceforge.net/packages/bison.htm">http://gnuwin32.sourceforge.net/packages/bison.htm</ulink>.
-            Download the package labelled <quote>Complete package,
-            excluding sources</quote>. After installing, modify your
-            path to include the <command>bison</command> binary and
-            ensure that this binary is accessible from Visual Studio.
+            CMake, which can be downloaded from
+            <ulink url="http://www.cmake.org">http://www.cmake.org</ulink>.
+            After installing, modify your path to include the cmake
+            binary.
           </para>
         </listitem>
 

@@ -9478,13 +9471,21 @@
 
         <listitem>
           <para>
-            Between 3GB and 5GB disk space.
+            If you are compiling from from a BitKeeper tree or making
+            changes to the parser, you need <literal>bison</literal> for
+            Windows, which can be downloaded from
+            <ulink
url="http://gnuwin32.sourceforge.net/packages/bison.htm">http://gnuwin32.sourceforge.net/packages/bison.htm</ulink>.
+            Download the package labeled <quote>Complete package,
+            excluding sources</quote>. After installing the package,
+            modify your path to include the <command>bison</command>
+            binary and ensure that this binary is accessible from Visual
+            Studio.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            Windows 2000, Windows XP, or newer version.
+            3GB to 5GB of disk space.
           </para>
         </listitem>
 

@@ -9498,11 +9499,11 @@
       </para>
 
       <para>
-        You also need a MySQL source distribution for Windows. There are
-        two ways to obtain a source distribution:
+        You also need a MySQL source distribution for Windows, which can
+        be obtained two ways:
       </para>
 
-      <orderedlist>
+      <itemizedlist>
 
         <listitem>
           <para>

@@ -9513,14 +9514,14 @@
 
         <listitem>
           <para>
-            You can package a source distribution yourself from the
-            latest BitKeeper developer source tree. For instructions on
-            pulling the latest source files, see
+            Package a source distribution yourself from the latest
+            BitKeeper developer source tree. For instructions on pulling
+            the latest source files, see
             <xref linkend="installing-source-tree"/>.
           </para>
         </listitem>
 
-      </orderedlist>
+      </itemizedlist>
 
       <para>
         If you find something not working as expected, or you have

@@ -9539,25 +9540,34 @@
           <para>
             If you are installing from a packaged source distribution,
             create a work directory (for example,
-            <filename>C:\workdir</filename>). Unpack the source
-            distribution in the aforementioned directory using
-            <command>WinZip</command> or another Windows tool that can
-            read <filename>.zip</filename> files.
+            <filename>C:\workdir</filename>), and unpack the source
+            distribution there using <command>WinZip</command> or
+            another Windows tool that can read <filename>.zip</filename>
+            files. This directory is the work directory in the following
+            instructions.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            Using a command shell, navigate to the work or BK root
-            directory and run the following command:
+            If you are installing from a BitKeeper tree, consider the
+            root directory of that tree to be the work directory in the
+            following instructions.
           </para>
+        </listitem>
 
+        <listitem>
+          <para>
+            Using a command shell, navigate to the work directory and
+            run the following command:
+          </para>
+
 <programlisting>
-C:\workdir>win\configure <replaceable>options</replaceable>
+C:\workdir&gt;<userinput>win\configure
<replaceable>options</replaceable></userinput>
 </programlisting>
 
           <para>
-            The options are available:
+            These options are available:
           </para>
 
           <itemizedlist>

@@ -9635,17 +9645,18 @@
           </itemizedlist>
 
           <para>
-            For example:
+            For example (type the command on one line):
           </para>
 
 <programlisting>
-win\configure WITH_INNOBASE_STORAGE_ENGINE WITH_PARTITION_STORAGE_ENGINE
MYSQL_SERVER_SUFFIX=-pro  
+C:\workdir&gt;<userinput>win\configure
WITH_INNOBASE_STORAGE_ENGINE</userinput>
+             <userinput>WITH_PARTITION_STORAGE_ENGINE
MYSQL_SERVER_SUFFIX=-pro</userinput>
 </programlisting>
         </listitem>
 
         <listitem>
           <para>
-            From the work or BK root directory, execute the
+            From the work directory, execute the
             <filename>win\build-vs8.bat</filename> or
             <filename>win\build-vs71.bat</filename> file, depending on
             the version of Visual Studio you have installed.

@@ -9654,7 +9665,7 @@
 
         <listitem>
           <para>
-            From the work or BK root directory, execute the generated
+            From the work directory, execute the generated
             <filename>mysql.sln</filename> file. Visual Studio will load
             the solution and you can then click
             <guimenu>Solution</guimenu> >

@@ -9742,9 +9753,9 @@
 
         <listitem>
           <para>
-            From the <filename>workdir</filename> or BK root directory,
-            copy into the <filename>C:\mysql</filename> directory the
-            following directories:
+            From the work directory, copy into the
+            <filename>C:\mysql</filename> directory the following
+            directories:
           </para>
 
 <programlisting>

@@ -9783,8 +9794,8 @@
       </orderedlist>
 
       <para>
-        Set up and start the server in the same way as for the binary
-        Windows distribution. See
+        Set up and start the server in the same way as for binary
+        Windows distributions. See
         <xref linkend="windows-installation"/>.
       </para>
 

@@ -9796,6 +9807,10 @@
           <primary>Borland C++ compiler</primary>
         </indexterm>
 
+        <indexterm>
+          <primary>make_win_src_distribution</primary>
+        </indexterm>
+
         <para>
           You can compile the MySQL Windows source with Borland C++
           5.02. (The Windows source includes only projects for Microsoft

@@ -11174,16 +11189,16 @@
         </para>
 
         <formalpara role="mnmas">
+
           <title>MySQL Enterprise</title>
 
-
-
           <para>
             For expert advice on start-up options appropriate to your
             circumstances, subscribe to The MySQL Network Monitoring and
             Advisory Service. For more information see,
             <ulink url="&base-url-enterprise;advisors.html"/>.
           </para>
+
         </formalpara>
 
         <itemizedlist>