From: Howard Chu <hyc@openldap.org>
Date: Fri, 3 Jun 2011 18:51:11 +0000 (-0700)
Subject: ITS#6959 document ldap_dnfree()
X-Git-Tag: OPENLDAP_REL_ENG_2_5_0ALPHA~1369
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=123506788bf46698a9d2f77825e6e518a5ae0d50;p=thirdparty%2Fopenldap.git

ITS#6959 document ldap_dnfree()
---

diff --git a/doc/man/man3/ldap_get_dn.3 b/doc/man/man3/ldap_get_dn.3
index 82fd3d4660..dbf2c444e8 100644
--- a/doc/man/man3/ldap_get_dn.3
+++ b/doc/man/man3/ldap_get_dn.3
@@ -18,7 +18,10 @@ char *ldap_get_dn( LDAP *ld, LDAPMessage *entry )
 int ldap_str2dn( const char *str, LDAPDN *dn, unsigned flags )
 .LP
 .ft B
-int ldap_dn2str( LDAPDN *dn, char **str, unsigned flags )
+void ldap_dnfree( LDAPDN dn )
+.LP
+.ft B
+int ldap_dn2str( LDAPDN dn, char **str, unsigned flags )
 .LP
 .ft B
 char **ldap_explode_dn( const char *dn, int notypes )
@@ -68,7 +71,13 @@ structures, arranged in
 .B LDAPRDN,
 and 
 .B LDAPDN
-terms, defined as:
+terms.  Space for
+.B dn
+will be obtained dynamically and should be freed by the caller using
+.BR ldap_dnfree (3).
+The
+.B LDAPDN
+is defined as:
 .nf
 .ft B
 
diff --git a/doc/man/man3/ldap_get_dn.3.links b/doc/man/man3/ldap_get_dn.3.links
index 9bb38af6e8..4c71aa56da 100644
--- a/doc/man/man3/ldap_get_dn.3.links
+++ b/doc/man/man3/ldap_get_dn.3.links
@@ -2,6 +2,7 @@ ldap_explode_dn.3
 ldap_explode_rdn.3
 ldap_dn2ufn.3
 ldap_str2dn.3
+ldap_dnfree.3
 ldap_dn2str.3
 ldap_dn2dcedn.3
 ldap_dcedn2dn.3