Skip to content

hopopt.py:456 cites RFC 8200 §4.3 for a sentence that lives in §4.2 #530

Description

@JarryShaw

Summary

pcapkit/protocols/internet/hopopt.py:456 cites RFC 8200 §4.3 for a sentence that lives in §4.2.

Independently flagged by two separate agents working on unrelated changes, which is why it is worth a ticket rather than a passing note.

The detail

The docstring quotes the Option Data Length definition — "the length of the Option Data field of this option, in octets" — which appears in §4.2 (Options), the section defining the TLV format shared by both extension headers.

§4.3 is not wrong about HOPOPT itself, which is what makes this milder than the equivalent in ipv6_opts.py: §4.3 is the Hop-by-Hop Options Header section, so it is the correct citation for the header this class implements. The imprecision is narrower — the quoted sentence comes from §4.2, so a reader following the citation to §4.3 will not find the text attributed to it. §4.3's only length field is Hdr Ext Len, measured in 8-octet units, which is a different quantity entirely.

Precedent

PR #528 fixed exactly this in pcapkit/protocols/internet/ipv6_opts.py, and deliberately departed from what its issue asked for: #517 requested §4.6, but the quoted sentence is §4.2's, so it cited §4.2 for the quote and named §4.6 as the header the class implements. The same two-part treatment applies here, with §4.3 in place of §4.6.

Suggested fix

Cite §4.2 for the length-field sentence and keep §4.3 as the header reference — one docstring edit. A docstring change cannot fail a test, so the honest framing for any accompanying test is that it pins a previously unpinned citation rather than reproducing a failure.

Notes

Not folded into #528 because hopopt.py was outside that worker's owned file set, and a change touching a file another stream may hold is how two agents silently clobber each other. Reported rather than fixed, deliberately.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugIssues reporting a defect (set by the bug report template; a default, not an assessment)

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions