https://github.com/python/cpython/commit/1d97488c957f4595f8c3ea42e24c1995b23e39d4
commit: 1d97488c957f4595f8c3ea42e24c1995b23e39d4
branch: main
author: Serhiy Storchaka <storch...@gmail.com>
committer: serhiy-storchaka <storch...@gmail.com>
date: 2025-04-13T18:39:22+03:00
summary:
gh-132099: Fix documentation for the BTPROTO_HCI protocol (GH-132118)
files:
M Doc/library/socket.rst
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 970698c5f644a2..2e38101c01d89d 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -149,19 +149,25 @@ created. Socket addresses are represented as follows:
:const:`BDADDR_LE_RANDOM`.
.. versionchanged:: 3.14
- Added ``cid`` and ``bdaddr_type`` fields.
+ Added ``cid`` and ``bdaddr_type`` fields.
- :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'``)
@@ -662,16 +668,15 @@ Constants
These constants describe the Bluetooth address type when binding or
connecting a :const:`BTPROTO_L2CAP` socket.
- .. versionadded:: 3.14
+ .. versionadded:: 3.14
.. data:: HCI_FILTER
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
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
