MySQL options parameter fix and documentation

[clsql.git] / doc / ref-connect.xml

diff --git a/doc/ref-connect.xml b/doc/ref-connect.xml
index d9c992e62837ec41c69a1966e6d8b2a265b0f197..a30aaf13e0a78e69c7765499a27087fbbfc5d267 100644 (file)
--- a/doc/ref-connect.xml
+++ b/doc/ref-connect.xml
@@ -379,8 +379,14 @@
         <varlistentry>
           <term><parameter>connection-spec</parameter></term>
           <listitem>
-            <para>A vendor specific connection specification supplied
-            as a list or as a string.</para>
+            <para>A SQL backend specific connection specification
+            supplied as a list or as a string.</para>
+            <para>For the MySQL backend, this list includes an
+            optional associative list of connection options. The
+            options list is parsed and supplied to the MySQL API
+            using <function>mysql_options</function> in between the
+            calls to <function>mysql_init</function>
+            and <function>mysql_real_connect</function>.</para>
           </listitem>
         </varlistentry>
         <varlistentry>