Repository navigation
docs(foundation): second pass over engines, toolkit and reassembly (#1103) - #1777
Merged
Merged
Conversation
…1103) Directives: - drop the versionremoved notes for FALLBACK_LIMIT, IPV6_TCP_WARNED_LIMIT and DETECT_CACHE_SIZE, which existed only in the betas (#1726); - Engine: 1.4.x registered under EngineBase.name, not the class name; IP: an overlapping fragment still overwrites, as RFC 791 asks; pyshark: name the filter-name fallback; make_dumper: networks dump as strings. Accuracy: - pcapkit/__init__.py names nine components, adding pcapkit.vendor; - tcp_traceflow adapters return flow-tracing data, not reassembly data, and the pcap/pcapng adapters return a record, not a tuple; - IPv6._rectify_header: every adapter already excludes the Fragment header; - register_protocol: #514 kept the class-name key; StreamEOFError also comes from the PCAP and PCAP-NG readers; "write plist" comments. Render: roles inside bold in pcap_ct, a duplicate BufferID autodata, two misindented Returns sections. Timed wording in five docstrings. AST guard: 25 files identical; tests/project and 127 files citing an edited path pass. Refs #1103
JarryShaw
added
the
docs
Owner
Author
|
Verdict: GOOD TO GO at |
JarryShaw
added
the
review: good-to-go
JarryShaw
removed
the
review: good-to-go
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
1 participant
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.
Please follow the guide below
You will be asked some questions, please read them carefully and answer honestly
Put an
xinto all the boxes [ ] relevant to your pull request (like that [x])Use Preview tab to see how your pull request will actually look like
Searched for similar pull requests
Followed the coding style (
make pylint,make mypy,make isort)make testpasses, and a test case covers the change. Narrow runs only, listed below.Added a changelog entry under
docs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible: N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
Tick the commit type your subject line carries.
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingrelease— bumps the version or rolls up a distributionchore— anything elseSummary
#1103 round 2 for
pcapkit.foundation,toolkit,reassembly,traceflow,dumpkitandutilities: the files phase 1 (#1763) left unread.versionremovednotes forFALLBACK_LIMIT,IPV6_TCP_WARNED_LIMITandDETECT_CACHE_SIZE, which existed only in the betas (feat(utilities): one config module for the tunable limits (PCAPKIT_* environment variables), and one home per duplicated protocol constant #1726). Corrects four existing 1.5.0 directives (Engine naming, IP overlap, pyshark fallback,make_dumper) againstv1.4.1.post2.pcapkit/__init__.pynames nine components; adapterReturns:sections;StreamEOFErrorsources;IPv6._rectify_header.BufferIDautodata, two misindentedReturns:sections. Removes timed wording from five docstrings..pyfiles.tests/project: 930 passed. 130 files citing an edited path: 1420 passed.Refs #1103