Issue 8032 - Update man page for ldap_get_option(3)
Summary: Update man page for ldap_get_option(3)
Status: VERIFIED FIXED
Alias: None
Product: OpenLDAP
Classification: Unclassified
Component: documentation (show other issues)
Version: unspecified
Hardware: All All
: --- normal
Target Milestone: ---
Assignee: OpenLDAP project
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2015-01-21 22:46 UTC by gnoe@symas.com
Modified: 2015-07-02 17:49 UTC (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description gnoe@symas.com 2015-01-21 22:46:05 UTC
Full_Name: Greg Noe
Version: 2.4.x
OS: N/A
URL: ftp://ftp.openldap.org/incoming/
Submission from: (NULL) (63.142.209.94)


Additional language is needed for the LDAP_OPT_API_INFO option in the
ldap_get_option(3) man page.

A sentence needs to be added stating that the ldapai_info_version field must be
initialized in the LDAPAPIInfo struct before using it to call
ldap_get_option(NULL,LDAP_OPT_API_INFO,&info).

Current
------------------------------
LDAP_OPT_API_INFO
    Fills-in a LDAPAPIInfo; outvalue must be a LDAPAPIInfo *, point-
    ing to an already allocated struct. This is a read-only option.

Suggested
------------------------------
LDAP_OPT_API_INFO
    Fills-in a LDAPAPIInfo; outvalue must be a LDAPAPIInfo *, point-
    ing to an already allocated struct. The ldapai_info_version field
    must be initialized before making the call. This is a read-only
    option.
Comment 1 Howard Chu 2015-01-22 01:40:38 UTC
gnoe@symas.com wrote:
> Full_Name: Greg Noe
> Version: 2.4.x
> OS: N/A
> URL: ftp://ftp.openldap.org/incoming/
> Submission from: (NULL) (63.142.209.94)
>
>
> Additional language is needed for the LDAP_OPT_API_INFO option in the
> ldap_get_option(3) man page.

Fixed in git master.
>
> A sentence needs to be added stating that the ldapai_info_version field must be
> initialized in the LDAPAPIInfo struct before using it to call
> ldap_get_option(NULL,LDAP_OPT_API_INFO,&info).
>
> Current
> ------------------------------
> LDAP_OPT_API_INFO
>      Fills-in a LDAPAPIInfo; outvalue must be a LDAPAPIInfo *, point-
>      ing to an already allocated struct. This is a read-only option.
>
> Suggested
> ------------------------------
> LDAP_OPT_API_INFO
>      Fills-in a LDAPAPIInfo; outvalue must be a LDAPAPIInfo *, point-
>      ing to an already allocated struct. The ldapai_info_version field
>      must be initialized before making the call. This is a read-only
>      option.
>
>


-- 
   -- 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 Howard Chu 2015-01-22 01:41:24 UTC
changed notes
changed state Open to Test
moved from Incoming to Documentation
Comment 3 Quanah Gibson-Mount 2015-01-22 02:00:12 UTC
changed notes
changed state Test to Release
Comment 4 OpenLDAP project 2015-07-02 17:49:51 UTC
fixed in master
fixed in RE25
fixed in RE24
Comment 5 Quanah Gibson-Mount 2015-07-02 17:49:51 UTC
changed notes
changed state Release to Closed