From: Kurt Zeilenga <kurt@openldap.org>
Date: Wed, 7 Jun 2006 01:45:58 +0000 (+0000)
Subject: Add a general comment regarding deprecated interfaces
X-Git-Tag: OPENLDAP_REL_ENG_2_4_3ALPHA~9^2~178
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=a4c81315a585d7f06dd6d011ad5862e074d78efb;p=openldap

Add a general comment regarding deprecated interfaces
---

diff --git a/doc/man/man3/ldap.3 b/doc/man/man3/ldap.3
index e3a64ab82c..b06a4b88bb 100644
--- a/doc/man/man3/ldap.3
+++ b/doc/man/man3/ldap.3
@@ -112,6 +112,16 @@ Also provided are various utility routines.  The
 .BR ldap_sort (3)
 routines are used to sort the entries and values returned via
 the ldap search routines. 
+.SH DEPRECATED INTERFACES
+A number of interfaces are now considered deprecated.  For instance,
+ldap_add(3) is deprecated in favor of ldap_add_ext(3).  While deprecated,
+these interfaces generally remain in the library.  The macro
+LDAP_DEPRECATED can be defined to a non-zero value
+(e.g., -DLDAP_DEPRECATED=1) when compiling program designed to use
+deprecated interaces.  It is recommended that developers writing new
+programs, or updating old programs, avoid use of deprecated interfaces.
+Over time, it is expected that documentation (and, eventually, support) for
+deprecated interfaces to be eliminated.
 .SH BER LIBRARY
 Also included in the distribution is a set of lightweight Basic
 Encoding Rules routines.  These routines are used by the LDAP library