summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2022-09-16 08:58:34 -0400
committerGitHub <noreply@github.com>2022-09-16 07:58:34 -0500
commita52db025de436ee457084aebc6f2d9113f69250e (patch)
tree7be1caefc8b22b70d06f1e11462e805a51730ae1 /doc
parenta145fc3bc6d2e943434beb2f04bbf9b18930296f (diff)
downloadpyopenssl-a52db025de436ee457084aebc6f2d9113f69250e.tar.gz
Move away from the SSLEAY name (#1144)
Diffstat (limited to 'doc')
-rw-r--r--doc/api/ssl.rst24
1 files changed, 15 insertions, 9 deletions
diff --git a/doc/api/ssl.rst b/doc/api/ssl.rst
index e788cf1..01c9e03 100644
--- a/doc/api/ssl.rst
+++ b/doc/api/ssl.rst
@@ -98,14 +98,20 @@ Context, Connection.
:py:const:`OP_NO_*` constant may be undefined.
-.. py:data:: SSLEAY_VERSION
- SSLEAY_CFLAGS
- SSLEAY_BUILT_ON
- SSLEAY_PLATFORM
- SSLEAY_DIR
-
- Constants used with :py:meth:`SSLeay_version` to specify what OpenSSL version
- information to retrieve. See the man page for the :py:func:`SSLeay_version` C
+.. py:data:: OPENSSL_VERSION
+ OPENSSL_CFLAGS
+ OPENSSL_BUILT_ON
+ OPENSSL_PLATFORM
+ OPENSSL_DIR
+
+ .. versionchanged:: 22.1.0
+
+ Previously these were all named ``SSLEAY_*``. Those names are still
+ available for backwards compatibility, but the ``OPENSSL_*`` names are
+ preferred.
+
+ Constants used with :py:meth:`OpenSSL_version` to specify what OpenSSL version
+ information to retrieve. See the man page for the :py:func:`OpenSSL_version` C
API for details.
@@ -141,7 +147,7 @@ Context, Connection.
.. versionadded:: 19.1
-.. autofunction:: SSLeay_version
+.. autofunction:: OpenSSL_version
.. py:data:: ContextType