Skip to content

Commit a17b893

Browse files
committed
Explcitly mention LibreSSL and BoringSSL in documentation
Fixes pycurl#530
1 parent d13a48a commit a17b893

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

INSTALL.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ To fix this, you need to tell ``setup.py`` what SSL backend is used::
5656
python setup.py --with-[openssl|gnutls|nss|mbedtls] install
5757

5858
Note: as of PycURL 7.21.5, setup.py accepts ``--with-openssl`` option to
59-
indicate that libcurl is built against OpenSSL. ``--with-ssl`` is an alias
59+
indicate that libcurl is built against OpenSSL/LibreSSL/BoringSSL.
60+
``--with-ssl`` is an alias
6061
for ``--with-openssl`` and continues to be accepted for backwards compatibility.
6162

6263
You can also ask ``setup.py`` to obtain SSL backend information from installed
@@ -216,8 +217,8 @@ Additional Windows setup.py options:
216217
import library. The default is ``libcurl.lib`` which is appropriate for
217218
static linking and is sometimes the correct choice for dynamic linking as
218219
well. The other possibility for dynamic linking is ``libcurl_imp.lib``.
219-
- ``--with-openssl``: use OpenSSL crypto locks when libcurl was built against
220-
OpenSSL.
220+
- ``--with-openssl``: use OpenSSL/LibreSSL/BoringSSL crypto locks when libcurl
221+
was built against these SSL backends.
221222
- ``--with-ssl``: legacy alias for ``--with-openssl``.
222223
- ``--openssl-lib-name=""``: specify a different name for OpenSSL import
223224
library containing CRYPTO_num_locks. For OpenSSL 1.1.0+ this should be set

doc/thread-safety.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ For Python programs using PycURL, this means:
2121
Python code *outside of a libcurl callback for the PycURL object in question*
2222
is unsafe.
2323

24-
PycURL handles the necessary SSL locks for OpenSSL/LibreSSL, GnuTLS, NSS and mbedTLS.
24+
PycURL handles the necessary SSL locks for OpenSSL/LibreSSL/BoringSSL,
25+
GnuTLS, NSS and mbedTLS.
2526

2627
A special situation exists when libcurl uses the standard C library
2728
name resolver (i.e., not threaded nor c-ares resolver). By default libcurl

setup.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -896,8 +896,8 @@ def gen_docstrings_sources():
896896
PycURL Unix options:
897897
--curl-config=/path/to/curl-config use specified curl-config binary
898898
--libcurl-dll=[/path/to/]libcurl.so obtain SSL library from libcurl.so
899-
--openssl-dir=/path/to/openssl/dir path to OpenSSL headers and libraries
900-
--with-openssl libcurl is linked against OpenSSL
899+
--openssl-dir=/path/to/openssl/dir path to OpenSSL/LibreSSL/BoringSSL headers and libraries
900+
--with-openssl libcurl is linked against OpenSSL/LibreSSL/BoringSSL
901901
--with-ssl legacy alias for --with-openssl
902902
--with-gnutls libcurl is linked against GnuTLS
903903
--with-nss libcurl is linked against NSS
@@ -910,7 +910,7 @@ def gen_docstrings_sources():
910910
--use-libcurl-dll link against libcurl DLL, if not given
911911
link against libcurl statically
912912
--libcurl-lib-name=libcurl_imp.lib override libcurl import library name
913-
--with-openssl libcurl is linked against OpenSSL
913+
--with-openssl libcurl is linked against OpenSSL/LibreSSL/BoringSSL
914914
--with-ssl legacy alias for --with-openssl
915915
--link-arg=foo.lib also link against specified library
916916
'''

0 commit comments

Comments
 (0)