Skip to content

docs(protocols): second pass over link and transport (#1103) - #1784

Merged
JarryShaw merged 2 commits into
mainfrom
docs/1103-linktrans-r2
Oct 15, 2026
Merged

JarryShaw merged 2 commits into
mainfrom
docs/1103-linktrans-r2

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 round 2: the files phase 1 left unread, plus the phase-1 reviewers' follow-ups.

Reads the link and transport data models and the tcp.rst and sctp.rst
autodoc lists left unread by the first pass, and takes the review items.

  • data l2tp: Flags carries no version; L2TP.flags points at version
  • data tcp: hdr_len is the Data Offset in octets; TSval/TSecr named;
    POC-SP is the connection service profile option; MP_CAPABLE H means
    HMAC-SHA1 in version 0 and HMAC-SHA256 in version 1 (schema, make too)
  • data udp: "header includes" reworded
  • vlan: the header table printed vlan.* keys; info uses c_tag/s_tag
  • tcp: the TCP.read seeds _flags with a no-op cast, so a flagless segment leaves it a plain int #616 bullet names connection rather than flags; the _MPTCP
    Option.registry reference now resolves to EnumSchema.registry

ast.dump is identical with docstrings blanked; tests/project and the
57 related test files pass.

Refs #1103

Reads the link and transport data models and the tcp.rst and sctp.rst
autodoc lists left unread by the first pass, and takes the review items.

- data l2tp: Flags carries no version; L2TP.flags points at version
- data tcp: hdr_len is the Data Offset in octets; TSval/TSecr named;
  POC-SP is the connection service profile option; MP_CAPABLE H means
  HMAC-SHA1 in version 0 and HMAC-SHA256 in version 1 (schema, make too)
- data udp: "header includes" reworded
- vlan: the header table printed vlan.* keys; info uses c_tag/s_tag
- tcp: the #616 bullet names connection rather than flags; the _MPTCP
  Option.registry reference now resolves to EnumSchema.registry

ast.dump is identical with docstrings blanked; tests/project and the
57 related test files 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 b7540689e. Sonnet review and re-check (author: Opus). The first review passed. A fix round reverted the register Raises: rewording in link.py, transport.py and sctp.py to Protocol, per #1016 and #1028. The AST guard is identical against the base, tests/project passes, and every added directive says 1.5.0.

@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 60beed4 into main Oct 15, 2026
7 checks passed
@JarryShaw
JarryShaw deleted the docs/1103-linktrans-r2 branch October 15, 2026 18:54
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 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