Author: paul
Date: 2010-12-02 21:18:52 +0100 (Thu, 02 Dec 2010)
New Revision: 24191
Log:
r66387@frost: paul | 2010-12-02 14:17:40 -0500
General installation revisions
Modified:
trunk/dynamic-docs/build-configure/cmake.xml
trunk/refman-4.1/installing.xml
trunk/refman-5.0/installing-source-core.xml
trunk/refman-5.1/installing-source-core.xml
trunk/refman-5.5/installing-postinstall.xml
trunk/refman-5.5/installing-source-core.xml
trunk/refman-5.6/installing-postinstall.xml
trunk/refman-5.6/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:44938
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:66379
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:44938
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:66387
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-02 20:02:43 UTC (rev 24190)
+++ trunk/dynamic-docs/build-configure/cmake.xml 2010-12-02 20:18:52 UTC (rev 24191)
Changed blocks: 4, Lines Added: 10, Lines Deleted: 4; 1119 bytes
@@ -51,6 +51,10 @@
<description>Installation base directory</description>
</formatbase>
+ <values>
+ <default>/usr/local/mysql</default>
+ </values>
+
<versions>
<manual version="5.5"/>
<introduced version="5.5.7"/>
@@ -67,6 +71,10 @@
<description>Whether package build produces single file</description>
</formatbase>
+ <values>
+ <default>OFF</default>
+ </values>
+
<versions>
<manual version="5.5"/>
<introduced version="5.5.7"/>
@@ -705,8 +713,7 @@
</formatbase>
<values>
- <default>no</default>
- <choice>yes</choice>
+ <default>OFF</default>
</values>
<versions>
@@ -726,8 +733,7 @@
</formatbase>
<values>
- <default>no</default>
- <choice>yes</choice>
+ <default>OFF</default>
</values>
<versions>
Modified: trunk/refman-4.1/installing.xml
===================================================================
--- trunk/refman-4.1/installing.xml 2010-12-02 20:02:43 UTC (rev 24190)
+++ trunk/refman-4.1/installing.xml 2010-12-02 20:18:52 UTC (rev 24191)
Changed blocks: 4, Lines Added: 10, Lines Deleted: 5; 2041 bytes
@@ -6844,12 +6844,17 @@
are available from the
<ulink url="http://launchpad.net/~mysql">Oracle/MySQL
Engineering</ulink> page. For the repositories related only to
- MySQL server, see the
+ MySQL Server, see the
<ulink url="http://launchpad.net/mysql-server">MySQL
Server</ulink> page.
</para>
<para>
+ For information about using Bazaar with MySQL, see
+ <ulink url="http://forge.mysql.com/wiki/MySQL_Bazaar_Howto"/>.
+ </para>
+
+ <para>
To build under Unix/Linux, you must have the following tools
installed:
</para>
@@ -6930,8 +6935,8 @@
</para>
<para>
- Once the necessary tools are installed, you must create a local
- branch of the MySQL source code on your machine:
+ Once the necessary tools are installed, create a local branch of
+ the MySQL development tree on your machine using this procedure:
</para>
<orderedlist>
@@ -7166,7 +7171,7 @@
<listitem>
<para>
Play hard with your new installation. For example, try to
- make the new features crash. Start by running <command>make
+ make new features crash. Start by running <command>make
test</command>. See <xref linkend="mysql-test-suite"/>.
</para>
</listitem>
@@ -7232,7 +7237,7 @@
<para>
The <command>configure</command> script gives you a great deal
of control over how you configure a MySQL source distribution.
- Typically you do this using options on the
+ Typically, you do this using options on the
<command>configure</command> command line. For a full list of
options supported by <command>configure</command>, run this
command:
Modified: trunk/refman-5.0/installing-source-core.xml
===================================================================
--- trunk/refman-5.0/installing-source-core.xml 2010-12-02 20:02:43 UTC (rev 24190)
+++ trunk/refman-5.0/installing-source-core.xml 2010-12-02 20:18:52 UTC (rev 24191)
Changed blocks: 4, Lines Added: 10, Lines Deleted: 5; 1982 bytes
@@ -652,12 +652,17 @@
available from the
<ulink url="http://launchpad.net/~mysql">Oracle/MySQL
Engineering</ulink> page. For the repositories related only to
- MySQL server, see the
+ MySQL Server, see the
<ulink url="http://launchpad.net/mysql-server">MySQL
Server</ulink> page.
</para>
<para>
+ For information about using Bazaar with MySQL, see
+ <ulink url="http://forge.mysql.com/wiki/MySQL_Bazaar_Howto"/>.
+ </para>
+
+ <para>
To build under Unix/Linux, you must have the following tools
installed:
</para>
@@ -726,8 +731,8 @@
</para>
<para>
- Once the necessary tools are installed, you must create a local
- branch of the MySQL source code on your machine:
+ Once the necessary tools are installed, create a local branch of
+ the MySQL development tree on your machine using this procedure:
</para>
<orderedlist>
@@ -961,7 +966,7 @@
<listitem>
<para>
Play hard with your new installation. For example, try to make
- the new features crash. Start by running <command>make
+ new features crash. Start by running <command>make
test</command>. See <xref linkend="mysql-test-suite"/>.
</para>
</listitem>
@@ -1027,7 +1032,7 @@
<para>
The <command>configure</command> script gives you a great deal of
control over how you configure a MySQL source distribution.
- Typically you do this using options on the
+ Typically, you do this using options on the
<command>configure</command> command line. For a full list of
options supported by <command>configure</command>, run this
command:
Modified: trunk/refman-5.1/installing-source-core.xml
===================================================================
--- trunk/refman-5.1/installing-source-core.xml 2010-12-02 20:02:43 UTC (rev 24190)
+++ trunk/refman-5.1/installing-source-core.xml 2010-12-02 20:18:52 UTC (rev 24191)
Changed blocks: 4, Lines Added: 10, Lines Deleted: 5; 1980 bytes
@@ -583,12 +583,17 @@
available from the
<ulink url="http://launchpad.net/~mysql">Oracle/MySQL
Engineering</ulink> page. For the repositories related only to
- MySQL server, see the
+ MySQL Server, see the
<ulink url="http://launchpad.net/mysql-server">MySQL
Server</ulink> page.
</para>
<para>
+ For information about using Bazaar with MySQL, see
+ <ulink url="http://forge.mysql.com/wiki/MySQL_Bazaar_Howto"/>.
+ </para>
+
+ <para>
To build under Unix/Linux, you must have the following tools
installed:
</para>
@@ -657,8 +662,8 @@
</para>
<para>
- Once the necessary tools are installed, you must create a local
- branch of the MySQL source code on your machine:
+ Once the necessary tools are installed, create a local branch of
+ the MySQL development tree on your machine using this procedure:
</para>
<orderedlist>
@@ -889,7 +894,7 @@
<listitem>
<para>
Play hard with your new installation. For example, try to make
- the new features crash. Start by running <command>make
+ new features crash. Start by running <command>make
test</command>. See <xref linkend="mysql-test-suite"/>.
</para>
</listitem>
@@ -955,7 +960,7 @@
<para>
The <command>configure</command> script gives you a great deal of
control over how you configure a MySQL source distribution.
- Typically you do this using options on the
+ Typically, you do this using options on the
<command>configure</command> command line. For a full list of
options supported by <command>configure</command>, run this
command:
Modified: trunk/refman-5.5/installing-postinstall.xml
===================================================================
--- trunk/refman-5.5/installing-postinstall.xml 2010-12-02 20:02:43 UTC (rev 24190)
+++ trunk/refman-5.5/installing-postinstall.xml 2010-12-02 20:18:52 UTC (rev 24191)
Changed blocks: 2, Lines Added: 17, Lines Deleted: 0; 1476 bytes
@@ -287,6 +287,14 @@
</para>
<para>
+ If the command fails immediately and prints <literal>mysqld
+ ended</literal>, look for information in the error log (which
+ by default is the
+ <filename><replaceable>host_name</replaceable>.err</filename>
+ file in the data directory).
+ </para>
+
+ <para>
If you neglected to create the grant tables by running
<command>mysql_install_db</command> before proceeding to this
step, the following message appears in the error log file when
@@ -543,6 +551,15 @@
<xref linkend="time-zone-support"/>.
</para>
+ <para>
+ To make it more convenient to invoke programs installed in the
+ <filename>bin</filename> directory under the installation
+ directory, you can add that directory to your
+ <literal>PATH</literal> environment variable setting. That enables
+ you to run a program by typing only its name, not its entire path
+ name. See <xref linkend="setting-environment-variables"/>.
+ </para>
+
<section id="mysql-install-db-problems">
<title>Problems Running <command>mysql_install_db</command></title>
Modified: trunk/refman-5.5/installing-source-core.xml
===================================================================
--- trunk/refman-5.5/installing-source-core.xml 2010-12-02 20:02:43 UTC (rev 24190)
+++ trunk/refman-5.5/installing-source-core.xml 2010-12-02 20:18:52 UTC (rev 24191)
Changed blocks: 28, Lines Added: 122, Lines Deleted: 131; 17004 bytes
@@ -426,7 +426,8 @@
will be used to run and execute the MySQL server and own the
database directory. For details, see
<link linkend="binary-installation-createsysuser">Creating a
- <literal>mysql</literal> system user and group</link>.
+ <literal>mysql</literal> System User and Group</link>, in
+ <xref linkend="binary-installation"/>.
</para>
<bridgehead>
@@ -457,7 +458,7 @@
</para>
<programlisting>
-shell> <userinput>tar zxvf <replaceable>/path/to/mysql-VERSION</replaceable>.tar.gz</userinput>
+shell> <userinput>tar zxvf mysql-<replaceable>VERSION</replaceable>.tar.gz</userinput>
</programlisting>
<para>
@@ -468,7 +469,7 @@
</para>
<programlisting>
-shell> <userinput>gunzip < <replaceable>/path/to/mysql-VERSION</replaceable>.tar.gz | tar xvf -</userinput>
+shell> <userinput>gunzip < mysql-<replaceable>VERSION</replaceable>.tar.gz | tar xvf -</userinput>
</programlisting>
<para>
@@ -477,7 +478,7 @@
</para>
<programlisting>
-shell> <userinput>cmake -E tar zxvf <replaceable>/path/to/mysql-VERSION</replaceable>.tar.gz</userinput>
+shell> <userinput>cmake -E tar zxvf mysql-<replaceable>VERSION</replaceable>.tar.gz</userinput>
</programlisting>
</listitem>
@@ -563,33 +564,23 @@
<listitem>
<para>
<option role="cmake">-DWITH_DEBUG=1</option>: Build the
- distribution with debugging support. (After this, recompile
- and link your clients with the new client library. See
- <ulink url="http://forge.mysql.com/wiki/MySQL_Internals_Porting">MySQL
- Internals: Porting</ulink>.)
+ distribution with debugging support.
</para>
</listitem>
</itemizedlist>
<para>
- For a list of options, see
+ For a more extensive list of options, see
<xref linkend="source-configuration-options"/>.
</para>
<para>
- If <command>cmake</command> fails and you are going to send mail
- to a MySQL mailing list to ask for assistance, first check the
- files in the <filename>CMakeFiles</filename> directory for useful
- information about the failure. To file a bug report, please use
- the instructions in <xref linkend="bug-reports"/>.
+ If <command>CMake</command> fails, you may need to reconfigure by
+ running it again with different options. If you do reconfigure,
+ take note of the following:
</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>
@@ -637,6 +628,14 @@
shell> <userinput>make clean</userinput>
</programlisting>
+ <para>
+ If you are going to send mail to a MySQL mailing list to ask for
+ configuration assistance, first check the files in the
+ <filename>CMakeFiles</filename> directory for useful information
+ about the failure. To file a bug report, please use the
+ instructions in <xref linkend="bug-reports"/>.
+ </para>
+
<bridgehead>
Build the Distribution
</bridgehead>
@@ -664,8 +663,18 @@
</programlisting>
<para>
- If the compile fails, see <xref linkend="compilation-problems"/>,
- for help.
+ If you have gotten to the compilation stage, but the distribution
+ does not build, see <xref linkend="compilation-problems"/>, for
+ help. If that does not solve the problem, please enter it into our
+ bugs database using the instructions given in
+ <xref linkend="bug-reports"/>. If you have installed the latest
+ versions of the required tools, and they crash trying to process
+ our configuration files, please report that also. However, if you
+ get a <literal>command not found</literal> error or a similar
+ problem for required tools, do not report it. Instead, make sure
+ that all the required tools are installed and that your
+ <literal>PATH</literal> variable is set correctly so that your
+ shell can find them.
</para>
<bridgehead>
@@ -681,11 +690,14 @@
</programlisting>
<para>
- You might need to run this command as <literal>root</literal>.
+ This installs the files under the configured installation
+ directory (by default, <filename>/usr/local/mysql</filename>). You
+ might need to run the command as <literal>root</literal>.
</para>
<para>
- You can also generate installation package files:
+ Alternatively, generate installation package files that you can
+ install where you like:
</para>
<programlisting>
@@ -694,12 +706,12 @@
<para>
This operation produces one or more <filename>.tar.gz</filename>
- files that can be installed like binary distribution pages. See
- <xref linkend="binary-installation"/>. If <command>CMake</command>
- was run with
+ files that can be installed like generic binary distribution
+ packages. See <xref linkend="binary-installation"/>. If
+ <command>CMake</command> was run with
<option role="cmake">-DCPACK_MONOLITHIC_INSTALL=1</option>, the
- operation produces a single file. Otherwise, it might produce
- multiple files.
+ operation produces a single file. Otherwise, it produces multiple
+ files.
</para>
<para>
@@ -714,7 +726,7 @@
<para>
You can install the resulting <filename>.zip</filename> archive
- where you want. See <xref linkend="windows-install-archive"/>.
+ where you like. See <xref linkend="windows-install-archive"/>.
</para>
<bridgehead>
@@ -722,53 +734,13 @@
</bridgehead>
<para>
- The remainder of the installation process, including setting up
- the configuration file, creating the core databases, and starting
- the MySQL server, are identical to the remainder of the process as
- shown in <link linkend="binary-installation-postinstall">Generic
- Binary Install</link>.
+ The remainder of the installation process involves setting up the
+ configuration file, creating the core databases, starting the
+ MySQL server, and assigning passwords to the initial MySQL
+ accounts. For instructions, see
+ <xref linkend="post-installation"/>.
</para>
- <para>
- After everything has been installed, test the distribution. To
- start the MySQL server, use the following command:
- </para>
-
-<programlisting>
-shell> <userinput>/usr/local/mysql/bin/mysqld_safe --user=mysql &</userinput>
-</programlisting>
-
- <para>
- If you run the command as <literal>root</literal>, you should use
- the <option>--user</option> option as shown. The option value is
- the name of the login account that you created in the first step
- to use for running the server. If you run the
- <command>mysqld_safe</command> command while logged in as that
- user, you can omit the <option>--user</option> option.
- </para>
-
- <para>
- If the command fails immediately and prints <literal>mysqld
- ended</literal>, look for information in the error log (which by
- default is the
- <filename><replaceable>host_name</replaceable>.err</filename> file
- in the data directory).
- </para>
-
- <para>
- For more information about <command>mysqld_safe</command>, see
- <xref linkend="mysqld-safe"/>.
- </para>
-
- <para>
- To make it more convenient to invoke programs installed in
- <filename>/usr/local/mysql/bin</filename>, you can add that
- directory to your <literal>PATH</literal> environment variable
- setting. That enables you to run a program by typing only its
- name, not its entire path name. See
- <xref linkend="setting-environment-variables"/>.
- </para>
-
<note>
<para>
The accounts that are listed in the MySQL grant tables initially
@@ -810,26 +782,23 @@
available from the
<ulink url="http://launchpad.net/~mysql">Oracle/MySQL
Engineering</ulink> page. For the repositories related only to
- MySQL server, see the
+ MySQL Server, see the
<ulink url="http://launchpad.net/mysql-server">MySQL
Server</ulink> page.
</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 tool requirements listed at
<xref linkend="source-installation"/>, including the requirements
- for Bazaar and <command>bison</command>.
+ for Bazaar and <command>bison</command>. For information about
+ using Bazaar with MySQL, see
+ <ulink url="http://forge.mysql.com/wiki/MySQL_Bazaar_Howto"/>.
</para>
<para>
- Use Bazaar to create a local branch of the MySQL development tree
- on your machine:
+ To create a local branch of the MySQL development tree on your
+ machine, use this procedure:
</para>
<orderedlist>
@@ -938,8 +907,8 @@
<para>
After you have the local branch, you can build MySQL server from
the source code. For information, see
- <xref linkend="installing-source-distribution"/>, beginning with
- the instructions that describe how to configure the source.
+ <xref linkend="installing-source-distribution"/>, except that you
+ skip the part about obtaining and unpacking the distribution.
</para>
<para>
@@ -957,25 +926,11 @@
</para>
<para>
- Play hard with your new installation. For example, try to make the
- new features crash. Start by running <command>make test</command>.
- See <xref linkend="mysql-test-suite"/>.
+ Play hard with your new installation. For example, try to make new
+ features crash. Start by running <command>make test</command>. See
+ <xref linkend="mysql-test-suite"/>.
</para>
- <para>
- If you have gotten to the <command>make</command> stage, but the
- distribution does not compile, please enter the problem into our
- bugs database using the instructions given in
- <xref linkend="bug-reports"/>. If you have installed the latest
- versions of the required tools, and they crash trying to process
- our configuration files, please report that also. However, if you
- get a <literal>command not found</literal> error or a similar
- problem for required tools, do not report it. Instead, make sure
- that all the required tools are installed and that your
- <literal>PATH</literal> variable is set correctly so that your
- shell can find them.
- </para>
-
</section>
<section id="source-configuration-options">
@@ -1003,7 +958,7 @@
<para>
The <command>CMake</command> program gives you a great deal of
control over how you configure a MySQL source distribution.
- Typically you do this using options on the
+ Typically, you do this using options on the
<command>CMake</command> command line. For information about
options supported by <command>CMake</command>, run either of these
commands in the top-level source directory:
@@ -1024,9 +979,10 @@
The following table shows the available <command>CMake</command>
options. In the <literal>Default</literal> column,
<literal>PREFIX</literal> stands for the value of the
- <option role="cmake">CMAKE_INSTALL_PREFIX</option> option. This
- value is used as the parent location for several of the
- installation-related options.
+ <option role="cmake">CMAKE_INSTALL_PREFIX</option> option, which
+ specifies the installation base directory. This value is used as
+ the parent location for several of the installation
+ subdirectories.
</para>
<para condition="dynamic:buildopts:fullsummary" role="5.5:cmake:all">
@@ -1035,13 +991,46 @@
</para>
<para>
- The following descriptions provide more information about the
- <command>CMake</command> options. For boolean options, the value
- may be specified as 1 or <literal>ON</literal> to enable the
- option, or as 0 or <literal>OFF</literal> to disable the option.
+ The following descriptions provide more information about
+ <command>CMake</command> options.
</para>
- <bridgehead>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <link linkend="cmake-general-options">General Options</link>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <link linkend="cmake-installation-layout-options">Installation
+ Layout Options</link>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <link linkend="cmake-feature-options">Feature Options</link>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <link linkend="cmake-compiler-flags">Compiler Flags</link>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ For boolean options, the value may be specified as 1 or
+ <literal>ON</literal> to enable the option, or as 0 or
+ <literal>OFF</literal> to disable the option.
+ </para>
+
+ <bridgehead id="cmake-general-options">
General Options
</bridgehead>
@@ -1085,8 +1074,7 @@
</para>
<para>
- The type of build to produce. For MySQL, the build type can
- be:
+ The type of build to produce:
</para>
<itemizedlist>
@@ -1130,15 +1118,15 @@
</para>
<para>
- Whether the <command>make package</command> operation produces
- a single distribution file. If disabled, the operation may
- produce multiple files.
+ If enabled, the <command>make package</command> operation
+ produces a single distribution file. If disabled, the
+ operation produces multiple files.
</para>
</listitem>
</itemizedlist>
- <bridgehead>
+ <bridgehead id="cmake-installation-layout-options">
Installation Layout Options
</bridgehead>
@@ -1606,6 +1594,7 @@
-DWITH_INNOBASE_STORAGE_ENGINE=1
-DWITH_ARCHIVE_STORAGE_ENGINE=1
-DWITH_BLACKHOLE_STORAGE_ENGINE=1
+-DWITH_PERFSCHEMA_STORAGE_ENGINE=1
</programlisting>
<para>
@@ -1630,7 +1619,7 @@
module.
</para>
- <bridgehead>
+ <bridgehead id="cmake-feature-options">
Feature Options
</bridgehead>
@@ -1781,9 +1770,9 @@
</para>
<para>
- Whether to enable query profiling code
- (<literal role="stmt">SHOW PROFILE</literal>,
- <literal role="stmt">SHOW PROFILES</literal>).
+ Whether to enable query profiling code (the
+ <literal role="stmt">SHOW PROFILE</literal> and
+ <literal role="stmt">SHOW PROFILES</literal> statements).
</para>
</listitem>
@@ -1990,8 +1979,8 @@
</para>
<para>
- Whether to use the bundled <literal>readline</literal>
- library.
+ Whether to use the <literal>readline</literal> library bundled
+ with the distribution.
</para>
</listitem>
@@ -2026,13 +2015,14 @@
<listitem>
<para>
<literal>yes</literal>: Use the system SSL library if
- present, else the bundled library.
+ present, else the library bundled with the distribution.
</para>
</listitem>
<listitem>
<para>
- <literal>bundled</literal>: Use the bundled SSL library.
+ <literal>bundled</literal>: Use the SSL library bundled
+ with the distribution.
</para>
</listitem>
@@ -2068,8 +2058,9 @@
<listitem>
<para>
- <literal>bundled</literal>: Use the bundled
- <literal>zlib</literal> library.
+ <literal>bundled</literal>: Use the
+ <literal>zlib</literal> library bundled with the
+ distribution.
</para>
</listitem>
@@ -2085,7 +2076,7 @@
</itemizedlist>
- <bridgehead>
+ <bridgehead id="cmake-compiler-flags">
Compiler Flags
</bridgehead>
@@ -2147,8 +2138,8 @@
<para>
By default, authentication for connections to the embedded
- server is disabled by default. To enable authentication for
- the embedded server. define this flag.
+ server is disabled. To enable authentication for the embedded
+ server, define this flag.
</para>
</listitem>
@@ -2185,7 +2176,7 @@
<para>
The solution to many problems involves reconfiguring. If you do
- need to reconfigure, take note of the following:
+ reconfigure, take note of the following:
</para>
<indexterm>
Modified: trunk/refman-5.6/installing-postinstall.xml
===================================================================
--- trunk/refman-5.6/installing-postinstall.xml 2010-12-02 20:02:43 UTC (rev 24190)
+++ trunk/refman-5.6/installing-postinstall.xml 2010-12-02 20:18:52 UTC (rev 24191)
Changed blocks: 2, Lines Added: 17, Lines Deleted: 0; 1476 bytes
@@ -287,6 +287,14 @@
</para>
<para>
+ If the command fails immediately and prints <literal>mysqld
+ ended</literal>, look for information in the error log (which
+ by default is the
+ <filename><replaceable>host_name</replaceable>.err</filename>
+ file in the data directory).
+ </para>
+
+ <para>
If you neglected to create the grant tables by running
<command>mysql_install_db</command> before proceeding to this
step, the following message appears in the error log file when
@@ -543,6 +551,15 @@
<xref linkend="time-zone-support"/>.
</para>
+ <para>
+ To make it more convenient to invoke programs installed in the
+ <filename>bin</filename> directory under the installation
+ directory, you can add that directory to your
+ <literal>PATH</literal> environment variable setting. That enables
+ you to run a program by typing only its name, not its entire path
+ name. See <xref linkend="setting-environment-variables"/>.
+ </para>
+
<section id="mysql-install-db-problems">
<title>Problems Running <command>mysql_install_db</command></title>
Modified: trunk/refman-5.6/installing-source-core.xml
===================================================================
--- trunk/refman-5.6/installing-source-core.xml 2010-12-02 20:02:43 UTC (rev 24190)
+++ trunk/refman-5.6/installing-source-core.xml 2010-12-02 20:18:52 UTC (rev 24191)
Changed blocks: 28, Lines Added: 122, Lines Deleted: 131; 17003 bytes
@@ -413,7 +413,8 @@
will be used to run and execute the MySQL server and own the
database directory. For details, see
<link linkend="binary-installation-createsysuser">Creating a
- <literal>mysql</literal> system user and group</link>.
+ <literal>mysql</literal> System User and Group</link>, in
+ <xref linkend="binary-installation"/>.
</para>
<bridgehead>
@@ -444,7 +445,7 @@
</para>
<programlisting>
-shell> <userinput>tar zxvf <replaceable>/path/to/mysql-VERSION</replaceable>.tar.gz</userinput>
+shell> <userinput>tar zxvf mysql-<replaceable>VERSION</replaceable>.tar.gz</userinput>
</programlisting>
<para>
@@ -455,7 +456,7 @@
</para>
<programlisting>
-shell> <userinput>gunzip < <replaceable>/path/to/mysql-VERSION</replaceable>.tar.gz | tar xvf -</userinput>
+shell> <userinput>gunzip < mysql-<replaceable>VERSION</replaceable>.tar.gz | tar xvf -</userinput>
</programlisting>
<para>
@@ -464,7 +465,7 @@
</para>
<programlisting>
-shell> <userinput>cmake -E tar zxvf <replaceable>/path/to/mysql-VERSION</replaceable>.tar.gz</userinput>
+shell> <userinput>cmake -E tar zxvf mysql-<replaceable>VERSION</replaceable>.tar.gz</userinput>
</programlisting>
</listitem>
@@ -550,33 +551,23 @@
<listitem>
<para>
<option role="cmake">-DWITH_DEBUG=1</option>: Build the
- distribution with debugging support. (After this, recompile
- and link your clients with the new client library. See
- <ulink url="http://forge.mysql.com/wiki/MySQL_Internals_Porting">MySQL
- Internals: Porting</ulink>.)
+ distribution with debugging support.
</para>
</listitem>
</itemizedlist>
<para>
- For a list of options, see
+ For a more extensive list of options, see
<xref linkend="source-configuration-options"/>.
</para>
<para>
- If <command>cmake</command> fails and you are going to send mail
- to a MySQL mailing list to ask for assistance, first check the
- files in the <filename>CMakeFiles</filename> directory for useful
- information about the failure. To file a bug report, please use
- the instructions in <xref linkend="bug-reports"/>.
+ If <command>CMake</command> fails, you may need to reconfigure by
+ running it again with different options. If you do reconfigure,
+ take note of the following:
</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>
@@ -624,6 +615,14 @@
shell> <userinput>make clean</userinput>
</programlisting>
+ <para>
+ If you are going to send mail to a MySQL mailing list to ask for
+ configuration assistance, first check the files in the
+ <filename>CMakeFiles</filename> directory for useful information
+ about the failure. To file a bug report, please use the
+ instructions in <xref linkend="bug-reports"/>.
+ </para>
+
<bridgehead>
Build the Distribution
</bridgehead>
@@ -651,8 +650,18 @@
</programlisting>
<para>
- If the compile fails, see <xref linkend="compilation-problems"/>,
- for help.
+ If you have gotten to the compilation stage, but the distribution
+ does not build, see <xref linkend="compilation-problems"/>, for
+ help. If that does not solve the problem, please enter it into our
+ bugs database using the instructions given in
+ <xref linkend="bug-reports"/>. If you have installed the latest
+ versions of the required tools, and they crash trying to process
+ our configuration files, please report that also. However, if you
+ get a <literal>command not found</literal> error or a similar
+ problem for required tools, do not report it. Instead, make sure
+ that all the required tools are installed and that your
+ <literal>PATH</literal> variable is set correctly so that your
+ shell can find them.
</para>
<bridgehead>
@@ -668,11 +677,14 @@
</programlisting>
<para>
- You might need to run this command as <literal>root</literal>.
+ This installs the files under the configured installation
+ directory (by default, <filename>/usr/local/mysql</filename>). You
+ might need to run the command as <literal>root</literal>.
</para>
<para>
- You can also generate installation package files:
+ Alternatively, generate installation package files that you can
+ install where you like:
</para>
<programlisting>
@@ -681,12 +693,12 @@
<para>
This operation produces one or more <filename>.tar.gz</filename>
- files that can be installed like binary distribution pages. See
- <xref linkend="binary-installation"/>. If <command>CMake</command>
- was run with
+ files that can be installed like generic binary distribution
+ packages. See <xref linkend="binary-installation"/>. If
+ <command>CMake</command> was run with
<option role="cmake">-DCPACK_MONOLITHIC_INSTALL=1</option>, the
- operation produces a single file. Otherwise, it might produce
- multiple files.
+ operation produces a single file. Otherwise, it produces multiple
+ files.
</para>
<para>
@@ -701,7 +713,7 @@
<para>
You can install the resulting <filename>.zip</filename> archive
- where you want. See <xref linkend="windows-install-archive"/>.
+ where you like. See <xref linkend="windows-install-archive"/>.
</para>
<bridgehead>
@@ -709,53 +721,13 @@
</bridgehead>
<para>
- The remainder of the installation process, including setting up
- the configuration file, creating the core databases, and starting
- the MySQL server, are identical to the remainder of the process as
- shown in <link linkend="binary-installation-postinstall">Generic
- Binary Install</link>.
+ The remainder of the installation process involves setting up the
+ configuration file, creating the core databases, starting the
+ MySQL server, and assigning passwords to the initial MySQL
+ accounts. For instructions, see
+ <xref linkend="post-installation"/>.
</para>
- <para>
- After everything has been installed, test the distribution. To
- start the MySQL server, use the following command:
- </para>
-
-<programlisting>
-shell> <userinput>/usr/local/mysql/bin/mysqld_safe --user=mysql &</userinput>
-</programlisting>
-
- <para>
- If you run the command as <literal>root</literal>, you should use
- the <option>--user</option> option as shown. The option value is
- the name of the login account that you created in the first step
- to use for running the server. If you run the
- <command>mysqld_safe</command> command while logged in as that
- user, you can omit the <option>--user</option> option.
- </para>
-
- <para>
- If the command fails immediately and prints <literal>mysqld
- ended</literal>, look for information in the error log (which by
- default is the
- <filename><replaceable>host_name</replaceable>.err</filename> file
- in the data directory).
- </para>
-
- <para>
- For more information about <command>mysqld_safe</command>, see
- <xref linkend="mysqld-safe"/>.
- </para>
-
- <para>
- To make it more convenient to invoke programs installed in
- <filename>/usr/local/mysql/bin</filename>, you can add that
- directory to your <literal>PATH</literal> environment variable
- setting. That enables you to run a program by typing only its
- name, not its entire path name. See
- <xref linkend="setting-environment-variables"/>.
- </para>
-
<note>
<para>
The accounts that are listed in the MySQL grant tables initially
@@ -797,26 +769,23 @@
available from the
<ulink url="http://launchpad.net/~mysql">Oracle/MySQL
Engineering</ulink> page. For the repositories related only to
- MySQL server, see the
+ MySQL Server, see the
<ulink url="http://launchpad.net/mysql-server">MySQL
Server</ulink> page.
</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 tool requirements listed at
<xref linkend="source-installation"/>, including the requirements
- for Bazaar and <command>bison</command>.
+ for Bazaar and <command>bison</command>. For information about
+ using Bazaar with MySQL, see
+ <ulink url="http://forge.mysql.com/wiki/MySQL_Bazaar_Howto"/>.
</para>
<para>
- Use Bazaar to create a local branch of the MySQL development tree
- on your machine:
+ To create a local branch of the MySQL development tree on your
+ machine, use this procedure:
</para>
<orderedlist>
@@ -925,8 +894,8 @@
<para>
After you have the local branch, you can build MySQL server from
the source code. For information, see
- <xref linkend="installing-source-distribution"/>, beginning with
- the instructions that describe how to configure the source.
+ <xref linkend="installing-source-distribution"/>, except that you
+ skip the part about obtaining and unpacking the distribution.
</para>
<para>
@@ -944,25 +913,11 @@
</para>
<para>
- Play hard with your new installation. For example, try to make the
- new features crash. Start by running <command>make test</command>.
- See <xref linkend="mysql-test-suite"/>.
+ Play hard with your new installation. For example, try to make new
+ features crash. Start by running <command>make test</command>. See
+ <xref linkend="mysql-test-suite"/>.
</para>
- <para>
- If you have gotten to the <command>make</command> stage, but the
- distribution does not compile, please enter the problem into our
- bugs database using the instructions given in
- <xref linkend="bug-reports"/>. If you have installed the latest
- versions of the required tools, and they crash trying to process
- our configuration files, please report that also. However, if you
- get a <literal>command not found</literal> error or a similar
- problem for required tools, do not report it. Instead, make sure
- that all the required tools are installed and that your
- <literal>PATH</literal> variable is set correctly so that your
- shell can find them.
- </para>
-
</section>
<section id="source-configuration-options">
@@ -990,7 +945,7 @@
<para>
The <command>CMake</command> program gives you a great deal of
control over how you configure a MySQL source distribution.
- Typically you do this using options on the
+ Typically, you do this using options on the
<command>CMake</command> command line. For information about
options supported by <command>CMake</command>, run either of these
commands in the top-level source directory:
@@ -1011,9 +966,10 @@
The following table shows the available <command>CMake</command>
options. In the <literal>Default</literal> column,
<literal>PREFIX</literal> stands for the value of the
- <option role="cmake">CMAKE_INSTALL_PREFIX</option> option. This
- value is used as the parent location for several of the
- installation-related options.
+ <option role="cmake">CMAKE_INSTALL_PREFIX</option> option, which
+ specifies the installation base directory. This value is used as
+ the parent location for several of the installation
+ subdirectories.
</para>
<para condition="dynamic:buildopts:fullsummary" role="5.6:cmake:all">
@@ -1022,13 +978,46 @@
</para>
<para>
- The following descriptions provide more information about the
- <command>CMake</command> options. For boolean options, the value
- may be specified as 1 or <literal>ON</literal> to enable the
- option, or as 0 or <literal>OFF</literal> to disable the option.
+ The following descriptions provide more information about
+ <command>CMake</command> options.
</para>
- <bridgehead>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <link linkend="cmake-general-options">General Options</link>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <link linkend="cmake-installation-layout-options">Installation
+ Layout Options</link>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <link linkend="cmake-feature-options">Feature Options</link>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <link linkend="cmake-compiler-flags">Compiler Flags</link>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ For boolean options, the value may be specified as 1 or
+ <literal>ON</literal> to enable the option, or as 0 or
+ <literal>OFF</literal> to disable the option.
+ </para>
+
+ <bridgehead id="cmake-general-options">
General Options
</bridgehead>
@@ -1072,8 +1061,7 @@
</para>
<para>
- The type of build to produce. For MySQL, the build type can
- be:
+ The type of build to produce:
</para>
<itemizedlist>
@@ -1117,15 +1105,15 @@
</para>
<para>
- Whether the <command>make package</command> operation produces
- a single distribution file. If disabled, the operation may
- produce multiple files.
+ If enabled, the <command>make package</command> operation
+ produces a single distribution file. If disabled, the
+ operation produces multiple files.
</para>
</listitem>
</itemizedlist>
- <bridgehead>
+ <bridgehead id="cmake-installation-layout-options">
Installation Layout Options
</bridgehead>
@@ -1593,6 +1581,7 @@
-DWITH_INNOBASE_STORAGE_ENGINE=1
-DWITH_ARCHIVE_STORAGE_ENGINE=1
-DWITH_BLACKHOLE_STORAGE_ENGINE=1
+-DWITH_PERFSCHEMA_STORAGE_ENGINE=1
</programlisting>
<para>
@@ -1617,7 +1606,7 @@
module.
</para>
- <bridgehead>
+ <bridgehead id="cmake-feature-options">
Feature Options
</bridgehead>
@@ -1768,9 +1757,9 @@
</para>
<para>
- Whether to enable query profiling code
- (<literal role="stmt">SHOW PROFILE</literal>,
- <literal role="stmt">SHOW PROFILES</literal>).
+ Whether to enable query profiling code (the
+ <literal role="stmt">SHOW PROFILE</literal> and
+ <literal role="stmt">SHOW PROFILES</literal> statements).
</para>
</listitem>
@@ -1977,8 +1966,8 @@
</para>
<para>
- Whether to use the bundled <literal>readline</literal>
- library.
+ Whether to use the <literal>readline</literal> library bundled
+ with the distribution.
</para>
</listitem>
@@ -2013,13 +2002,14 @@
<listitem>
<para>
<literal>yes</literal>: Use the system SSL library if
- present, else the bundled library.
+ present, else the library bundled with the distribution.
</para>
</listitem>
<listitem>
<para>
- <literal>bundled</literal>: Use the bundled SSL library.
+ <literal>bundled</literal>: Use the SSL library bundled
+ with the distribution.
</para>
</listitem>
@@ -2055,8 +2045,9 @@
<listitem>
<para>
- <literal>bundled</literal>: Use the bundled
- <literal>zlib</literal> library.
+ <literal>bundled</literal>: Use the
+ <literal>zlib</literal> library bundled with the
+ distribution.
</para>
</listitem>
@@ -2072,7 +2063,7 @@
</itemizedlist>
- <bridgehead>
+ <bridgehead id="cmake-compiler-flags">
Compiler Flags
</bridgehead>
@@ -2134,8 +2125,8 @@
<para>
By default, authentication for connections to the embedded
- server is disabled by default. To enable authentication for
- the embedded server. define this flag.
+ server is disabled. To enable authentication for the embedded
+ server, define this flag.
</para>
</listitem>
@@ -2172,7 +2163,7 @@
<para>
The solution to many problems involves reconfiguring. If you do
- need to reconfigure, take note of the following:
+ reconfigure, take note of the following:
</para>
<indexterm>
Modified: trunk/refman-6.0/installing-source-core.xml
===================================================================
--- trunk/refman-6.0/installing-source-core.xml 2010-12-02 20:02:43 UTC (rev 24190)
+++ trunk/refman-6.0/installing-source-core.xml 2010-12-02 20:18:52 UTC (rev 24191)
Changed blocks: 4, Lines Added: 10, Lines Deleted: 5; 1982 bytes
@@ -689,12 +689,17 @@
available from the
<ulink url="http://launchpad.net/~mysql">Oracle/MySQL
Engineering</ulink> page. For the repositories related only to
- MySQL server, see the
+ MySQL Server, see the
<ulink url="http://launchpad.net/mysql-server">MySQL
Server</ulink> page.
</para>
<para>
+ For information about using Bazaar with MySQL, see
+ <ulink url="http://forge.mysql.com/wiki/MySQL_Bazaar_Howto"/>.
+ </para>
+
+ <para>
To build under Unix/Linux, you must have the following tools
installed:
</para>
@@ -763,8 +768,8 @@
</para>
<para>
- Once the necessary tools are installed, you must create a local
- branch of the MySQL source code on your machine:
+ Once the necessary tools are installed, create a local branch of
+ the MySQL development tree on your machine using this procedure:
</para>
<orderedlist>
@@ -976,7 +981,7 @@
<listitem>
<para>
Play hard with your new installation. For example, try to make
- the new features crash. Start by running <command>make
+ new features crash. Start by running <command>make
test</command>. See <xref linkend="mysql-test-suite"/>.
</para>
</listitem>
@@ -1042,7 +1047,7 @@
<para>
The <command>configure</command> script gives you a great deal of
control over how you configure a MySQL source distribution.
- Typically you do this using options on the
+ Typically, you do this using options on the
<command>configure</command> command line. For a full list of
options supported by <command>configure</command>, run this
command:
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r24191 - in trunk: . dynamic-docs/build-configure refman-4.1 refman-5.0 refman-5.1 refman-5.5 refman-5.6 refman-6.0 | paul.dubois | 2 Dec |
