From: Ondřej Kuzník <ondra@mistotebe.net>
Date: Tue, 17 May 2022 09:52:48 +0000 (+0100)
Subject: ITS#9824 Document SASL related ldap_get/set_option restrictions
X-Git-Tag: OPENLDAP_REL_ENG_2_5_13~36
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=124ac7eaa402eb0c1009e6482ee43b73ed468594;p=thirdparty%2Fopenldap.git

ITS#9824 Document SASL related ldap_get/set_option restrictions
---

diff --git a/doc/man/man3/ldap_get_option.3 b/doc/man/man3/ldap_get_option.3
index 3477f02c61..b98ad6026c 100644
--- a/doc/man/man3/ldap_get_option.3
+++ b/doc/man/man3/ldap_get_option.3
@@ -463,7 +463,7 @@ must be an
 .BR "unsigned int *" .
 
 .SH SASL OPTIONS
-The SASL options are OpenLDAP specific.
+The SASL options are OpenLDAP specific and unless otherwise noted, require an LDAP handle to be passed.
 .TP
 .B LDAP_OPT_X_SASL_AUTHCID
 Gets the SASL authentication identity;
@@ -507,7 +507,7 @@ in form of a NULL-terminated array of strings;
 .BR outvalue
 must be
 .BR "char ***" .
-The caller must not free or otherwise muck with it.
+The caller must not free or otherwise muck with it. This option can be used globally.
 .TP
 .B LDAP_OPT_X_SASL_NOCANON
 Sets/gets the NOCANON flag.