List:Commits« Previous MessageNext Message »
From:paul.dubois Date:November 24 2010 4:21am
Subject:svn commit - mysqldoc@docsrva: r23973 - in trunk: . refman-5.6
View as plain text  
Author: paul
Date: 2010-11-24 05:21:21 +0100 (Wed, 24 Nov 2010)
New Revision: 23973

Log:
 r65975@frost:  paul | 2010-11-23 22:18:27 -0500
 Hack in some of the initial instructions for building with CMake


Modified:
   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:44608
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:65972
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:44608
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:65975
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/refman-5.6/installing-source-core.xml
===================================================================
--- trunk/refman-5.6/installing-source-core.xml	2010-11-24 04:21:11 UTC (rev 23972)
+++ trunk/refman-5.6/installing-source-core.xml	2010-11-24 04:21:21 UTC (rev 23973)
Changed blocks: 5, Lines Added: 144, Lines Deleted: 137; 12885 bytes

@@ -43,92 +43,113 @@
   </note>
 
   <para>
-    To obtain a source distribution for MySQL,
-    <xref linkend="getting-mysql"/>. MySQL source distributions are
-    provided as compressed <command>tar</command> files, Zip archives,
-    or RPM packages and have names of the form
-    <filename>mysql-<replaceable>VERSION</replaceable>.tar.gz</filename>
-    <filename>mysql-<replaceable>VERSION</replaceable>.zip</filename>,
-    or
-    <filename>mysql-<replaceable>VERSION</replaceable>.rpm</filename>,
-    where <replaceable>VERSION</replaceable> is a number like
-    <literal>&current-version;</literal>.
+    Installation of MySQL from the source code can be done using
+    different methods:
   </para>
 
-  <para>
-    To perform a MySQL installation using the source code:
-  </para>
-
   <itemizedlist>
 
     <listitem>
       <para>
-        To build MySQL from source on Unix-like systems, including
-        Linux, commercial Unix, BSD, Mac OS X and others using a
-        <filename>tar.gz</filename> or RPM-based source code
-        distribution, see <xref linkend="quick-install"/>.
+        Use a standard MySQL source distribution. Standard distributions
+        are provided as compressed <command>tar</command> files, Zip
+        archives, or RPM packages and have names of the form
+        <filename>mysql-<replaceable>VERSION</replaceable>.tar.gz</filename>
+        <filename>mysql-<replaceable>VERSION</replaceable>.zip</filename>,
+        or
+        <filename>mysql-<replaceable>VERSION</replaceable>.rpm</filename>,
+        where <replaceable>VERSION</replaceable> is a number like
+        <literal>&current-version;</literal>.
       </para>
-    </listitem>
 
-    <listitem>
       <para>
-        To build MySQL from source on Windows (Windows XP or newer
-        required), see <xref linkend="windows-source-build"/>.
+        To obtain a standard source distribution for MySQL,
+        <xref linkend="getting-mysql"/>. For instruction on building
+        from a standard distribution, see
+        <xref linkend="quick-install"/>.
       </para>
     </listitem>
 
     <listitem>
       <para>
-        For information on building from one of our development trees,
-        see <xref linkend="installing-source-tree"/>.
+        Use a MySQL development tree. For information on building from
+        one of our development trees, see
+        <xref linkend="installing-source-tree"/>.
       </para>
     </listitem>
 
-    <listitem>
-      <para>
-        For information on using the <command>configure</command>
-        command to specify the source build parameters, including links
-        to platform specific parameters that you might need, see
-        <xref linkend="configure-options"/>.
-      </para>
-    </listitem>
-
   </itemizedlist>
 
   <para>
-    You need the following tools to build and install MySQL from source:
+    To build and install MySQL from a standard source distribution, you
+    need the following tools:
   </para>
 
   <itemizedlist>
 
     <listitem>
       <para>
