List:Commits« Previous MessageNext Message »
From:paul.dubois Date:December 3 2010 4:49pm
Subject:svn commit - mysqldoc@docsrva: r24215 - in trunk: . refman-4.1 refman-5.0 refman-5.1 refman-6.0
View as plain text  
Author: paul
Date: 2010-12-03 17:49:22 +0100 (Fri, 03 Dec 2010)
New Revision: 24215

Log:
 r66436@frost:  paul | 2010-12-03 10:44:13 -0500
 Harmonize version differences


Modified:
   trunk/refman-4.1/installing-source.xml
   trunk/refman-5.0/installing-source-core.xml
   trunk/refman-5.1/installing-source-core.xml
   trunk/refman-6.0/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:44986
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:66435
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:44986
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:66436
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-4.1/installing-source.xml
===================================================================
--- trunk/refman-4.1/installing-source.xml	2010-12-03 16:49:14 UTC (rev 24214)
+++ trunk/refman-4.1/installing-source.xml	2010-12-03 16:49:22 UTC (rev 24215)
Changed blocks: 9, Lines Added: 121, Lines Deleted: 72; 12545 bytes

@@ -24,62 +24,111 @@
   </indexterm>
 
   <para>
-    Before you proceed with an installation from source, first check
-    whether we produce a binary distribution for your platform and
-    whether it works for you. We put a great deal of effort into
-    ensuring that our binaries are built with the best possible options.
-    Source builds allow you to customize the build parameters, compiler
-    optimizations, and installation location.
+    Building MySQL from the source code enables you to customize build
+    parameters, compiler optimizations, and installation location. For a
+    list of systems on which MySQL is known to run, see
+    <xref linkend="supported-os"/>.
   </para>
 
   <para>
-    To obtain a source distribution for MySQL, see
-    <xref linkend="getting-mysql"/>. To build MySQL from source on
-    Windows, see <xref linkend="windows-source-build"/>.
+    Before you proceed with an installation from source, check whether
+    we produce a precompiled binary distribution for your platform and
+    whether it works for you. We put a great deal of effort into
+    ensuring that our binaries are built with the best possible options
+    for optimal performance. Instructions for installing binary
+    distributions are available in
+    <xref linkend="binary-installation"/>.
   </para>
 
   <para>
-    MySQL source distributions are provided as compressed
-    <command>tar</command> archives or Zip archives and have names of
-    the form
-    <filename>mysql-<replaceable>VERSION</replaceable>.tar.gz</filename>
+    To obtain a source distribution for MySQL, see
+    <xref linkend="getting-mysql"/>. MySQL source distributions are
+    available as compressed <command>tar</command> files, Zip archives,
+    or RPM packages. Distribution files 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>.zip</filename>,
+    <filename>mysql-<replaceable>VERSION</replaceable>.rpm</filename>,
     where <replaceable>VERSION</replaceable> is a number like
     <literal>&current-version;</literal>.
   </para>
 
   <para>
-    To install MySQL from source, your system must have the following
-    tools:
+    To perform a MySQL installation using the source code:
   </para>
 
   <itemizedlist>
 
     <listitem>
       <para>
-        GNU <literal>gunzip</literal> to uncompress the distribution.
+        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="installing-source-distribution"/>.
       </para>
     </listitem>
 
     <listitem>
       <para>
-        A reasonable <command>tar</command> to unpack the distribution.
-        GNU <command>tar</command> is known to work. Some operating
-        systems come with a preinstalled version of
-        <command>tar</command> that is known to have problems. For
-        example, the <command>tar</command> provided with early versions
-        of Mac OS X <command>tar</command>, SunOS 4.x and Solaris 8 and
-        earlier are known to have problems with long file names. On Mac
-        OS X, you can use the preinstalled <command>gnutar</command>
-        program. On other systems with a deficient
-        <command>tar</command>, you should install GNU
-        <command>tar</command> first.
+        To build MySQL from source on Windows (Windows XP or newer
+        required), see <xref linkend="windows-source-build"/>.
       </para>
     </listitem>
 
     <listitem>
       <para>
+        For information on building from one of our development trees,
+        see <xref linkend="installing-development-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="source-configuration-options"/>.
+      </para>
+    </listitem>
+
+  </itemizedlist>
+
+  <para>
+    To install MySQL from source, your system must have the following
+    tools:
+  </para>
+
+  <itemizedlist>
+
+    <listitem>
+      <para>
+        GNU <literal>gunzip</literal> to uncompress the distribution and
+        a reasonable <command>tar</command> to unpack 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).
+      </para>
+
+      <para>
+        GNU <command>tar</command> is known to work. 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 preinstalled
+        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>. GNU <command>tar</command>
+        is available from
+        <ulink url="http://www.gnu.org/software/tar/"/>.
+      </para>
+    </listitem>
+
+    <listitem>
+      <para>
         A working ANSI C++ compiler. GCC 3.2 or later, Sun Studio 10 or
         later, Visual Studio 2005 or later, and many current
         vendor-supplied compilers are known to work.

