bk commit into 5.1 tree (jon:1.2530)

[Jon Stephens]

Below is the list of changes that have just been committed into a local
5.1 repository of jon. When jon does a push these changes will
be propagated to the main repository and, within 24 hours after the
push, to the public repository.
For information on how to access the public repository
see http://dev.mysql.com/doc/mysql/en/installing-source-tree.html

ChangeSet@stripped, 2007-06-20 11:17:59+02:00, jon@stripped +1 -0
  Additional help text edits.

  BUILD/build_source.sh@stripped, 2007-06-20 11:17:55+02:00, jon@stripped +38 -25
    Additional help text edits.

# This is a BitKeeper patch.  What follows are the unified diffs for the
# set of deltas contained in the patch.  The rest of the patch, the part
# that BitKeeper cares about, is below these diffs.
# User:	jon
# Host:	biollante.mysql.com
# Root:	/home/jon/bk/wl3834

--- 1.22/BUILD/build_source.sh	2007-06-19 23:24:29 +02:00
+++ 1.23/BUILD/build_source.sh	2007-06-20 11:17:55 +02:00
@@ -204,7 +204,7 @@
     Do not include specific NDB debug code, not even in debug versions
     (cannot be overridden).
 
-  Package specific options:
+  Package-specific options:
   -------------------------
   --with-innodb
     Specifically included in the "pro" and "max" packages, and not in
@@ -304,40 +304,53 @@
 {
   cat <<EOF
 
-  To get extended help on the various with options one should run this script
-  with --just-configure to create a configure file. Then issue the command
-  ./configure --help and you'll get an extensive list of configure options
-  available.
+  To obtain extended help on the --with-* options available, run this
+  script with --just-configure to create a configuration file. Then
+  issue the command ./configure --help to get an extensive list of
+  possible configure options.
 
-  The remainder of this text only focuses on those which are useful to build a
-  MySQL Cluster Carrier Grade Edition.
+  The remainder of this text focuses on those options which are useful
+  in building binaries for MySQL Cluster Carrier Grade Edition.
 
   --with-ndb-sci=/opt/DIS
-    Used to build a MySQL Cluster Carrier Grade Edition that can use the SCI
-    Transporter. Before compiling the Dolphin SCI installation should have been
-    completed.
+    Used to build a MySQL Cluster Carrier Grade Edition that can use the
+    SCI Transporter. The Dolphin SCI installation should be completed
+    first ().
+
   --with-ndb-test
-    Compile also the MySQL Cluster test programs.
+    Compile the MySQL Cluster test programs.
+
   --with-ndb-docs
-    Also include MySQL Cluster documentation of NDB API and the NDB Management API.
+    Also include MySQL Cluster documentation of NDB API and the NDB
+    Management API (MGM API). (This version is not actively maintained
+    and may be out of date. See http://dev.mysql.com/doc/ndbapi/en/ for
+    the latest version.)
+
   --with-ndb-port=PORT
-    Change default port for MySQL Cluster management server
+    Change the default port for the MySQL Cluster management server.
+
   --with-ndb-port-base=PORT
-    Change default port base for MySQL Cluster data nodes.
+    Change the default port base for MySQL Cluster data nodes.
+
   --without-query-cache
-    Remove Query Cache from MySQL Server. The Query Cache is often not of any
-    additional value in MySQL Cluster applications.
+    Build the MySQL Server without the query cache, which is often not
+    of value in MySQL Cluster applications.
+
   --with-atomic-ops=rwlocks|smp|up
-                          Implement atomic operations using pthread rwlocks or
-                          atomic CPU instructions for multi-processor
-                          (default) or uniprocessor configuration
-  --without-geometry      Do not build geometry-related parts. Very seldomly used
-                          in MySQL Cluster applications.
+                          Implement atomic operations using pthread
+                          rwlocks or atomic CPU instructions for
+                          multi-processor (default) or single-processor
+                          configurations.
+
+  --without-geometry      Do not build geometry-related portions of the
+                          MySQL Server. Seldom used in MySQL Cluster
+                          applications.
+
   --with-ndb-cc-flags=FLAGS
-    This option can be used to build MySQL Cluster with error injection in the
-    data nodes. It can be used to pass special options to programs in the NDB
-    kernel for special test builds.
-    The option to enable error injection in data nodes is -DERROR_INSERT
+    This option can be used to build MySQL Cluster with error injection
+    on the data nodes. It can be used to pass special options to
+    programs in the NDB kernel for special test builds.
+    The option for enabling data node error injection is -DERROR_INSERT.
 EOF
 }