]> git.sur5r.net Git - openldap/commitdiff
Note perlModuleConfig, break in compatibility with older versions
authorHoward Chu <hyc@openldap.org>
Fri, 4 Feb 2011 15:10:06 +0000 (15:10 +0000)
committerHoward Chu <hyc@openldap.org>
Fri, 4 Feb 2011 15:10:06 +0000 (15:10 +0000)
doc/man/man5/slapd-perl.5

index 3f8b4a816e67c00b264987e534f77cd956c5793e..2f2b99853c550d6cb07e6c8dde38cd49fafefd85 100644 (file)
@@ -29,7 +29,7 @@ following actions:
   * add        # adds an entry to backend,
   * modrdn     # modifies an entry's rdn,
   * delete     # deletes an ldap entry,
-  * config     # process unknown config file lines,
+  * config     # module-specific config directives,
   * init       # called after backend is initialized.
 .fi
 .LP
@@ -120,9 +120,9 @@ Its arguments are as follows.
 .LP
 .TP
 .B config
-This method is called with unknown
+This method is called once for each perlModuleConfig line in the
 .BR slapd.conf (5)
-configuration file lines.
+configuration file.
 Its arguments are as follows.
 .nf
   * object reference
@@ -159,6 +159,9 @@ Add the path to the @INC variable.
 Search results are candidates that need to be filtered (with the
 filter in the search request), rather than search results to be
 returned directly to the client.
+.TP
+.B perlModuleConfig <arguments>
+Invoke the module's config method with the given arguments.
 .SH EXAMPLE
 There is an example Perl module `SampleLDAP' in the slapd/back\-perl/
 directory in the OpenLDAP source tree.
@@ -179,6 +182,11 @@ operation is honored, which is performed by the frontend.
 .SH WARNING
 The interface of this backend to the perl module MAY change.
 Any suggestions would greatly be appreciated.
+
+Note: in previous versions, any unrecognized lines in the slapd.conf
+file were passed to the perl module's config method. Now,
+unrecognized lines are rejected as errors, and the perlModuleConfig
+directive must be used to invoke the module's config method.
 .SH FILES
 .TP
 ETCDIR/slapd.conf