-        GNU <literal>gunzip</literal> to uncompress the distribution and
-        a reasonable <command>tar</command> to unpack the it (if you use
-        a <filename>tar.gz</filename> distribution), or
-        <command>WinZip</command> or another tool that can read
-        <filename>.zip</filename> files (if you use a
-        <literal>.zip</literal> distribution).
+        A tool to unpack the distributionfile:
       </para>
 
-      <para>
-        The standard <command>tar</command> provided with some operating
-        systems is not able to unpack the long file names in the MySQL
-        distribution. You should download and install GNU
-        <command>tar</command>, or if available, use a pre-installed
-        version of GNU tar. Usually this is available as
-        <command>gnutar</command>, <command>gtar</command>, or as
-        <command>tar</command> within a GNU or Free Software directory,
-        such as <filename>/usr/sfw/bin</filename> or
-        <filename>/usr/local/bin</filename>.
-      </para>
+      <itemizedlist>
+
+        <listitem>
+          <para>
+            For a <filename>tar.gz</filename> compressed
+            <command>tar</command> file, use GNU
+            <literal>gunzip</literal> to uncompress the distribution and
+            a reasonable <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.
+          </para>
+
+          <para>
+            The standard <command>tar</command> provided with some
+            operating systems is not able to unpack the long file names
+            in the MySQL distribution. You should download and install
+            GNU <command>tar</command>, or if available, use a
+            pre-installed version of GNU tar. Usually this is available
+            as <command>gnutar</command>, <command>gtar</command>, or as
+            <command>tar</command> within a GNU or Free Software
+            directory, such as <filename>/usr/sfw/bin</filename> or
+            <filename>/usr/local/bin</filename>.
+          </para>
+
+          <para>
+            Another alternative is to use CMake, which has
+            <command>tar</command> capability. Invoke it as
+            <command>cmake -E tar xfz
+            <replaceable>file_name.tar.gz</replaceable></command>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            For a <filename>.zip</filename> Zip archive, use
+            <command>WinZip</command> or another tool that can read
+            <filename>.zip</filename> files.
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            For an <filename>.rpm</filename> RPM package, the
+            <command>rpmbuild</command> program used to build the
+            distribution will pack it.
+          </para>
+        </listitem>
+
+      </itemizedlist>
     </listitem>
 
     <listitem>
       <para>
-        A working ANSI C++ compiler. GCC 3.2 or later, Sun Studio 10 or
-        later, Visual Studio 2008 or later, and many current
-        vendor-supplied compilers are known to work.
+        CMake, which can be downloaded from
+        <ulink url="http://www.cmake.org"/>. After installing, modify
+        your <literal>PATH</literal> environment variable to include the
+        directory where <literal>cmake</literal> is located.
       </para>
     </listitem>
 

@@ -145,15 +166,75 @@
 
     <listitem>
       <para>
-        <command>libtool</command> 1.5, available from
-        <ulink url="http://www.gnu.org/software/libtool/"/>. 1.5.24 or
-        later is recommended.
+        A working ANSI C++ compiler. GCC 3.2 or later, Sun Studio 10 or
+        later, Visual Studio 2008 or later, and many current
+        vendor-supplied compilers are known to work.
       </para>
     </listitem>
 
+    <listitem>
+      <para>
+        Perl is needed if you intend to run test scripts.
+      </para>
+    </listitem>
+
   </itemizedlist>
 
   <para>
