Skip to content

Commit bb4bc33

Browse files
committed
Mention macOS issue in doc
1 parent ffb4a60 commit bb4bc33

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

Doc/reference/ldap.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ This module defines the following functions:
4949
and explicitly closed after the :class:`~ldap.ldapobject.LDAPObject` is
5050
unbound. The internal connection type is determined from the URI, ``TCP``
5151
for ``ldap://`` / ``ldaps://``, ``IPC`` (``AF_UNIX``) for ``ldapi://``.
52+
The is not available on macOS when python-ldap is compiled with system
53+
libldap, see :py:const:`INIT_FD_AVAIL`.
5254

5355
Note that internally the OpenLDAP function
5456
`ldap_initialize(3) <https://www.openldap.org/software/man.cgi?query=ldap_init&sektion=3>`_
@@ -135,6 +137,12 @@ General
135137
Integer where a non-zero value indicates that python-ldap was built with
136138
support for SSL/TLS (OpenSSL or similar libs).
137139

140+
.. py:data:: INIT_FD_AVAIL
141+
142+
Integer where a non-zero value indicates that python-ldap supports
143+
:py:func:`initialize` from a file descriptor. The feature is generally
144+
available except on macOS when python-ldap is compiled with system libldap.
145+
138146

139147
.. _ldap-options:
140148

0 commit comments

Comments
 (0)