From: Gregory P. Smith <greg@krypto.org>
Date: Mon, 27 Nov 2023 23:54:21 +0000 (-0800)
Subject: [3.11] Backport PR #112477: correct socket AF_PACKET docs (#112478)
X-Git-Tag: v3.11.7~32
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=03b522d3ef8cfc2735134b486bb2581237907b57;p=thirdparty%2FPython%2Fcpython.git

[3.11] Backport PR #112477: correct socket AF_PACKET docs (#112478)

Backport PR #112477: correct socket AF_PACKET docs

Network byte order is not involved in the `int` on the Python side.
That happens under the hood.

Correctly use the term addresses instead of packets.
---

diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 9cfa0c4f25e2..b9f47ae2e6d3 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -185,12 +185,11 @@ created.  Socket addresses are represented as follows:
   .. versionadded:: 3.7
 
 - :const:`AF_PACKET` is a low-level interface directly to network devices.
-  The packets are represented by the tuple
+  The addresses are represented by the tuple
   ``(ifname, proto[, pkttype[, hatype[, addr]]])`` where:
 
   - *ifname* - String specifying the device name.
-  - *proto* - An in network-byte-order integer specifying the Ethernet
-    protocol number.
+  - *proto* - An integer specifying the Ethernet protocol number.
   - *pkttype* - Optional integer specifying the packet type:
 
     - ``PACKET_HOST`` (the default) - Packet addressed to the local host.