+    If you build and install MySQL using a development source tree, the
+    following additional tools are required:
+  </para>
+
+  <itemizedlist>
+
+    <listitem>
+      <para>
+        To obtain the source tree, you must have Bazaar installed.
+        Instructions for downloading and installing Bazaar on different
+        platforms are available on the
+        <ulink url="http://bazaar-vcs.org">Bazaar VCS Web site</ulink>.
+        Bazaar is supported by any platform that supports Python, and is
+        therefore compatible with any Linux, Unix, Windows or Mac OS X
+        host.
+      </para>
+    </listitem>
+
+    <listitem>
+      <para>
+        <command>bison</command>, available from
+        <ulink url="http://www.gnu.org/software/bison/"/>. You should
+        use the latest version of <command>bison</command> where
+        possible. Version 1.75 and version 2.1 are known to work. There
+        have been reported problems with <command>bison</command> 1.875.
+        If you experience problems, upgrade to a later, rather than
+        earlier, version.
+      </para>
+
+      <para>
+        <literal>bison</literal> for Windows can be downloaded from
+        <ulink url="http://gnuwin32.sourceforge.net/packages/bison.htm"/>.
+        Download the package labeled <quote>Complete package, excluding
+        sources</quote>. After installing the package, modify your
+        <literal>PATH</literal> environment variable to include the
+        directory where <command>bison</command> is located.
+      </para>
+
+      <note>
+        <para>
+          On Windows, the default location for <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
+          <filename>C:\GnuWin32</filename>.
+        </para>
+      </note>
+    </listitem>
+
+  </itemizedlist>
+
+  <para>
     If you run into problems and need to file a bug report, please use
     the instructions in <xref linkend="bug-reports"/>.
   </para>

@@ -533,10 +614,6 @@
     </indexterm>
 
     <indexterm>
-      <primary>BitKeeper tree</primary>
-    </indexterm>
-
-    <indexterm>
       <primary>Bazaar tree</primary>
     </indexterm>
 

@@ -561,16 +638,6 @@
     </note>
 
     <para>
-      To obtain the most recent development source tree, you must have
-      Bazaar installed. Instructions for downloading and installing
-      Bazaar on different platforms are available on the
-      <ulink url="http://bazaar-vcs.org">Bazaar VCS Web site</ulink>.
-      Bazaar is supported by any platform that supports Python, and is
-      therefore compatible with any Linux, Unix, Windows or Mac OS X
-      host.
-    </para>
-
-    <para>
       All MySQL projects are hosted on
       <ulink url="http://launchpad.net/">Launchpad</ulink>. MySQL
       projects, including MySQL server, MySQL Workbench, and others are

@@ -583,77 +650,17 @@
     </para>
 
     <para>
-      To build under Unix/Linux, you must have the following tools
-      installed:
+      To build and install MySQL from a development source tree, you
+      must have the tools listed at
+      <xref linkend="source-installation"/>, including Bazaar and
+      <command>bison</command>.
     </para>
 
-    <itemizedlist>
-
-      <listitem>
-        <para>
-          A good <command>make</command> program. Although some
-          platforms come with their own <command>make</command>
-          implementations, it is highly recommended that you use GNU
-          <command>make</command> 3.75 or newer. It may already be
-          available on your system as <command>gmake</command>. GNU
-          <command>make</command> is available from
-          <ulink url="http://www.gnu.org/software/make/"/>.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          <command>autoconf</command> 2.58 (or newer), available from
-          <ulink url="http://www.gnu.org/software/autoconf/"/>.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          <command>automake</command> 1.8.1, available from
-          <ulink url="http://www.gnu.org/software/automake/"/>.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          <command>libtool</command> 1.5, available from
-          <ulink url="http://www.gnu.org/software/libtool/"/>. 1.5.24 or
-          later is recommended.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          <command>m4</command>, available from
-          <ulink url="http://www.gnu.org/software/m4/"/>.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          <command>bison</command>, available from
-          <ulink url="http://www.gnu.org/software/bison/"/>. You should
-          use the latest version of <command>bison</command> where
-          possible. Version 1.75 and version 2.1 are known to work.
-          There have been reported problems with
-          <command>bison</command> 1.875. If you experience problems,
-          upgrade to a later, rather than earlier, version.
-        </para>
-      </listitem>
-
-    </itemizedlist>
-
     <para>
-      To build under Windows you must have Microsoft Visual Studio 2008
-      or later.
+      Use Bazaar to create a local branch of the MySQL development tree
+      on your machine:
     </para>
 
-    <para>
-      Once the necessary tools are installed, you must create a local
-      branch of the MySQL source code on your machine:
-    </para>
-
     <orderedlist>
 
       <listitem>


Thread
svn commit - mysqldoc@docsrva: r23973 - in trunk: . refman-5.6paul.dubois24 Nov