From ee720641f2c1ef9e4f3ce0be42a8c08963e8bfc3 Mon Sep 17 00:00:00 2001
From: Quanah Gibson-Mount <quanah@openldap.org>
Date: Fri, 17 Dec 2010 18:13:09 +0000
Subject: [PATCH] ITS#6601

---
 CHANGES                        |  1 +
 doc/man/man3/ldap_open.3       | 14 +++++++++++++-
 doc/man/man3/ldap_open.3.links |  2 ++
 3 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/CHANGES b/CHANGES
index 78aefe037c..50f70c3d34 100644
--- a/CHANGES
+++ b/CHANGES
@@ -31,6 +31,7 @@ OpenLDAP 2.4.24 Engineering
 	Fixed contrib/nssov to only close socket on shutdown (ITS#6676)
 	Documentation
 		admin24 guide typo fixes (ITS#6609)
+		ldap_open(3) document ldap_set_urllist_proc (ITS#6601)
 
 OpenLDAP 2.4.23 Release (2010/06/30)
 	Fixed libldap to return server's error code (ITS#6569)
diff --git a/doc/man/man3/ldap_open.3 b/doc/man/man3/ldap_open.3
index f01487470d..24bdae6d3e 100644
--- a/doc/man/man3/ldap_open.3
+++ b/doc/man/man3/ldap_open.3
@@ -171,7 +171,19 @@ The function may manipulate the URI list; the typical use consists
 in moving the successful URI to the head of the list,
 so that subsequent attempts to connect to one of the URIs using the same LDAP handle
 will try it first.
-By default, this function is not defined.
+If
+.I ld
+is null,
+.I proc
+is set as a global parameter that is inherited by all handlers
+within the process that are created after the call to
+.BR ldap_set_urllist_proc() .
+By default, no 
+.I LDAP_URLLIST_PROC
+is set.
+In a multithreaded environment,
+.B ldap_set_urllist_proc()
+must be called before any concurrent operation using the LDAP handle is started.
 
 Note: the first call into the LDAP library also initializes the global
 options for the library. As such the first call should be single-threaded
diff --git a/doc/man/man3/ldap_open.3.links b/doc/man/man3/ldap_open.3.links
index d2f912c0b2..aa34ab7617 100644
--- a/doc/man/man3/ldap_open.3.links
+++ b/doc/man/man3/ldap_open.3.links
@@ -1,2 +1,4 @@
 ldap_init.3
 ldap_initialize.3
+ldap_set_urllist_proc.3
+ldap_init_fd.3
-- 
GitLab