summaryrefslogtreecommitdiffstats
path: root/Doc/library/socket.rst
diff options
context:
space:
mode:
authorChristian Heimes <christian@python.org>2022-08-01 12:26:19 (GMT)
committerGitHub <noreply@github.com>2022-08-01 12:26:19 (GMT)
commit9af9ea28e756a8a1961b065856c697fc1262ca82 (patch)
tree17bbbd0df659a5a54b94ad06da0e92d84064db9e /Doc/library/socket.rst
parentad2872f5fd4fb145685007eaa03d90ae4505af69 (diff)
downloadcpython-9af9ea28e756a8a1961b065856c697fc1262ca82.zip
cpython-9af9ea28e756a8a1961b065856c697fc1262ca82.tar.gz
cpython-9af9ea28e756a8a1961b065856c697fc1262ca82.tar.bz2
[3.11] gh-95415: Make availability directive consistent (GH-95416) (GH-95438)
Co-authored-by: Christian Heimes <christian@python.org>
Diffstat (limited to 'Doc/library/socket.rst')
-rw-r--r--Doc/library/socket.rst44
1 files changed, 32 insertions, 12 deletions
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index f77279c..f35df36 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -165,7 +165,9 @@ created. Socket addresses are represented as follows:
- *feat* and *mask* are unsigned 32bit integers.
- .. availability:: Linux 2.6.38, some algorithm types require more recent Kernels.
+ .. availability:: Linux >= 2.6.38.
+
+ Some algorithm types require more recent Kernels.
.. versionadded:: 3.6
@@ -173,7 +175,9 @@ created. Socket addresses are represented as follows:
their hosts. The sockets are represented as a ``(CID, port)`` tuple
where the context ID or CID and port are integers.
- .. availability:: Linux >= 4.8 QEMU >= 2.8 ESX >= 4.0 ESX Workstation >= 6.5.
+ .. availability:: Linux >= 3.9
+
+ See :manpage:`vsock(7)`
.. versionadded:: 3.7
@@ -221,7 +225,7 @@ created. Socket addresses are represented as follows:
``socket(AF_INET, SOCK_DGRAM, IPPROTO_UDPLITE)`` for IPv4 or
``socket(AF_INET6, SOCK_DGRAM, IPPROTO_UDPLITE)`` for IPv6.
- .. availability:: Linux >= 2.6.20, FreeBSD >= 10.1-RELEASE
+ .. availability:: Linux >= 2.6.20, FreeBSD >= 10.1
.. versionadded:: 3.9
@@ -1033,7 +1037,7 @@ The :mod:`socket` module also offers various network-related services:
both the value of *address_family* and the underlying implementation of
:c:func:`inet_pton`.
- .. availability:: Unix (maybe not all platforms), Windows.
+ .. availability:: Unix, Windows.
.. versionchanged:: 3.4
Windows support added
@@ -1053,7 +1057,7 @@ The :mod:`socket` module also offers various network-related services:
length for the specified address family, :exc:`ValueError` will be raised.
:exc:`OSError` is raised for errors from the call to :func:`inet_ntop`.
- .. availability:: Unix (maybe not all platforms), Windows.
+ .. availability:: Unix, Windows.
.. versionchanged:: 3.4
Windows support added
@@ -1079,7 +1083,9 @@ The :mod:`socket` module also offers various network-related services:
buffer. Raises :exc:`OverflowError` if *length* is outside the
permissible range of values.
- .. availability:: most Unix platforms, possibly others.
+ .. availability:: Unix.
+
+ Most Unix platforms.
.. versionadded:: 3.3
@@ -1100,7 +1106,9 @@ The :mod:`socket` module also offers various network-related services:
amount of ancillary data that can be received, since additional
data may be able to fit into the padding area.
- .. availability:: most Unix platforms, possibly others.
+ .. availability:: Unix.
+
+ most Unix platforms.
.. versionadded:: 3.3
@@ -1199,7 +1207,10 @@ The :mod:`socket` module also offers various network-related services:
The *fds* parameter is a sequence of file descriptors.
Consult :meth:`sendmsg` for the documentation of these parameters.
- .. availability:: Unix supporting :meth:`~socket.sendmsg` and :const:`SCM_RIGHTS` mechanism.
+ .. availability:: Unix.
+
+ Unix platforms supporting :meth:`~socket.sendmsg`
+ and :const:`SCM_RIGHTS` mechanism.
.. versionadded:: 3.9
@@ -1210,7 +1221,10 @@ The :mod:`socket` module also offers various network-related services:
Return ``(msg, list(fds), flags, addr)``.
Consult :meth:`recvmsg` for the documentation of these parameters.
- .. availability:: Unix supporting :meth:`~socket.recvmsg` and :const:`SCM_RIGHTS` mechanism.
+ .. availability:: Unix.
+
+ Unix platforms supporting :meth:`~socket.sendmsg`
+ and :const:`SCM_RIGHTS` mechanism.
.. versionadded:: 3.9
@@ -1545,7 +1559,9 @@ to sockets.
fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
return msg, list(fds)
- .. availability:: most Unix platforms, possibly others.
+ .. availability:: Unix.
+
+ Most Unix platforms.
.. versionadded:: 3.3
@@ -1587,7 +1603,9 @@ to sockets.
>>> [b1, b2, b3]
[bytearray(b'Mary'), bytearray(b'01 had a 9'), bytearray(b'little lamb---')]
- .. availability:: most Unix platforms, possibly others.
+ .. availability:: Unix.
+
+ Most Unix platforms.
.. versionadded:: 3.3
@@ -1693,7 +1711,9 @@ to sockets.
def send_fds(sock, msg, fds):
return sock.sendmsg([msg], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, array.array("i", fds))])
- .. availability:: most Unix platforms, possibly others.
+ .. availability:: Unix.
+
+ Most Unix platforms.
.. audit-event:: socket.sendmsg self,address socket.socket.sendmsg