Repository navigation
Untrack the generated captures committed by mistake in #350 - #380
Merged
Merged
Conversation
#350 renamed examples/sample to examples/captures and rewrote the .gitignore rules to match, but the rename commit also ran `git add -A examples` while seven generated captures still sat at the old path. No rule covered that path any more, so they were committed: 190 KB of binaries that are rebuilt by examples/generators/ on demand. One of them matters more than tidiness. dhcp_big_endian.pcapng is fetched from Wireshark's test/captures and is GPL-2.0-or-later; #340 said in as many words that nothing downloaded is redistributed because the directory is gitignored. That stopped being true, and this restores it. .gitignore now names examples/sample/ as well, since three worktrees and any older checkout still hold captures there and the same mistake would otherwise be one `git add -A` away. Dropped MANIFEST.in's now-redundant prune of the old path, and pointed two stale comments in the IPv6 extension tests at the directory that exists. CI selection: 318 passed, 103 subtests passed.
There was a problem hiding this comment.
🟢 Approval recommended
The diff is small and targeted, and the ignore/manifest/comment updates consistently support untracking generated captures without introducing functional code changes.
Pull request overview
Removes mistakenly tracked generated capture fixtures (including a GPL-sourced download) by restoring the intended “generate locally, don’t redistribute” workflow, while hardening ignores and updating stale test comments to the current captures directory name.
Changes:
- Add
.gitignorecoverage for the pre-renameexamples/sample/path to prevent accidental tracking in older checkouts/worktrees. - Remove redundant
MANIFEST.inpruning forexamples/sample/(withexamples/capturesremaining pruned). - Update two comments in
tests/protocols/internet/test_ipv6_extension_runtime.pyto referenceexamples/captures/instead ofexamples/sample/.
File summaries
| File | Description |
|---|---|
tests/protocols/internet/test_ipv6_extension_runtime.py |
Updates documentation/comments to point at the current captures directory. |
MANIFEST.in |
Removes a now-redundant prune entry for the old captures path. |
.gitignore |
Adds an ignore rule for examples/sample/ to prevent reintroducing tracked generated captures. |
Review details
- Files reviewed: 2/10 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
JarryShaw
added
ci
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.
My mistake, from #350. Small diff, but one part of it is a licensing matter rather than housekeeping.
What happened
#350 renamed
examples/sample/toexamples/captures/and rewrote the.gitignorerules to match. The rename commit then rangit add -A exampleswhile seven generated captures were still sitting at the old path — which by then no rule covered — so they were committed. 190 KB of binaries thatexamples/generators/rebuilds on demand:arp.pcap,dhcp_big_endian.pcapng,http.pcap,ipv4.pcap,ipv6.pcap,stream.pcap,tcp.pcapThe part that matters
dhcp_big_endian.pcapngis fetched from Wireshark'stest/capturesand is GPL-2.0-or-later. #340's description said in as many words that nothing downloaded is redistributed, because the directory is gitignored and each machine fetches its own copy. That stopped being true the moment #350 merged. This restores it.Changes
git rm --cachedon all seven. Nothing reads them: the tests reach fixtures throughtests/_support.sample_path(), which resolvesexamples/captures/..gitignorenow namesexamples/sample/as well. Three worktrees and any older checkout still hold captures at that path, so without a rule the same mistake is onegit add -Aaway.MANIFEST.in's now-redundantprune examples/sample—prune examples/capturesis the live one.tests/protocols/internet/test_ipv6_extension_runtime.pyat the directory that exists.Verification
CI-equivalent selection with the files gone: 318 passed, 103 subtests passed. Fixtures regenerate into
examples/captures/as before viamake samples.