From 1aab177fecf6784769cf7f44e8e8d3f7ca908d44 Mon Sep 17 00:00:00 2001
From: Stefan Strigler <stefan.strigler@erlang-solutions.com>
Date: Thu, 2 Jul 2015 14:07:31 +0200
Subject: add doc for odbc port_timeout

---
 lib/odbc/doc/src/odbc.xml | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'lib/odbc')

diff --git a/lib/odbc/doc/src/odbc.xml b/lib/odbc/doc/src/odbc.xml
index 01bc0cb7ff..6a2a3587e4 100644
--- a/lib/odbc/doc/src/odbc.xml
+++ b/lib/odbc/doc/src/odbc.xml
@@ -221,6 +221,18 @@
 					  and their meanings are dependent on the database being used.</item>
 				  <item><c>Reason</c> is as per the <c>Reason</c> field when extended errors are not enabled.</item>
 		  </list>
+
+        <note>
+            <p>The current implementation spawns a port programm
+            written in C that utilizes the actual ODBC driver. There
+            is a default timeout of 5000 msec for this port programm
+            to connect to the Erlang ODBC application. This timeout
+            can be changed by setting an application specific
+            environment variable 'port_timeout' with the number of
+            milliseconds for the ODBC application. E.g.: [{odbc,
+            [{port_timeout, 60000}]}] to set it to 60 seconds.
+            </p>
+        </note>
       </desc>
     </func>
     <func>
-- 
cgit v1.2.3