8000 [3.13] gh-132099: Fix documentation for the BTPROTO_HCI protocol (GH-132118) by serhiy-storchaka · Pull Request #132482 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

[3.13] gh-132099: Fix documentation for the BTPROTO_HCI protocol (GH-132118) #132482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 13, 2025
Merged

[3.13] gh-132099: Fix documentation for the BTPROTO_HCI protocol (GH-132118) #132482

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions Doc/library/socket.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,15 +143,21 @@
- :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.

Check warning on line 146 in Doc/library/socket.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

py:const reference target not found: BTPROTO_HCI [ref.const]

- 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

Check warning on line 160 in Doc/library/socket.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

py:const reference target not found: BTPROTO_SCO [ref.const]
:class:`bytes` object containing the Bluetooth address in a
string format. (ex. ``b'12:23:34:45:56:67'``) This protocol is not
supported under FreeBSD.
Expand Down Expand Up @@ -630,10 +636,9 @@
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

Check warning on line 639 in Doc/library/socket.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

py:const reference target not found: BTPROTO_HCI [ref.const]
available on Linux and FreeBSD. :const:`!HCI_TIME_STAMP` and
:const:`!HCI_DATA_DIR` are only available on Linux.

.. data:: AF_QIPCRTR

Expand Down
Loading
0