Skip to content

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

Merged
JarryShaw merged 1 commit into
mainfrom
fix/2498-arphrd-vendor-doc
Oct 31, 2026
Merged

docs(vendor): add documentation page for Linux ARPHRD crawler#2505
JarryShaw merged 1 commit into
mainfrom
fix/2498-arphrd-vendor-doc

Conversation

@JarryShaw

@JarryShaw JarryShaw commented Oct 31, 2026

Copy link
Copy Markdown
Owner

Closes #2498

Add documentation page for the ARPHRD vendor crawler under Link Layer in the vendor crawlers documentation. The page follows the pattern established by similar data-attribute crawlers like ipx.rst, including:

  • Clear note explaining that this crawler doesn't scrape but uses hand-maintained DATA mapping from the Linux kernel header <linux/if_arp.h>
  • Documentation of the ARPHRD class and its FLAG member
  • Link to the source kernel header as a footnote

@JarryShaw
docs(vendor): add documentation page for Linux ARPHRD crawler
a97346b 
- Add docs/source/pcapkit/vendor/linux.rst documenting the ARPHRD vendor crawler
  for Linux ARP hardware types from <linux/if_arp.h>
- 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
@JarryShaw JarryShaw added chore Maintenance work: tooling, repo hygiene, no library behaviour change review: pending No verdict for the current head - never reviewed, or the head moved since the last one labels Oct 31, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 31, 2026
@JarryShaw JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet review: good-to-go Cross-review at the current head says ready; CI state is separate and removed review: pending No verdict for the current head - never reviewed, or the head moved since the last one review: running A cross-review is in flight against the current head - no verdict yet labels Oct 31, 2026
@JarryShaw

JarryShaw commented Oct 31, 2026

Copy link
Copy Markdown
Owner Author

Cross-review (Sonnet) at a97346bbb: GOOD TO GO. Docs-only (2 files, 40 insertions), matches ipx.rst's structure exactly (module block, 'does not crawl' note, autoclass, footnotes), correctly indexed alphabetically under Link Layer. Every claim in the page checked against the real source (DATA/FLAG exist, no LINK, xref resolves). No conflict markers. tests/project clean (2132 tests, 10552 subtests). Ready for merge -- your call.

@JarryShaw
JarryShaw merged commit d66df71 into main Oct 31, 2026
40 checks passed
@JarryShaw
JarryShaw deleted the fix/2498-arphrd-vendor-doc branch October 31, 2026 20:59
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 31, 2026
@JarryShaw JarryShaw removed chore Maintenance work: tooling, repo hygiene, no library behaviour change review: good-to-go Cross-review at the current head says ready; CI state is separate labels Oct 31, 2026
@JarryShaw JarryShaw mentioned this pull request Oct 31, 2026
Merged
2 of 5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

PyPCAPKit
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add a vendor doc page for the ARPHRD crawler

1 participant

@JarryShaw