svn commit - mysqldoc@docsrva: r12734 - trunk/refman-common

[anthony.bedford]

Author: tbedford
Date: 2008-12-02 12:09:33 +0100 (Tue, 02 Dec 2008)
New Revision: 12734

Log:
Added more information regarding MYSQL_DIR.

Modified:
   trunk/refman-common/connector-cpp.xml


Modified: trunk/refman-common/connector-cpp.xml
===================================================================
--- trunk/refman-common/connector-cpp.xml	2008-12-02 04:00:15 UTC (rev 12733)
+++ trunk/refman-common/connector-cpp.xml	2008-12-02 11:09:33 UTC (rev 12734)
Changed blocks: 1, Lines Added: 11, Lines Deleted: 3; 1288 bytes

@@ -496,9 +496,17 @@
       </programlisting>
 
         <para>
-          If CMake cannot find <filename>mysql_config</filename> you
-          almost certainly have not got the MySQL client development
-          libraries and headers installed.
+          On non-Windows systems, CMake first checks to see if the CMake
+          variable <literal>MYSQL_CONFIG_EXECUTABLE</literal> is set. If
+          it is not found CMake will try to locate
+          <filename>mysql_config</filename> in the default locations. On
+          Windows, <literal>mysql_config</literal> is not present, so
+          CMake will attempt to retrieve the location of MySQL from the
+          environment variable <literal>$ENV{MYSQL_DIR}</literal>. If
+          <literal>MYSQL_DIR</literal> is not set, CMake will then
+          proceed to check for MySQL in the following locations:
+          <literal>$ENV{ProgramFiles}/MySQL/*/include</literal>, and
+          <literal>$ENV{SystemDrive}/MySQL/*/include</literal>.
         </para>
 
         <para>