Issue 8818 - SASL_MECH is wrongly documented as user option
Summary: SASL_MECH is wrongly documented as user option
Status: VERIFIED FIXED
Alias: None
Product: OpenLDAP
Classification: Unclassified
Component: documentation (show other issues)
Version: 2.4.45
Hardware: All All
: --- normal
Target Milestone: ---
Assignee: OpenLDAP project
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-03-13 11:50 UTC by cheimes@redhat.com
Modified: 2018-03-22 19:27 UTC (History)
0 users

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this issue.
Description cheimes@redhat.com 2018-03-13 11:50:06 UTC 
Full_Name: Christian Heimes
Version: 2.4.45
OS: Fedora
URL: ftp://ftp.openldap.org/incoming/
Submission from: (NULL) (2001:16b8:601e:1c00:18cd:bce4:2531:fe3)


SASL_MECH is documented as "This is a user-only option" in man ldap.conf,
https://www.openldap.org/software/man.cgi?query=ldap.conf . User-only options
are documented as "Such options are ignored if present in the ldap.conf".
Contrary to the documentation, libldap loads SASL_MECH from global ldap.conf. We
discussed the issue in
https://github.com/freeipa/freeipa/pull/1470#issuecomment-372602434 

Is this a documentation bug or an implementation bug?
Comment 1 Howard Chu 2018-03-13 17:49:46 UTC 
cheimes@redhat.com wrote:
> Full_Name: Christian Heimes
> Version: 2.4.45
> OS: Fedora
> URL: ftp://ftp.openldap.org/incoming/
> Submission from: (NULL) (2001:16b8:601e:1c00:18cd:bce4:2531:fe3)
> 
> 
> SASL_MECH is documented as "This is a user-only option" in man ldap.conf,
> https://www.openldap.org/software/man.cgi?query=ldap.conf . User-only options
> are documented as "Such options are ignored if present in the ldap.conf".
> Contrary to the documentation, libldap loads SASL_MECH from global ldap.conf. We
> discussed the issue in
> https://github.com/freeipa/freeipa/pull/1470#issuecomment-372602434
> 
> Is this a documentation bug or an implementation bug?

It appears the doc is stale. The user-only attribute was removed from 
SASL_MECH in ITS#4327 (commit 86d10729) and apparently the docs weren't 
updated then.

-- 
   -- Howard Chu
   CTO, Symas Corp.           http://www.symas.com
   Director, Highland Sun     http://highlandsun.com/hyc/
   Chief Architect, OpenLDAP  http://www.openldap.org/project/
Comment 2 cheimes@redhat.com 2018-03-14 08:38:25 UTC 
On 2018-03-13 18:49, Howard Chu wrote:
> It appears the doc is stale. The user-only attribute was removed from
> SASL_MECH in ITS#4327 (commit 86d10729) and apparently the docs weren't
> updated then.

Thanks for your confirmation and fixing the documentation in f183b81a!
Comment 3 Howard Chu 2018-03-21 16:17:07 UTC 
changed notes
changed state Open to Test
moved from Incoming to Documentation
Comment 4 Quanah Gibson-Mount 2018-03-22 15:40:15 UTC 
changed notes
changed state Test to Release
Comment 5 OpenLDAP project 2018-03-22 19:27:22 UTC 
fixed in master
fixed in RE24 (2.4.46)
Comment 6 Quanah Gibson-Mount 2018-03-22 19:27:22 UTC 
changed notes
changed state Release to Closed