Author: jstephens
Date: 2007-12-10 19:25:21 +0100 (Mon, 10 Dec 2007)
New Revision: 9233
Log:
Remaining updates for CGE build script doc (temp file).
Modified:
trunk/refman-5.1/mysql-cluster-cge-building-tmp.xml
Modified: trunk/refman-5.1/mysql-cluster-cge-building-tmp.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-cge-building-tmp.xml 2007-12-10 18:17:27 UTC (rev 9232)
+++ trunk/refman-5.1/mysql-cluster-cge-building-tmp.xml 2007-12-10 18:25:21 UTC (rev 9233)
Changed blocks: 15, Lines Added: 63, Lines Deleted: 71; 13931 bytes
@@ -109,7 +109,9 @@
<xref linkend="mysql-cluster-cge"/>) or MySQL's FTP site (see
<xref linkend="mysql-cluster-cge-releases"/> for download
locations). For best results, you should unpack the downloaded
- archive using GNU <command>tar</command>.
+ archive using GNU <command>tar</command>, since there are known
+ issues with the <command>tar</command> provided with some
+ operating system distributions (such as Solaris).
</para>
<para>
@@ -145,9 +147,22 @@
<listitem>
<formalpara>
- <title>Classic</title>
+ <title>CGE (<option>--package=cge</option>)</title>
<para>
+ This package includes all MySQL storage engines with the
+ exception of <literal>InnoDB</literal>.
+ </para>
+
+ </formalpara>
+ </listitem>
+
+ <listitem>
+ <formalpara>
+
+ <title>Classic (<option>--package=classic</option>)</title>
+
+ <para>
This package includes only the <literal>MyISAM</literal>
and <literal>CSV</literal> storage engines.
</para>
@@ -158,11 +173,11 @@
<listitem>
<formalpara>
- <title>Pro</title>
+ <title>Pro (<option>--package=pro</option>)</title>
<para>
- This packages includes all storage engines and other
- features except for MySQL Cluster.
+ This package includes all MySQL storage engines and other
+ features with the exception of MySQL Cluster.
</para>
</formalpara>
@@ -171,13 +186,13 @@
<listitem>
<formalpara>
- <title>Extended</title>
+ <title>Extended (<option>--package=extended</option>)</title>
<para>
- This package includes all of the features found in the Pro
- package with the addition of MySQL Cluster. This is the
- default package when the <option>--developer</option>
- option is used.
+ This package includes all of the features found in the
+ <emphasis>Pro</emphasis> package with the addition of
+ MySQL Cluster. This is the default package when the
+ <option>--developer</option> option is used.
</para>
</formalpara>
@@ -385,12 +400,12 @@
<option>--datadir</option> is used, in which case it
defaults to
<filename><replaceable>datadir</replaceable>/data</filename></entry>
- <entry>Y (by setting <option>--localstatedir</option> explicitly).</entry>
+ <entry>Y (by setting <option>--localstatedir</option> explicitly)</entry>
</row>
<row>
<entry><option>--disable-shared</option></entry>
<entry>Do not build shared libraries.</entry>
- <entry>Y (use <option>--enable-shared</option>)</entry>
+ <entry>N</entry>
</row>
<row>
<entry><option>--enable-local-infile</option></entry>
@@ -459,8 +474,8 @@
<title><command>configure</command> options specific to Linux</title>
<para>
- There are two configure options that are specific to Linux
- operating systems:
+ There are two <command>configure</command> options that are
+ specific to Linux operating systems:
<itemizedlist>
@@ -510,7 +525,7 @@
<title><option>--with-ndbcluster</option></title>
<para>
- Include the <literal>NDB Cluster</literal> storage engine,
+ Include the <literal>NDBCLUSTER</literal> storage engine,
its kernel, management server, and client, as well as
support for the <literal>NDB</literal> and
<literal>MGM</literal> APIs.
@@ -526,7 +541,7 @@
<para>
Do not include debug code specific to
- <literal>NDB</literal>, even in debug versions.
+ <literal>NDBCLUSTER</literal>, even in debug versions.
</para>
</formalpara>
@@ -593,8 +608,6 @@
</formalpara>
-<!-- EDITS THORUGH HERE -->
-
<formalpara>
<title>Other options</title>
@@ -673,8 +686,8 @@
<title><command>build_mccge.sh</command> Options for Building &mccge-series;</title>
<para>
- The following table provides information on those options which
- are most likely to be useful when building &mccge-series;
+ The following table provides information on additional options
+ which are likely to be useful when building &mccge-series;
binaries.
</para>
@@ -756,7 +769,8 @@
</para>
<para>
- Use of the --debug option adds -g to the C/C++ flags.
+ Use of the <option>--debug</option> option adds
+ <option>-g</option> to the C/C++ flags.
</para>
<formalpara>
@@ -764,17 +778,17 @@
<title>Linux/x86 using <command>gcc</command></title>
<para>
- No default compiler flags are used. Instead the configure script
- determines the proper flags to use for both normal and debug
- builds. Discovery of a Nocona or Core 2 Duo CPU causes a 64-bit
- binary to be built; otherwise, the binary is 32-bit. To build a
- 64-bit binary, <option>-m64</option> is added to the C/C++
- flags.
+ No default compiler flags are used. Instead the
+ <command>configure</command> script determines the proper flags
+ to use for both normal and debug builds. Discovery of a Nocona
+ or Core 2 Duo CPU causes a 64-bit binary to be built; otherwise,
+ the binary is 32-bit. To build a 64-bit binary,
+ <option>-m64</option> is added to the C/C++ flags.
<note>
<para>
To build a 32-bit binary on a 64-bit CPU, use the
- <option>--m32</option> option as described in
+ <option>--32</option> option as described in
<xref linkend="mysql-cluster-cge-building-options-quick"/>.
</para>
</note>
@@ -845,8 +859,8 @@
<para>
On this platform, <command>cc-5.0</command> is used as
<command>CC</command>, and sets
- <option>ASFLAGS=LDFLAGS=xarch=v9</option>, so that Sparc v9
- binaries are compiled using the following flags:
+ <option>ASFLAGS=LDFLAGS=xarch=v9</option>, so that SPARC version
+ 9 binaries are compiled using the following flags:
<itemizedlist>
@@ -888,7 +902,7 @@
</itemizedlist>
- As on Solaris/x86, Solaris/Sparc builds set
+ As on Solaris/x86, Solaris/SPARC builds set
<option>LIBS=-lmtmalloc</option>.
</para>
@@ -937,160 +951,138 @@
</para>
<informaltable>
- <tgroup cols="3">
- <colspec colwidth="45*"/>
- <colspec colwidth="15*"/>
+ <tgroup cols="2">
<colspec colwidth="40*"/>
+ <colspec colwidth="60*"/>
<thead>
<row>
- <entry>Long Form</entry>
- <entry>Short Form</entry>
+ <entry>Option</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><option>--commercial</option></entry>
- <entry>[none]</entry>
<entry>Use commercial libraries</entry>
</row>
<row>
<entry><option>--compiler=[gcc|icc|forte]</option></entry>
- <entry>[none]</entry>
<entry>Select compiler</entry>
</row>
<row>
<entry><option>--configure-only</option></entry>
- <entry><option>-c</option></entry>
<entry>Stop after running <command>configure</command>.</entry>
</row>
<row>
<entry><option>--datadir=<replaceable>path</replaceable></option></entry>
- <entry>[none]</entry>
<entry>Build with data directory set to non-standard
<replaceable>path</replaceable></entry>
</row>
<row>
<entry><option>--debug</option></entry>
- <entry>[none]</entry>
<entry>Build normal version but add debug information to binary</entry>
</row>
<row>
<entry><option>--developer</option></entry>
- <entry>[none]</entry>
<entry>Use extensions that most developers of MySQL use</entry>
</row>
<row>
- <entry><option>--enable-shared</option></entry>
- <entry>[none]</entry>
- <entry>Use <literal>enable-shared</literal> flag in
- <command>configure</command></entry>
+ <entry><option>--developer-help</option></entry>
+ <entry>Display help message for developers of MySQL</entry>
</row>
<row>
<entry><option>--error-inject</option></entry>
- <entry>[none]</entry>
<entry>Enable error injection into MySQL Server and data nodes</entry>
</row>
<row>
<entry><option>--extended-help</option></entry>
- <entry>[none]</entry>
- <entry>Show extended help message</entry>
+ <entry>Display extended help message</entry>
</row>
<row>
<entry><option>--fast</option></entry>
- <entry>[none]</entry>
<entry>Optimize for current CPU architecture</entry>
</row>
<row>
<entry><option>--help</option></entry>
- <entry><option>-h</option></entry>
<entry>Show help message containing information similar to what is in this
table.</entry>
</row>
<row>
<entry><option>--gpl</option></entry>
- <entry>[none]</entry>
<entry>Use GPL libraries</entry>
</row>
<row>
- <entry><option>--m32</option></entry>
- <entry>[none]</entry>
+ <entry><option>--32</option></entry>
<entry>Build a 32-bit binary even if the CPU is 64-bit</entry>
</row>
<row>
- <entry><option>--no-zlib-bundled</option></entry>
- <entry>[none]</entry>
- <entry>Do not use the <literal>zlib</literal> version bundled in MySQL</entry>
+ <entry><option>--64</option></entry>
+ <entry>Build a 64-bit binary even if the CPU is not 64-bit</entry>
</row>
<row>
- <entry><option>--package=[ndb|max|pro|classic]</option></entry>
- <entry>[none]</entry>
+ <entry><option>--package=[cge|extended|pro|classic]</option></entry>
<entry>Select package to build</entry>
</row>
<row>
<entry><option>--parallelism=<replaceable>number</replaceable></option></entry>
- <entry>[none]</entry>
<entry>Define parallelism in <command>make</command></entry>
</row>
<row>
<entry><option>--prefix=<replaceable>path</replaceable></option></entry>
- <entry>[none]</entry>
<entry>Build with prefix <replaceable>path</replaceable></entry>
</row>
<row>
<entry><option>--print-only</option></entry>
- <entry>[none]</entry>
<entry>Print commands that the script would execute, but do not actually
execute them.</entry>
</row>
<row>
<entry><option>--static-linking</option></entry>
- <entry>[none]</entry>
<entry>Statically link system libraries into binaries</entry>
</row>
<row>
<entry><option>--strip</option></entry>
- <entry>[none]</entry>
<entry>Strip binaries</entry>
</row>
<row>
+ <entry><option>--sysadmin-help</option></entry>
+ <entry>Display help message for system administrators</entry>
+ </row>
+ <row>
<entry><option>--valgrind</option></entry>
- <entry>[none]</entry>
<entry>Build with <command>valgrind</command></entry>
</row>
<row>
<entry><option>--warning-mode=[extra|pedantic|normal|no]</option></entry>
- <entry>[none]</entry>
<entry>Set warning mode level</entry>
</row>
<row>
<entry><option>--warnings</option></entry>
- <entry>[none]</entry>
<entry>Set warning mode to normal</entry>
</row>
<row>
<entry><option>--with-debug</option></entry>
- <entry>[none]</entry>
<entry>Build debug version</entry>
</row>
<row>
<entry><option>--with-debug=full</option></entry>
- <entry>[none]</entry>
<entry>Build with full debug</entry>
</row>
<row>
<entry><option>--with-flags <replaceable>options</replaceable></option></entry>
- <entry>[none]</entry>
<entry>Pass extra <option>--with-<replaceable>xxx</replaceable></option> to
<command>configure</command></entry>
</row>
<row>
<entry><option>--with-help</option></entry>
- <entry>[none]</entry>
<entry>Show extended help on
<option>--with-<replaceable>xxx</replaceable></option>
options for <command>configure</command></entry>
</row>
+ <row>
+ <entry><option>--without-debug</option></entry>
+ <entry>Build non-debug version</entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r9233 - trunk/refman-5.1 | jon | 10 Dec |
