]> git.sur5r.net Git - openldap/commitdiff
Add a general comment regarding deprecated interfaces
authorKurt Zeilenga <kurt@openldap.org>
Wed, 7 Jun 2006 01:45:58 +0000 (01:45 +0000)
committerKurt Zeilenga <kurt@openldap.org>
Wed, 7 Jun 2006 01:45:58 +0000 (01:45 +0000)
doc/man/man3/ldap.3

index e3a64ab82ce61a68ac3396bb90cd5c57b692ac26..b06a4b88bb3da208b2d782f1a68c5e3fe0221e58 100644 (file)
@@ -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