@@ -143,18 +192,41 @@
     </para>
 
     <para>
-      The basic commands that you must execute to install a MySQL source
-      distribution are:
+      If you start from a source RPM, use the following command to make
+      a binary RPM that you can install. If you do not have
+      <command>rpmbuild</command>, use <command>rpm</command> instead.
     </para>
 
 <programlisting>
+shell&gt; <userinput>rpmbuild --rebuild --clean MySQL-<replaceable>VERSION</replaceable>.src.rpm</userinput>
+</programlisting>
+
+    <para>
+      The result is one or more binary RPM packages that you install as
+      indicated in <xref linkend="linux-installation-rpm"/>.
+    </para>
+
+    <para>
+      The sequence for installation from a compressed
+      <command>tar</command> file source distribution is similar to the
+      process for installing from a generic binary distribution that is
+      detailed in <xref linkend="binary-installation"/>. For a MySQL
+      <filename>.tar.gz</filename> source distribution, the basic
+      installation command sequence looks like this:
+    </para>
+
+<programlisting>
+# Preconfiguration setup
 shell&gt; <userinput>groupadd mysql</userinput>
 shell&gt; <userinput>useradd -g mysql mysql</userinput>
-shell&gt; <userinput>gunzip &lt; mysql-<replaceable>VERSION</replaceable>.tar.gz | tar -xvf -</userinput>
+# Beginning of source-build specific instructions
+shell&gt; <userinput>tar zxvf mysql-<replaceable>VERSION</replaceable>.tar.gz</userinput>
 shell&gt; <userinput>cd mysql-<replaceable>VERSION</replaceable></userinput>
 shell&gt; <userinput>./configure --prefix=/usr/local/mysql</userinput>
 shell&gt; <userinput>make</userinput>
 shell&gt; <userinput>make install</userinput>
+# End of source-build specific instructions
+# Postinstallation setup
 shell&gt; <userinput>cp support-files/my-medium.cnf /etc/my.cnf</userinput>
 shell&gt; <userinput>cd /usr/local/mysql</userinput>
 shell&gt; <userinput>chown -R mysql .</userinput>

@@ -171,21 +243,6 @@
       <command>bin/mysqld_safe</command> in the final command.
     </para>
 
-    <para>
-      If you start from a source RPM, use the following command to make
-      a binary RPM that you can install. If you do not have
-      <command>rpmbuild</command>, use <command>rpm</command> instead.
-    </para>
-
-<programlisting>
-shell&gt; <userinput>rpmbuild --rebuild --clean MySQL-<replaceable>VERSION</replaceable>.src.rpm</userinput>
-</programlisting>
-
-    <para>
-      The result is one or more binary RPM packages that you install as
-      indicated in <xref linkend="linux-installation-rpm"/>.
-    </para>
-
     <note>
       <para>
         This procedure does not set up any passwords for MySQL accounts.

@@ -223,9 +280,9 @@
         </para>
 
         <para>
-          You might want to call the user and group something other than
-          <literal>mysql</literal>. If so, substitute the appropriate
-          name in the following steps.
+          You might want to call the user and group something else
+          instead of <literal>mysql</literal>. If so, substitute the
+          appropriate name in the following steps.
         </para>
       </listitem>
 

@@ -307,14 +364,6 @@
 
         <para>
           When you run <command>configure</command>, you might want to
-          specify other options. Run <command>./configure
-          --help</command> for a list of options.
-          <xref linkend="source-configuration-options"/>, discusses some
-          of the more useful options.
-        </para>
-
-        <para>
-          When you run <command>configure</command>, you might want to
           specify other options. For example, if you need to debug
           <command>mysqld</command> or a MySQL client, run
           <command>configure</command> with the

@@ -586,22 +635,22 @@
 
     <para>
       This section discusses how to install MySQL from the latest
