Skip to content

docs(vendor,const): MPTCPOption's docstring cites RFC 6824, which RFC 8684 obsoletes #2330

Closed

Description

@JarryShaw

Is your feature request related to a problem? Please describe.
The class docstring of the MPTCPOption crawler in pcapkit/vendor/tcp/mp_tcp_option.py is Multipath TCP options [:rfc:\6824`], and the regenerated pcapkit.const.tcp.mp_tcp_option.MPTCPOptioncarries it as[MPTCPOption] Multipath TCP options [:rfc:`6824`]. The registry it crawls, IANA's "MPTCP Option Subtypes", cites RFC 8684. Its note says the registry is for MPTCP v1, which obsoletes the experimental v0, and points to RFC 6824 only for the v0 subtypes. Every member comment in the generated enum already cites 8684#section-..., and so does TCPOption's MPTCP` entry.

Describe the solution you'd like
Cite :rfc:\8684`` in the crawler's docstring and regenerate the const module, so the two stay byte-identical.

Describe alternatives you've considered
Citing both RFCs. Not needed: the pcapkit/protocols/transport/tcp.py docstrings that cite 6824 do so on purpose, for the legacy v0 layouts they still parse, and they are not affected.

Additional context
Source: https://www.iana.org/assignments/tcp-parameters/tcp-parameters.xml, registry "MPTCP Option Subtypes".

Metadata

Metadata

Assignees

No one assigned

    Labels

    constRegenerated IANA or vendor constant tables; members keep their numeric valuesdocsPull requests that change documentation only (docs: subject prefix)

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions