From 6577051cccf83f2c3e1e19570ac125634a28c796 Mon Sep 17 00:00:00 2001 From: Serhiy Storchaka Date: Sun, 13 Apr 2025 18:39:22 +0300 Subject: [PATCH] [3.13] gh-132099: Fix documentation for the BTPROTO_HCI protocol (GH-132118) (cherry picked from commit 1d97488c957f4595f8c3ea42e24c1995b23e39d4) Co-authored-by: Serhiy Storchaka --- Doc/library/socket.rst | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst index e5baa3a002a01e..52b993bd81e96b 100644 --- a/Doc/library/socket.rst +++ b/Doc/library/socket.rst @@ -143,14 +143,20 @@ created. Socket addresses are represented as follows: - :const:`BTPROTO_RFCOMM` accepts ``(bdaddr, channel)`` where ``bdaddr`` is the Bluetooth address as a string and ``channel`` is an integer. - - :const:`BTPROTO_HCI` accepts ``(device_id,)`` where ``device_id`` is - either an integer or a string with the Bluetooth address of the - interface. (This depends on your OS; NetBSD and DragonFlyBSD expect - a Bluetooth address while everything else expects an integer.) + - :const:`BTPROTO_HCI` accepts a format that depends on your OS. + + - On Linux it accepts a tuple ``(device_id,)`` where ``device_id`` + is an integer specifying the number of the Bluetooth device. + - On FreeBSD, NetBSD and DragonFly BSD it accepts ``bdaddr`` where ``bdaddr`` + is a :class:`bytes` object containing the Bluetooth address in a + string format. (ex. ``b'12:23:34:45:56:67'``) .. versionchanged:: 3.2 NetBSD and DragonFlyBSD support added. + .. versionchanged:: 3.13.3 + FreeBSD support added. + - :const:`BTPROTO_SCO` accepts ``bdaddr`` where ``bdaddr`` is a :class:`bytes` object containing the Bluetooth address in a string format. (ex. ``b'12:23:34:45:56:67'``) This protocol is not @@ -630,10 +636,9 @@ Constants HCI_TIME_STAMP HCI_DATA_DIR - For use with :const:`BTPROTO_HCI`. :const:`HCI_FILTER` is not - available for NetBSD or DragonFlyBSD. :const:`HCI_TIME_STAMP` and - :const:`HCI_DATA_DIR` are not available for FreeBSD, NetBSD, or - DragonFlyBSD. + For use with :const:`BTPROTO_HCI`. :const:`!HCI_FILTER` is only + available on Linux and FreeBSD. :const:`!HCI_TIME_STAMP` and + :const:`!HCI_DATA_DIR` are only available on Linux. .. data:: AF_QIPCRTR