[docs] [issue25041] document AF_PACKET socket address format

Tim Tisdall report at bugs.python.org
Wed Sep 9 15:07:58 CEST 2015


New submission from Tim Tisdall:

As mentioned in #24984, I'm making another issue to document the address format for AF_PACKET.  In this case there's already documentation in Modules/socketmodule.c that says:

- an AF_PACKET socket address is a tuple containing a string
  specifying the ethernet interface and an integer specifying
  the Ethernet protocol number to be received. For example:
  ("eth0",0x1234).  Optional 3rd,4th,5th elements in the tuple
  specify packet-type and ha-type/addr.

But nothing has been added to Doc/library/socket.rst .

The documentation needs to be confirmed with the code.  (It probably should be altered somewhat to state how you "specify packet-type and ha-type/addr"...  and maybe what a "ha-type/addr" is...  A quick Google search found this very useful reference: https://books.google.ca/books?id=Chr1NDlUcI8C&pg=PA472&ots=OCEwyjdXJo&sig=PuNG72WIvv4-A924f9MvzPtgQDc&hl=en&sa=X&ved=0CE8Q6AEwCGoVChMI6IiTyoDqxwIVCTs-Ch3bCAXy#v=onepage&q&f=false )

----------
assignee: docs at python
components: Documentation
messages: 250306
nosy: Tim.Tisdall, docs at python
priority: normal
severity: normal
status: open
title: document AF_PACKET socket address format
type: enhancement
versions: Python 3.4, Python 3.5, Python 3.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue25041>
_______________________________________


More information about the docs mailing list