Skip to content

docs(protocols): second whole-repo pass over internet (#1103) - #1798

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103b-internet
Oct 15, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1103b-internet

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

Please follow the guide below

What is the purpose of your pull request?

Tick the commit type your subject line carries.

  • fix — corrects a defect
  • feat — adds a feature
  • perf — changes performance, not behaviour
  • refactor — changes neither behaviour nor performance
  • test — tests only
  • docs — documentation only
  • ci — workflows or build tooling
  • release — bumps the version or rolls up a distribution
  • chore — anything else

Summary

#1103 second whole-repo pass, internet slice.

1.5.0 directives:

  • versionchanged on the 19 HIP and 8 IPv4 data models that gained a
    required field, each citing the issue the field came from.
  • hopopt, ipv6_opts and ipv4 pages gain the QuickStartRequestOption and
    QuickStartReportOption data models, so their directives render.

1.1.0-1.4.1 backfill:

  • versionremoved:: 1.1.0 for the MH BindRefreshAdviceOption and
    BindingAuthorizationDataOption names, data and schema.
  • versionchanged:: 1.3.0 on Internet.register (protocol argument).
  • versionchanged:: 1.3.4 on IPv6_Route: length is in octets (ipv6 packet with option decodes error #218).

Accuracy:

  • RFC 6275 citations for Pad1, PadN and MH padding name 6.2.2, 6.2.3
    and 6.1.1, not 6.2.5 (Alternate Care-of Address).
  • generic_ext_codes no longer cites the shim6 placeholder path.

Rendering: PadOption length references point at the Option fields
that define them; _SMFDPDOption is documented; IPv6_Ext.next no
longer points at a type-checking-only class.

AST identical on all 12 .py files; tests/project and 95 related pass.

Refs #1103

1.5.0 directives:
- versionchanged on the 19 HIP and 8 IPv4 data models that gained a
  required field, each citing the issue the field came from.
- hopopt, ipv6_opts and ipv4 pages gain the QuickStartRequestOption and
  QuickStartReportOption data models, so their directives render.

1.1.0-1.4.1 backfill:
- versionremoved:: 1.1.0 for the MH BindRefreshAdviceOption and
  BindingAuthorizationDataOption names, data and schema.
- versionchanged:: 1.3.0 on Internet.register (protocol argument).
- versionchanged:: 1.3.4 on IPv6_Route: length is in octets (#218).

Accuracy:
- RFC 6275 citations for Pad1, PadN and MH padding name 6.2.2, 6.2.3
  and 6.1.1, not 6.2.5 (Alternate Care-of Address).
- __generic_ext_codes__ no longer cites the shim6 placeholder path.

Rendering: PadOption length references point at the Option fields
that define them; _SMFDPDOption is documented; IPv6_Ext.next no
longer points at a type-checking-only class.

AST identical on all 12 .py files; tests/project and 95 related pass.

Refs #1103
@JarryShaw JarryShaw added the docs Pull requests that change documentation only (docs: subject prefix) label Oct 15, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verdict: GOOD TO GO at d744d7275. A Sonnet cross-review (author: Opus) found no blocking findings. Scope stays inside the slice, the AST guard is identical against main, and every directive was checked against the release tags. The merged build of all nine second-pass heads has 18 warnings, the same as main. tests/project: 950 passed, 1 skipped, 3670 subtests passed.

@JarryShaw JarryShaw added the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 2026
@JarryShaw
JarryShaw merged commit 417537b into main Oct 15, 2026
13 checks passed
@JarryShaw
JarryShaw deleted the docs/1103b-internet branch October 15, 2026 23:39
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 2026
@JarryShaw JarryShaw moved this to Done in PyPCAPKit Oct 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Pull requests that change documentation only (docs: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant