Skip to content

Commit 7c60b75

Browse files
committed
improve availability wording
1 parent c1ae0f6 commit 7c60b75

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

Doc/library/intro.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,8 @@ Notes on availability
6565
*Availability: Linux >= 3.17 with glibc >= 2.27* requires both Linux 3.17 or
6666
newer and glibc 2.27 or newer.
6767

68-
* "Availability" notes may also be used to indicate requirements on how Python
69-
was built. For instance, "Availability: OpenSSL >= 3.5" note means that the
70-
feature is available if Python has been built with OpenSSL 3.5 or later,
71-
while "Availability: not AWS-LC" note means that the feature is not available
72-
if Python has been built with AWS-LC instead of OpenSSL.
68+
* A particular library dependency with an optional minimal ``major.minor``
69+
version constraint is indicated by *Availability: library >= major.minor*.
7370

7471

7572
.. _wasm-availability:

Doc/library/ssl.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,15 @@ probably additional platforms, as long as OpenSSL is installed on that platform.
2828
cause variations in behavior. For example, TLSv1.3 comes with OpenSSL version
2929
1.1.1.
3030

31+
.. note::
32+
33+
Support for other implementations of ``libssl`` such as AWS-LC, BoringSSL,
34+
or LibreSSL, may be assumed but not guaranteed. When a feature is known to
35+
be unavailable for a sepcific backend, it will be explicitly mentioned in
36+
an :ref:`Availability <availability>` note as *Availability: not <backend>*.
37+
3138
.. warning::
39+
3240
Don't use this module without reading the :ref:`ssl-security`. Doing so
3341
may lead to a false sense of security, as the default settings of the
3442
ssl module are not necessarily appropriate for your application.

0 commit comments

Comments
 (0)