Skip to content

chore: drop stale build leftovers and move the examples' READMEs to Markdown (#1773) - #1780

Merged
JarryShaw merged 1 commit into
mainfrom
chore/1773-build-leftovers
Oct 15, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
chore/1773-build-leftovers

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

Please follow the guide below

What is the purpose of your pull request?

Tick the commit type your subject line carries.

  • fix — corrects a defect
  • feat — adds a feature
  • perf — changes performance, not behaviour
  • refactor — changes neither behaviour nor performance
  • test — tests only
  • docs — documentation only
  • ci — workflows or build tooling
  • release — bumps the version or rolls up a distribution
  • chore — anything else

Summary

Stale build leftovers found by the #1103 sweep.

  • setup.py: drops the bdist_wheel override, which converted dist_dir/pcapkit after the wheel was written. build_py and install already convert. Fixes the f2format and poseur failure messages.
  • Makefile: profile delegates to examples/legacy_smoke. MANIFEST.in: drops prune test (no such directory) and adds recursive-include examples *.md. global-include *.rst now matches nothing shipped and is left for a later pass.
  • examples/{benchmark,legacy_smoke}/README.rst move to README.md, carrying docs(repo): correct stale claims and drop timed context in repo files (#1103) #1768's two edits. .gitignore, benchmark.py, the tier test and the documentation conventions page follow.
  • Checks: sdist listings differ only by the renames and the new test; wheels match. test_build_leftovers_1773.py fails with each fix reverted. tests/project: 941 passed, 1 skipped.

Closes #1773

…arkdown (#1773)

- setup.py: drop the bdist_wheel override, which converted dist_dir/pcapkit
  after the wheel was written; build_py and install already convert the tree
  bdist_wheel archives. test_setup.py loses its now-dead bdist_wheel fake.
- setup.py: the f2format and poseur failures name f-string and
  positional-only parameter backports, not assignment expressions.
- Makefile: `profile` delegates to examples/legacy_smoke (moved in 78e28d8).
- MANIFEST.in: drop `prune test` (no such directory); add
  `recursive-include examples *.md`. `global-include *.rst` now matches
  nothing shipped (sdist identical without it); left for a later pass.
- examples/{benchmark,legacy_smoke}/README.rst -> README.md; .gitignore,
  benchmark.py, the tier test and the documentation conventions page follow.

Sdist listings differ only by the renames and the new test; wheels match.
test_build_leftovers_1773.py fails with each fix reverted; tests/project green.

Closes #1773
@JarryShaw JarryShaw added the chore Maintenance work: tooling, repo hygiene, no library behaviour change label Oct 15, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verdict: GOOD TO GO at 3f07b5ef3. A Sonnet cross-review (author: Opus), after a prose fix round and a rebase onto main. #1768's two edits to examples/benchmark/README.rst are carried into the .md. Sdists differ only by the renames and wheels match. The new test fails with each fix reverted. tests/project passed 941.

@JarryShaw JarryShaw added the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 15, 2026
@JarryShaw
JarryShaw merged commit d905712 into main Oct 15, 2026
56 checks passed
@JarryShaw
JarryShaw deleted the chore/1773-build-leftovers branch October 15, 2026 22:14
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 15, 2026
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 2026
JarryShaw added a commit that referenced this pull request Oct 15, 2026
…1803)

Entries:
- add #1791 (breaking: pack() leaves its instance unchanged), #1778
  (Protocol in protocol.__all__), #1781 (PortEnumField miss with a
  nameless proto), #1779 (vendor.ipx _path), #1780 (examples READMEs to
  Markdown, build leftovers) and #1790 (36 ambiguous cross-references)
- fold #1776 into the RPL 0x23 entry and #1381 into the dump-schema one

Accuracy:
- the benchmark and legacy_smoke READMEs are README.md since #1780
- EngineBase stays out of __all__, as #1016 settled
- the #575 peek calls get() only once the value resolves
- the #647 and #764 entries point at #775/#860, under which nothing mints
- the #861 entry names #869 and #874 for the EnumRegistry move

Figures:
- preamble: 685 citations, #340 to #1791
- process.rst pin: 298 entries; CHANGELOG.md regenerated

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

Labels

chore Maintenance work: tooling, repo hygiene, no library behaviour change

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

chore: stale setup.py, Makefile and MANIFEST.in leftovers, and two reST READMEs outside docs/

1 participant