-      development source code. The code contains the most recent changes
-      and has not necessarily received the same level of testing as
-      standard release distributions. Therefore, if your goal is simply
-      to get MySQL up and running on your system, you should use a
-      standard release distribution (either a binary or source
+      development source code. Development trees have not necessarily
+      received the same level of testing as standard release
+      distributions, so this installation method is usually necessary
+      only if you need the most recent code changes. If your goal is
+      simply to get MySQL up and running on your system, you should use
+      a standard release distribution (either a binary or source
       distribution). See <xref linkend="getting-mysql"/>.
     </para>
 
     <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 on any platform that supports Python, and is
-      therefore compatible with any Linux, Unix, Windows, or Mac OS X
-      host.
+      To obtain the source tree, you must have Bazaar installed. The
+      <ulink url="http://bazaar-vcs.org">Bazaar VCS Web site</ulink> has
+      instructions for downloading and installing Bazaar on different
+      platforms. Bazaar is supported on any platform that supports
+      Python, and is therefore compatible with any Linux, Unix, Windows,
+      or Mac OS X host.
     </para>
 
     <para>

@@ -674,7 +723,7 @@
           <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.
+          possible. Versions 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. Versions of

@@ -1464,7 +1513,7 @@
         </para>
 
 <programlisting>
-shell&gt; <userinput>./configure --with-collation=COLLATION</userinput>
+shell&gt; <userinput>./configure --with-collation=<replaceable>COLLATION</replaceable></userinput>
 </programlisting>
 
         <para>

@@ -2068,7 +2117,7 @@
 
       <listitem>
         <para>
-          If your compilation fails with errors such as any of the
+          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>:
         </para>


Modified: trunk/refman-5.0/installing-source-core.xml
===================================================================
--- trunk/refman-5.0/installing-source-core.xml	2010-12-03 16:49:14 UTC (rev 24214)
+++ trunk/refman-5.0/installing-source-core.xml	2010-12-03 16:49:22 UTC (rev 24215)
Changed blocks: 2, Lines Added: 5, Lines Deleted: 5; 1564 bytes

@@ -422,8 +422,8 @@
 
         <para>
           If you want to configure support for <literal>InnoDB</literal>
-          tables, you should edit the <literal>/etc/my.cnf</literal>
-          file, remove the <literal>#</literal> character before the
+          tables, you should edit the <filename>/etc/my.cnf</filename>
+          file, removing the <literal>#</literal> character before the
           option lines that start with <literal>innodb_...</literal>,
           and modify the option values to be what you want. See
           <xref linkend="option-files"/>, and

@@ -1967,9 +1967,9 @@
           but not <literal>libg++</literal>, or
           <literal>libstdc++</literal>. Take a look at the
           <filename>config.log</filename> file. It should contain the
-          exact reason why your C++ compiler didn't work. To work around
-          these problems, you can use <command>gcc</command> as your C++
-          compiler. Try setting the environment variable
+          exact reason why your C++ compiler did not work. To work
+          around these problems, you can use <command>gcc</command> as
+          your C++ compiler. Try setting the environment variable
           <literal>CXX</literal> to <literal>"gcc -O3"</literal>. For
           example:
         </para>


Modified: trunk/refman-5.1/installing-source-core.xml
===================================================================
--- trunk/refman-5.1/installing-source-core.xml	2010-12-03 16:49:14 UTC (rev 24214)
+++ trunk/refman-5.1/installing-source-core.xml	2010-12-03 16:49:22 UTC (rev 24215)
Changed blocks: 1, Lines Added: 3, Lines Deleted: 3; 996 bytes

@@ -2051,9 +2051,9 @@
           but not <literal>libg++</literal>, or
           <literal>libstdc++</literal>. Take a look at the
           <filename>config.log</filename> file. It should contain the
-          exact reason why your C++ compiler didn't work. To work around
-          these problems, you can use <command>gcc</command> as your C++
-          compiler. Try setting the environment variable
+          exact reason why your C++ compiler did not work. To work
+          around these problems, you can use <command>gcc</command> as
+          your C++ compiler. Try setting the environment variable
           <literal>CXX</literal> to <literal>"gcc -O3"</literal>. For
           example:
         </para>


Modified: trunk/refman-6.0/installing-source-core.xml
===================================================================
--- trunk/refman-6.0/installing-source-core.xml	2010-12-03 16:49:14 UTC (rev 24214)
+++ trunk/refman-6.0/installing-source-core.xml	2010-12-03 16:49:22 UTC (rev 24215)
Changed blocks: 2, Lines Added: 5, Lines Deleted: 5; 1564 bytes

@@ -459,8 +459,8 @@
 
         <para>
           If you want to configure support for <literal>InnoDB</literal>
-          tables, you should edit the <literal>/etc/my.cnf</literal>
-          file, remove the <literal>#</literal> character before the
+          tables, you should edit the <filename>/etc/my.cnf</filename>
+          file, removing the <literal>#</literal> character before the
           option lines that start with <literal>innodb_...</literal>,
           and modify the option values to be what you want. See
           <xref linkend="option-files"/>, and

@@ -2137,9 +2137,9 @@
           but not <literal>libg++</literal>, or
           <literal>libstdc++</literal>. Take a look at the
           <filename>config.log</filename> file. It should contain the
-          exact reason why your C++ compiler didn't work. To work around
-          these problems, you can use <command>gcc</command> as your C++
-          compiler. Try setting the environment variable
+          exact reason why your C++ compiler did not work. To work
+          around these problems, you can use <command>gcc</command> as
+          your C++ compiler. Try setting the environment variable
           <literal>CXX</literal> to <literal>"gcc -O3"</literal>. For
           example:
         </para>


Thread
svn commit - mysqldoc@docsrva: r24215 - in trunk: . refman-4.1 refman-5.0 refman-5.1 refman-6.0paul.dubois3 Dec