Repository navigation
docs(protocols): repair the protocol pages and cut their restatement (#719) - #1044
Merged
Merged
Conversation
…719) - Fix header tables whose offsets or field names disagreed with the code: Ethernet, VLAN and OSPF octet/bit columns, the IPv4/IPv6 info-key prefix, the AH field prefix, and IHL's expansion. - NGAP: an unknown IE or procedure code resolves to a non-registering 'Unassigned' member, not 'Unassigned_<n>' on a self-extending enum. - Repair unresolved references (AH, PCAP Header, NGAP next-layer hook) and the mermaid click anchors for IPv4, IPv6, TCP, UDP and the four layer bases. - Tighten the L2TP, VLAN, C-Tag, S-Tag, IPv6-Ext, ESP and PCAP-NG prose, keeping the rationale; drop a duplicated index rule and timed wording. Sphinx -n warnings on these pages: 4 before, 1 after. tests/project passes.
Owner
Author
|
Cross-review verdict on One blocking item:
Confirmed: the octet and bit columns (Ethernet, VLAN, OSPF, by parse), the Non-blocking, outside this PR's files: |
) - l2tp.rst: HTTP._guess_version tests for an HTTP/1 request-line or status-line (_test_start_line) after the HTTP/2 preface and before any trial parse; the parenthetical now names both identification steps. - ipv6_opts.rst: the field table's prefix is now ``opts.``, the key IPv6-Opts nests under inside ``ipv6`` (alias 'IPv6-Opts' lstripped and lowered in IPv6._decode_next_layer); it read ``opt.``.
Owner
Author
|
Cross-review verdict on
The |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
make testpasses, and a test case covers the change (tests/project: 274 passed, 2 skipped)What is the purpose of your pull request?
docs— documentation onlyDescription
Part of #719 (does not close it): the
docs/source/pcapkit/protocols/autodoc pages, 17 of 46 touched; the other 29 had nothing to fix or cut.Unassignedmember (the page said a self-extendingUnassigned_<n>).Sphinx
-nwarnings for these pages, fresh build each side: 4 onmain, 1 after (the remainingAppTypereference is not in scope), none new.