From 97925f5513054f95893d46dea0cf1f602317dcfc Mon Sep 17 00:00:00 2001
From: Kalle Sommer Nielsen <kalle@php.net>
Date: Wed, 20 Oct 2010 08:15:25 +0000
Subject: [PATCH] Fixed bug #52440 (Add note for mysql/mysqli/pdo_mysql when
 using mysqlnd) Documented PDO_MYSQL ini entries  * pdo_mysql.default_socket 
 * pdo_mysql.debug

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@304545 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/pdo_mysql/ini.xml       | 85 +++++++++++++++++++++++++++++++
 reference/pdo_mysql/reference.xml | 16 ++++++
 2 files changed, 101 insertions(+)
 create mode 100644 reference/pdo_mysql/ini.xml

diff --git a/reference/pdo_mysql/ini.xml b/reference/pdo_mysql/ini.xml
new file mode 100644
index 0000000000..cd31e46967
--- /dev/null
+++ b/reference/pdo_mysql/ini.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<section xml:id="pdo-mysql.configuration" xmlns="http://docbook.org/ns/docbook">
+ &reftitle.runtime;
+ &extension.runtime;
+ <para>
+  <table>
+   <title>PDO_MYSQL Configuration Options</title>
+   <tgroup cols="4">
+    <thead>
+     <row>
+      <entry>Name</entry>
+      <entry>Default</entry>
+      <entry>Changeable</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry><link linkend="ini.pdo-mysql.default-socket">pdo_mysql.default_socket</link></entry>
+      <entry>"/tmp/mysql.sock"</entry>
+      <entry>PHP_INI_SYSTEM</entry>
+     </row>
+     <row>
+      <entry><link linkend="ini.pdo-mysql.debug">pdo_mysql.debug</link></entry>
+      <entry>NULL</entry>
+      <entry>PHP_INI_SYSTEM</entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </table>
+  &ini.php.constants;
+ </para>
+
+ &ini.descriptions.title;
+
+ <para>
+  <variablelist>
+   <varlistentry xml:id="ini.pdo-mysql.default-socket">
+    <term>
+     <parameter>pdo_mysql.default_socket</parameter>
+     <type>string</type>
+    </term>
+    <listitem>
+     <para>
+      Sets a Unix domain socket. This value can either be set at compile time if 
+      a domain socket is found at configure. This ini setting is Unix only.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry xml:id="ini.pdo-mysql.debug">
+    <term>
+     <parameter>pdo_mysql.debug</parameter>
+     <type>boolean</type>
+    </term>
+    <listitem>
+     <para>
+      Enables debugging for PDO_MYSQL. This setting is only available when PDO_MYSQL is 
+      compiled against mysqlnd and in PDO debug mode.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </para>
+</section>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/pdo_mysql/reference.xml b/reference/pdo_mysql/reference.xml
index bf1d465803..b55b04b45a 100644
--- a/reference/pdo_mysql/reference.xml
+++ b/reference/pdo_mysql/reference.xml
@@ -31,6 +31,7 @@
     </warning>
    </section>
    &reference.pdo-mysql.constants;
+   &reference.pdo-mysql.configuration;
   </partintro>
 
   <refentry xml:id="ref.pdo-mysql.connection">
@@ -96,6 +97,7 @@
      </variablelist>
     </para>
    </refsect1>
+
    <refsect1 role="examples">
     &reftitle.examples;
     <para>
@@ -122,6 +124,20 @@ mysql:unix_socket=/tmp/mysql.sock;dbname=testdb
    </refsect1>
   </refentry>
 
+   <refsect1 role="notes">
+    &reftitle.notes;
+    <note>
+     <title>Unix only:</title>
+     <para>
+      When PDO_MYSQL is compiled against mysqlnd, usage of <literal>localhost</literal> 
+      as host name tells MySQL to use a Unix domain socket, requiring a default socket to 
+      be set in the DSN string or in &php.ini; using the <link linkend="ini.pdo-mysql.default-socket">
+      pdo_mysql.default_socket</link> setting.
+     </para>
+    </note>
+   </refsect1>
+  </refentry>
+
  </reference>
 <!-- Keep this comment at the end of the file
 Local variables: