Merge r896897 from trunk:

clarify LDAPConnectionTimeout behavior/availability which is really just
passed along to the SDK when applicable.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.2.x@896956 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/docs/manual/mod/mod_ldap.html.en b/docs/manual/mod/mod_ldap.html.en
index 79523c30b735ad8b0797ad8f045a2549a36dcfd7..1de839489cdb76ec8e4e07e3fbcbac1262ac2c57 100644 (file)
--- a/docs/manual/mod/mod_ldap.html.en
+++ b/docs/manual/mod/mod_ldap.html.en
@@ -441,11 +441,24 @@ by other LDAP modules</td></tr>
 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
 </table>
-    <p>Specifies the timeout value (in seconds) in which the module will
-    attempt to connect to the LDAP server.  If a connection is not
-    successful with the timeout period, either an error will be 
-    returned or the module will attempt to connect to a secondary LDAP 
-    server if one is specified. The default is 10 seconds.</p>
+    <p>This directive configures the LDAP_OPT_NETWORK_TIMEOUT option in the
+    underlying LDAP client library, when available.  This value typically 
+    controls how long the LDAP client library will wait for various network 
+    calls to complete, including establishing a connection to the target LDAP 
+    server.</p>
+
+    <p> If a connection is not successful with the timeout period, either an error will be 
+    returned or the LDAP client library will attempt to connect to a secondary LDAP 
+    server if one is specified (via a space-separated list of hostnames in the 
+    <code class="directive"><a href="#authldapurl">AuthLDAPURL</a></code>).</p>
+
+    <p>The default is 10 seconds, if the LDAP client library linked with the 
+    server supports the LDAP_OPT_NETWORK_TIMEOUT option.</p>
+
+    <div class="note">LDAPConnectionTimeout is only available when the LDAP client library linked
+    with the server supports the LDAP_OPT_NETWORK_TIMEOUT option, and the
+    ultimate behavior is dictated entirely by the LDAP client library.
+    </div>
 
 </div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>

diff --git a/docs/manual/mod/mod_ldap.xml b/docs/manual/mod/mod_ldap.xml
index 02655c6b5d9b4e61b02277598f47ff9c7a7d9841..ced4f26c3434cd4d707ab3895b5dd0df92157e38 100644 (file)
--- a/docs/manual/mod/mod_ldap.xml
+++ b/docs/manual/mod/mod_ldap.xml
@@ -566,11 +566,24 @@ connection client certificates.</description>
 <contextlist><context>server config</context></contextlist>
 
 <usage>
-    <p>Specifies the timeout value (in seconds) in which the module will
-    attempt to connect to the LDAP server.  If a connection is not
-    successful with the timeout period, either an error will be 
-    returned or the module will attempt to connect to a secondary LDAP 
-    server if one is specified. The default is 10 seconds.</p>
+    <p>This directive configures the LDAP_OPT_NETWORK_TIMEOUT option in the
+    underlying LDAP client library, when available.  This value typically 
+    controls how long the LDAP client library will wait for various network 
+    calls to complete, including establishing a connection to the target LDAP 
+    server.</p>
+
+    <p> If a connection is not successful with the timeout period, either an error will be 
+    returned or the LDAP client library will attempt to connect to a secondary LDAP 
+    server if one is specified (via a space-separated list of hostnames in the 
+    <directive module="mod_ldap">AuthLDAPURL</directive>).</p>
+
+    <p>The default is 10 seconds, if the LDAP client library linked with the 
+    server supports the LDAP_OPT_NETWORK_TIMEOUT option.</p>
+
+    <note>LDAPConnectionTimeout is only available when the LDAP client library linked
+    with the server supports the LDAP_OPT_NETWORK_TIMEOUT option, and the
+    ultimate behavior is dictated entirely by the LDAP client library.
+    </note>
 </usage>
 </directivesynopsis>