From a97346bbbcd583ae4a27725171461f96d691aec7 Mon Sep 17 00:00:00 2001 From: Jarry Shaw Date: Sat, 31 Oct 2026 16:38:54 -0400 Subject: [PATCH] docs(vendor): add documentation page for Linux ARPHRD crawler - Add docs/source/pcapkit/vendor/linux.rst documenting the ARPHRD vendor crawler for Linux ARP hardware types from - Index the new page under Link Layer in the vendor crawlers documentation - Include a note explaining that this crawler does not scrape a live registry but maintains hand-curated DATA mapping from the Linux kernel header Closes #2498 --- docs/source/pcapkit/vendor/index.rst | 1 + docs/source/pcapkit/vendor/linux.rst | 39 ++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 docs/source/pcapkit/vendor/linux.rst diff --git a/docs/source/pcapkit/vendor/index.rst b/docs/source/pcapkit/vendor/index.rst index af878e121c..d1818b4cdd 100644 --- a/docs/source/pcapkit/vendor/index.rst +++ b/docs/source/pcapkit/vendor/index.rst @@ -45,6 +45,7 @@ Link Layer arp l2tp + linux vlan Internet Layer diff --git a/docs/source/pcapkit/vendor/linux.rst b/docs/source/pcapkit/vendor/linux.rst new file mode 100644 index 0000000000..0b827971c3 --- /dev/null +++ b/docs/source/pcapkit/vendor/linux.rst @@ -0,0 +1,39 @@ +=================================================================== +Linux-Specific Vendor Crawlers +=================================================================== + +.. module:: pcapkit.vendor.linux + +This module contains all vendor crawlers of the Linux-specific +encapsulations, e.g. :class:`~pcapkit.protocols.link.linux_sll.LinuxSLL`. +Available vendor crawlers include: + +.. list-table:: + + * - :class:`Linux_ARPHRD ` + - Linux ARP Hardware Types [*]_ + +ARP Hardware Types +================== + +.. module:: pcapkit.vendor.linux.arphrd + +This module contains the vendor crawler for **Linux ARP Hardware Types**, +which is automatically generating :class:`pcapkit.const.linux.arphrd.ARPHRD`. + +.. note:: + + This crawler does not crawl. Its source is the Linux kernel header + ````, which assigns ``ARPHRD_*`` values in C source + under the kernel's own versioning, not an IANA or IETF table that + :mod:`pcapkit.vendor` could scrape. The data is maintained by hand in + the ``DATA`` mapping of :mod:`pcapkit.vendor.linux.arphrd`, and the + class defines no ``LINK``. + +.. autoclass:: pcapkit.vendor.linux.arphrd.ARPHRD + :members: FLAG + :show-inheritance: + +.. rubric:: Footnotes + +.. [*] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/if_arp.h