Skip to content

docs(vendor): add documentation page for Linux ARPHRD crawler #2505

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
JarryShaw merged 1 commit into from
Oct 31, 2026
+40 −0
Merged

docs(vendor): add documentation page for Linux ARPHRD crawler #2505

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions docs/source/pcapkit/vendor/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Link Layer

arp
l2tp
linux
vlan

Internet Layer
Expand Down
39 changes: 39 additions & 0 deletions docs/source/pcapkit/vendor/linux.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <pcapkit.vendor.linux.arphrd.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
``<linux/if_arp.h>``, 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
Loading